Player Roles Mod Wiki › FAQ
Player Roles Mod FAQ
10 questions players actually ask, answered.
How do I get started with Player Roles Mod?
Open the roles.json file in your server's config directory and define your roles and their permissions there. Then use the mod's commands to assign roles to players, and reload the file whenever you make changes.
Where is the roles.json file located?
It lives in the config directory at the root of your server folder, specifically root/config/roles.json. Edit it there and reload it in-game to apply changes.
What is the everyone role and can I remove it?
everyone is the default role that every player automatically has, and it cannot be removed. All other roles act as overrides layered on top of everyone, so permissions granted there apply to all players.
How do I assign a role to a player?
Use the mod's role assignment command targeting the player and the role name defined in your roles.json. The player will then gain that role's permissions as an override on top of everyone.
How do roles override each other?
Roles other than everyone function as overrides, meaning they add or change permissions on top of the default everyone role. A player with multiple roles gets the combined effect of each role's override entries.
How do I restrict which commands a role can use?
In roles.json, add command entries under the role that specify a regular expression pattern to match commands and a strategy for how the mod should respond when that pattern is encountered. This lets you allow, deny, or otherwise handle matching commands.
What does the command strategy in roles.json actually do?
Each override entry pairs a regex pattern with a strategy that tells the mod how to respond when a player's command matches that pattern. The strategy determines whether the command is permitted, blocked, or handled another way.
How do I reload roles.json without restarting the server?
Use the mod's reload command to re-read roles.json at runtime. This lets you iterate on roles and permissions quickly without taking the server down.
Why aren't my role changes taking effect after editing roles.json?
You likely haven't reloaded the file yet, since edits to roles.json only apply after a reload. Run the reload command and confirm your JSON is valid, as malformed JSON will prevent changes from loading.
Does Player Roles Mod work alongside other permission mods or affect performance?
It's a lightweight permissions layer driven by a single JSON file, so it has minimal performance impact. Running it alongside another permissions mod can cause conflicting command handling, so pick one system for command permissions to avoid confusion.