I was really interested to see that there is not really a simple guide for users to setup their own LuckPerms plugin. This is mainly because the wiki contains useless information that you don't need which ends up making the plugin seem very over complex. I have noticed that the most common misconception with LuckPerms is that it's difficult and I can assure you after this guide your opinion will have changed.
You have multiple options setting up LuckPerms including an editor & in-game commands.
Through this guide I'm going to show you how to setup LuckPerms using fully in-game commands, I will firstly show the basics on how to create ranks, and organise them effectively I will also show how to integrate it with EssentialsChat to get a prefix & suffix.
INTRODUCTION
Firstly lets talk about downloading the plugin and loading it onto your server.
You will firstly need to download the latest version of the plugin and I suggest getting it from their website, ensuring you download the "Spigot/Bukkit" version.
You will then need to upload your .jar file onto your panel. Once it's fully uploaded you will need to reboot your server, once you have seen LuckPerms load successfully you can log into your server and start setting it up. You do not need to open the configuration file at this time unless you're looking to setup LuckPerms using a MySQL database.
If you're looking to setup a MySQL database you will need to open the config.yml and input the database details into the file, once done you will need to reboot your server once again.
BASIC SETUP SECTION ONE
Once you have logged into your server, you can run start by checking out the help menu for the plugin, it may look over complex but I'm going to help you filter out what's useful and what you can ignore to ensure you have a fully working LuckPerms setup for your server.
You can check out the help menu with the command "/lp help" and it will display a list of commands, I will now go over the commands that we will need when setting up the plugin.
Firstly, you will need to create all your ranks, for the purpose of the guide the rank names I'm going to use are: Owner, Admin, Helper & Donator.
You can of course use the same principles to create further ranks following the guide and using the examples to guide you.
So, to create your groups you will need to use the following commands.
You should also remember there will always be a "default" group that all members will be added to initially and this group may be referred to in other parts of the guide.
Once you have created your groups you can now run the command "/lp listgroups" to view your ranks and continue onto the next stage.
The next thing we want to do is order the groups, this uses the weight system. All you need to know is the higher the weight the "better" the rank. You can follow the examples below.
"lp group owner setweight 500"
"lp group admin setweight 400"
"lp group helper setweight 300"
"lp group donator setweight 200"
"lp group default setweight 100"
Once you have completed this you can now run the command "/lp listgroups" to view your ranks listed in the correct order from highest to lowest and can continue onto the next stage.
Once you have added a weight it's important to then give each rank a displayname, this is just to make things look more tidy when you use a scoreboard or other areas where you may display the rank name, you want to keep it simple and I usually just change the displayname to be the same as the rank name however using a capital to make it more tidy.
lp group owner setdisplayname "Owner"
lp group admin setdisplayname "Admin"
lp group helper setdisplayname "Helper"
lp group donator setdisplayname "Donator"
lp group default setdisplayname "Member"
Once you have set a displayname your general setup is mainly complete, you can now either setup the permissions in-game for each rank or you can continue by creating a prefix/suffix for chat, please note that this guide uses EssentialsChat and it may be different for other chat plugins.
When setting up a chat prefix the first thing to do is setup how you would like it to be displayed and you can do this through LuckPerms.
lp group owner meta setprefix "&8[&4&lOWNER&8] &4"
lp group owner meta setsuffix " &8[&c&lSTAFF&8]"
lp group admin meta setprefix "&8[&c&lADMIN&8] &c"
lp group admin meta setsuffix " &8[&c&lSTAFF&8]"
lp group helper meta setprefix "&8[&2&lHELPER&8] &2"
lp group helper meta setsuffix " &8[&c&lSTAFF&8]"
lp group donator meta setprefix "&8[&a&lDONATOR&8] &4"
lp group donator meta setsuffix " &8[&6&l$&8]"
lp group default meta setprefix "&8[&7Member&8] &7"
lp group default meta setsuffix " &8[&6✰&8]"
I will also note if you don't want to use a prefix or a suffix just leave that command out, if you only want the rank prefix simply ignore the suffix command and move onto the next step.
Now that you have setup how it will display you will need to navigate to the EssentialsChat configuration section in the Essentials config.yml.
Once you have found it you will need to ensure that your chat format has "{DISPLAYNAME}" is used as that's how you will display your prefix & suffix and username all in one placeholder.
Here is an example configuration that I would suggest using for newer users:
Once you have done that there are only a few more things to do to complete your LuckPerms setup, you can choose if you would like your higher ranks to inherit permissions from your lower ranks to save you time duplicating setting permissions.
For example if I would like my donator rank to have all the permissions from my default rank all I need to do is run one command: "lp group donator parent add default".
If I no longer want my donator rank to inherit permissions from my default rank I can simply undo the action with one command: "lp group donator parent remove default".
"lp group owner parent add admin"
"lp group admin parent add helper"
"lp group helper parent add default"
"lp group donator parent add default"
The higher rank always should inherit from the next lowest rank, if you don't want your lowest staff rank to have donator permissions then simply parent it to the default group as I have in the example above. If you have other staff ranks in between my examples just follow the structure and you will be fine.
Once you have added parents you're pretty much finished all you have to do now is add permissions using the command: "lp group default permission set essentials.spawn"
The example above gives the default group access to use the command /spawn.
Once you have setup all your permissions you can add and remove users from groups using the following commands.
"/lp user Lollipop56_ parent add owner"
"lp user Lollipop56_ parent remove owner"
You may also wish to add permissions directly to a user instead of to a whole group, you can use the commands below to achieve that goal.
GROUPS
"/lp group default permission set essentials.home"
"lp group default permission unset essentials.home"
You can also set temporary permissions.
"lp group default permission settemp essentials.sethome true 1d"
"lp group default permission unsettemp essentials.sethome"
USERS
"/lp user Lollipop56_ permission set essentials.home"
"lp user Lollipop56_ permission unset essentials.home"
You can also set temporary permissions.
"lp user Lollipop56_ permission settemp essentials.sethome true 1d"
"lp user Lollipop56_ permission unsettemp essentials.sethome"
You have now setup your basic LuckPerms, if you are looking to achieve something different then feel free to contact me and I can either assist you in your request or add it to the guide for other users.
This site uses cookies to help personalise content, tailor your experience and to keep you logged in if you register.
By continuing to use this site, you are consenting to our use of cookies.
