How to install & configure 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

1. Download the latest version for your platform (IE Bukkit / Bungee / SpongeForge) from https://luckperms.github.io/
2. Use an FTP Client or the File Manager to upload the LuckPerms jar to your server's plugins directory.
3. Start your server, wait for it to fully start, then stop it.
4. If you haven't already, create a MySQL database from within the panel:
5. Go to the File Manager and edit the config.yml file from plugins/LuckPerms/ and change the following settings:

• Change storage-method: h2 to storage-method: mysql
• Change address: localhost to the MySQL Host shown in the panel
• Change database: minecraft to whatever is under the Name section in the panel
• Change username and password to the respective values given in the panel

6. Start your server back up - LuckPerms should now be fully installed and configured to work with your database

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.

1. Firstly, install LuckPerms as shown at the top of this article, but leave PEx/GM installed.
2. In console type lp migration <plugin>, for example lp migration PermissionsEx. LuckPerms will notify you if it needs any more information to complete the move
3. 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 below!

Updated on: 04/03/2022