Knowledge Base
How to install and setup Luckperms
What is Luckperms, and why should I use it over PermissionsEx / GroupManager?
LuckPerms is an advanced, flexible, modern permissions plugin that allows you to configure exactly how you want your server to work. You should use it over PermissionsEx as PEx is currently unmaintained.
How to install LuckPerms
- Download the latest version for your platform (IE Bukkit / Bungee / SpongeForge) from https://luckperms.github.io/
- Use an FTP Client or the
File Manager
to upload the LuckPerms jar to your server’splugins
directory. - Start your server, wait for it to fully start, Luckperms is Successfully installed
How to set up a basic admin group and add yourself to it
- To create the group through console, type
lp creategroup admin
- To add yourself to the group you can use
lp user <yourname> parent add admin
- To add permissions to the group use
lp group admin permission set <permission>
Adding a prefix
Adding prefixes is slightly more complicated in LuckPerms. Firstly make sure you have a chatmanager such as EssentialsXChat, and you’ll also need vault. Next, each prefix has to have a weight. Essentially this decides which prefix is chosen if a user is in multiple groups, so for example it’s best to have owner at 100, admin at 90, moderator at 80, etc. Once you’ve decided that you can use the command lp group <name> meta addprefix <weight> <prefix>.
More information can be found on LuckPerms’ wiki.
How to import permissions from another plugin
Importing permissions from a plugin such as PermissionsEx is easy with LuckPerms.
- Firstly, install LuckPerms as shown at the top of this article, but leave PEx/GM installed.
- In console type
lp migration <plugin>
, for examplelp migration PermissionsEx
. LuckPerms will notify you if it needs any more information to complete the move - Enjoy your new permissions setup!
LuckPerms Wiki
It’s worth familiarising yourself with the LuckPerms wiki before using the plugin - you can find this at https://github.com/lucko/LuckPerms/wiki/home.
If you’re unsure feel free to checkout our video guide above!