How to Use LuckPerms Plugin – Introduction
On Minecraft servers, many players often join seeking thrills and adventures with friends. From battling in Bedwars minigame servers to building up a powerful Faction in a pvp server. Knowing the type of server, holding it together and ensuring players have access to the correct commands is important. To manage your players and permissions, as well as add groups, you can use the mighty LuckPerms plugin!
LuckPerms plugin is used to manage permissions and is a step above the rest, providing powerful tools to quickly and easily add permissions and groups. The plugin features the ability to edit groups and permissions using an editor or commands to offer the ultimate in customizability. Being a vital part of Minecraft servers, permissions should be one of the first things set up to protect your server.
You can follow us in this guide as we show you how to setup and use the LuckPerms plugin on your Minecraft server!
Getting Started with LuckPerms Plugin
Before Installing LuckPerms to Your Server
Before you can begin installing LuckPerms to your server, it’s essential to ensure your server is compatible with LuckPerms. LuckPerms works with multiple server types including Bukkit/Spigot, Sponge, Fabric, Forge, and BungeeCord server networks. You can download the different versions of LuckPerms on their website.
If your server isn’t on a compatible server type, you can use the “SWITCH GAME” feature on the left side of your Minecraft server webinterface to change it. Then, when you’re ready to install LuckPerms, you can check out each server type’s installation guide below!
How to Install LuckPerms on a Minecraft Server
Installing LuckPerms on a Minecraft Bukkit/Spigot Server
-
- Firstly, download the latest plugin version of LuckPerms.
- Then, go to your Minecraft server and press “Stop” to stop it.
- Once your server is offline, on the left side under “Tools”, press “File Browser”. This will open your Minecraft server files.
- Within your server files, enter the folders “minecraftbukkit” ➜ “plugins”. In that folder, press the “Upload file” option.
-
- Afterward, locate the LuckPerms bukkit jar file, select it, and click “Open”. After a moment, that plugin will be uploaded.
- Finally, restart your server and LuckPerms will now be installed!
Adding LuckPerms to a Minecraft Forge/Fabric Server
-
- To begin, download the Forge or Fabric version of LuckPerms depending on your server type. In our example, we will be downloading LuckPerms for Fabric.
-
- Head to your Minecraft server webinterface and stop your server.
- Next, on the left under “Tools”, select “File Browser” to access your server files.
- In your server files, go to the location “minecraftotherpacks” ➜ “mods”.
-
- After going to that location, press “Upload file”. Then, find that LuckPerms file, select it, and press “Open” to begin the upload process.
- Finally, after just a few seconds LuckPerms will be installed. To finish the installation, start your Minecraft server to load LuckPerms and generate its configuration files.
How to Install LuckPerms on a BungeeCord Server
-
- To start, ensure you have the BungeeCord version of LuckPerms downloaded.
- After, proceed to your Minecraft server panel and stop the server.
- Next, on the left of your panel press “File Browser” under “Tools”.
- Then, head to the location “BungeeCord” ➜ “plugins”.
-
- In that location, press “Upload file” to upload the plugin.
- Inside your files, search for and select the LuckPerms bungee file. Afterward, press “Open” to upload that file.
- Lastly, after the file has finished uploading, start your Minecraft server. LuckPerms will then load on your BungeeCord server and Minecraft network!
How to Setup LuckPerms On Your Server
Finding Permission Nodes to Add to Your Player Groups
Prior to setting up LuckPerms, it’s recommended that you develop a list of permissions and groups to add to your server. The permissions you’ll need to add will depend on the version of LuckPerms you’re using.
In our below example, we will be showing a plugin example of LuckPerms groups and permissions. These permissions were gathered from a highly recommended plugin called EssentialsX, which you can find here! EssentialsX includes a detailed wiki of all of the permissions and groups that can be used for this plugin.
Default
- Essentials.spawn
- Essentials.back
- Essentials.home
- Essentials.sethome
- Essentials.sethome
- Essentials.kit
- Essentials.kits.default
- Essentials.msg
- Essentials.signs.use.warp
- Essentials.signs.use.buy
- Essentials.signs.use.sell
- Essentials.balance
VIP
- Essentials.nick
- Essentials.hat
- Essentials.pay
Helper
- Essentials.mute
- Essentials.kick
- Essentials.fly
- Essentials.vanish
Admin
For admins, you can add the star permission or the main “all commands” permission to give them access to all commands and permissions. We recommend only providing full permissions and command access to your most trusted friends and family. Now that you have an idea of the groups and permissions you can create, you can begin creating them using the guides below!
Setting up LuckPerms Plugin with Web Editor
When it comes to setting up LuckPerms, there is a simple yet effective method you can use to quickly add groups and set permissions. This can be done by using the LuckPerms web editor, built directly into the plugin. To access your plugin’s web editor, you can follow these steps:
-
- With LuckPerms installed, go to the “Live Server Console” of your server.
-
- After, in the console type the command “lp editor”. Upon issuing that command with the “Enter”-key, you’ll be provided with an editor link.
-
- Next, copy and paste that link into your web browser. You will be taken to a LuckPerms web editor site where you can set up tracks, groups, and permissions, and assign users to groups.
- Now that you’re in the editor, you’re ready to explore all of its features. Below, we’ll show you how to set up tracks, groups, and permissions, and assign users in the web editor!
Creating Groups
-
- To create a new group, begin by pressing the + sign next to “GROUPS”. This will open a “Create a group” menu where you can set up a new group.
- Within this menu, add the following:
- Group name – The name assigned to the group in your LuckPerms database.
- Display name – The name of the group displayed on your Minecraft server.
- Parent – Determines if this new group inherits permissions from another group.
- Weight – This determines a group’s set priority for permissions, prefixes, and contexts. A higher weight will provide a group with a higher priority.
- Prefix – Sets the prefix for the newly created group.
- Suffix – Adds a suffix to the newly created LuckPerms group.
- Afterward, press the “Add group” option at the bottom to create the group.
- After you have made changes to your groups using the editor, press “Apply” at the top right of the site to save those groups.
Adding Permissions
-
- Once a group is made, on the left, you can select that group to edit it and add permissions.
-
- Next, at the bottom of each group you will see an “Add permissions” section. Here, you can copy and paste permissions from plugins into this field to begin adding permissions. This is an example of adding permissions from the EssentialsX plugin.
- Once those permissions have been set in that field, to the right you can now customize those permissions with the following options:
- Value | true or false – Determines if that group can or cannot use those permissions and commands. If those permissions are set to false, that will disable those permissions for that group.
- Expiry – Sets if/when those permissions will expire. You can keep this field empty to ensure those permissions never expire.
- Contexts – These options allow you to set custom limits to your permissions, such as the permission only working in a certain world, server, or while you’re in a specific gamemode. For example, setting a permission with the context “server” and “lobby” would make that permission only work on the “lobby” server of a BungeeCord server network.
- After setting those adjustments, lastly press the “+ Add” option next to those permissions. You have now successfully set permissions to your LuckPerms groups!
- Once permissions have been set, press “Apply” at the top right to save those changes to your Minecraft server.
Making a Track
Like many permissions plugins, LuckPerms supports tracks. Tracks may be better known as “ladders” or “promotion routes” and they act as a player to easily promote and demote users. For example, you could create a promotion route named “admins” where default ➜ staff ➜ admin ➜ co-owner. This example would ensure you can quickly promote a user to a staff group with the command “lp user promote admins”. To create your own LuckPerms track:
-
- Next to “TRACKS”, press the + sign to create a new track.
- When creating a new track, you’ll need to set a name and then pick the order of the track based on your currently created groups. In our example, we have set the name “admins” and selected the route “default” ➜ “admin”.
- Lastly, press the “+ Add Track” option to create that track for your Minecraft server!
- After tracks have been added, click “Apply” at the top-right of the site to save those changes to your Minecraft server and LuckPerms plugin.
Assigning Users Groups and Permissions
-
- First, click the “USERS” section of the LuckPerms editor to view your server players. This will only display users that have joined your Minecraft server before.
- Once you have found the correct user to edit, click on that user. You can now edit that user including adding parent groups, permissions, and more.
- To set a group for a user, press the + option next to “Parent groups” and select those groups. You can select multiple groups for a user.
- Next, you can set and add custom permissions to a user below just like you would a LuckPerms group.
- Finally, after those changes have been made you can press “Apply” at the top-right. This will apply that user’s new groups and permissions to that player on the server!
Using Commands to Add Groups and Permissions
Creating Groups
A group can be created in LuckPerms by using the command /lp creategroup [weight] [displayname]. Upon entering that command, that group will be added to your server.
After creation, you can also add a parent to the group and prefixes/suffixes using these commands:
- /lp group <group> parent add <parent> – Adds a parent to that group for inheritance.
- /lp group <group> meta addprefix <priority> “<prefix>” – Sets a prefix for that group.
- /lp group <group> meta addsuffix <priority> “<suffix>” – Sets a suffix for that group.
Once the group has been created, you’re now ready to add permissions to that group.
Adding Permissions
To set permissions to your groups, you’ll need to use the command /lp group permission set <true/false> [context]. For example, we will be adding the permission essentials.spawn to the group named “tutorial”.
Repeat this for every permission you’d like to add. Afterward, your groups will be set up with permissions and ready for use!
Assigning Users Groups and Permissions
Finally, to set a user’s group and permissions in LuckPerms you can use these two commands:
- /lp user <user> group set <group>
- /lp user <user> permission set <permission> <true/false>
This is an example of using those commands to assign a user to the group “tutorial” with the permission essentials.fly.
Contexts with Permissions in LuckPerms Plugin
In LuckPerms, permissions can be assigned contexts to work in very specific ways. This includes only working in a set world or server. Below, you can find examples of how to assign these contexts for per-world permissions and per-server permissions.
Per World Permissions
In this example, players will only be able to fly in “The End” world and can only set homes in the overworld.
Per Server Permissions
For this example, players on the BungeeCord server network will only be able to fly in the “lobby” server and they can only set homes in the “survival” server.
Editing the Configuration Files Directly
Bukkit/Spigot Minecraft Servers
- Access your Minecraft server control panel and stop your server.
- After, go into your “File Browser” to “minecraftbukkit” ➜ “plugins” ➜ “LuckPerms”.
- Within your LuckPerms plugins folder, you’ll be able to edit the “config.yml” file and its additional files.
Forge/Fabric Minecraft Servers
- Jump back to your Minecraft server panel and stop your server.
- Then, go to your “File Browser” once more.
- Once there, go to the location “minecraftotherpacks” ➜ “config” ➜ “luckperms”.
- Afterward, you can edit the “luckperms.conf” and other files in that folder.
BungeeCord Minecraft Servers
- Go to your BungeeCord server webinterface and stop your server.
- Next, access your “File Browser” and go to “bungeecord” ➜ “plugins” ➜ “LuckPerms”.
- Inside that folder, you can now edit the “config.yml” file to customize LuckPerms!
Experience LuckPerms Plugin on Your Minecraft Servers
Now that you know how to set up LuckPerms, you’re ready to take your server to the next level. This includes having different groups, each with its own unique permissions, prefixes, and more for players to see. With groups, players will be able to more easily distinguish each other and enjoy the fun of your server while trying to get to higher ranks. Set and protected with custom groups and permissions in the LuckPerms plugin, your Minecraft server will be ready for the ultimate adventures ahead!
Rent your own Minecraft server!