RUST uMod (Oxide) permissions guide
This guide is designed for the RUST uMod (Oxide) permissions system and will walk through how to setup uMod permissions. The uMod framework is a popular modding platform that allows RUST server owners to install and manage custom RUST server plugins. After installing plugins to a RUST server, additional configuration and permissions management can be required.
By the end of this uMod permission guide, it will have covered the basic information needed to set up uMod permissions, including:
- Managing uMod permissions for a group
- Creating and managing custom permission groups
- Managing uMod permissions for a single-player
Prerequisites needed to manage uMod (Oxide) permissions
- Admin access to an existing RUST server
- Updated and installed uMod on the server
- Updated and installed uMod plugins on the server
Some ways that permissions are useful/helpful
- Allowing server owners to assign moderators select abilities
- Creating special groups, like VIPs, and assigning select abilities
- Granting and revoking select permissions for specific players
- Creating server white lists for players
What are RUST uMod (Oxide) permissions
Oxide permissions give server admins the ability to allow (grant) or remove (revoke) special abilities to the staff and players of their modded RUST server. The extent of permissions available is solely dependent on the specific plugins installed on the server. For more information about installing a plugin, please see this article on installing a uMod plugin to a RUST server.
Permissions are made available through uMod itself or via uMod plugins that are installed on the RUST server. Plugin authors may provide permissions to give users and groups different ways to interact with their plugins.
For example, a plugin may grant admins the ability to set values for gather rates but only allow players to query those values. In this situation, certain abilities must be locked to a specific group (or single user) and not made available to all players.
When setting permissions for a particular plugin, follow the plugin author’s setup instructions found on the plugin’s download page, and/or refer to the installing a plugin guide for extra help.
Managing uMod permissions for groups
What are the permission groups?
Permission groups are a method by which uMod is able to categorize players and assign permissions to multiple users at once. Once uMod has been installed and initialized on the server, it automatically provides two groups by default.
- admin
- default
Upon joining the server, automatically, admins will be added to the admin group, while all other players are added to the ‘default’ group. Players may belong to more than one group, and server admins may create custom groups to add players.
Groups are a fast and easy way to grant a player a collection of permissions and abilities simultaneously. Likewise, removing a player from a group revokes all of their permissions from that group.
Be aware that if a player is part of multiple groups, the permissions will overlap. Permissions that are granted or revoked at an individual level are superseded by group permissions.
This section refers to a fictitious permission coolplugin.use to illustrate command examples.
Show all uMod groups
To show all uMod groups currently available, use the following command:
oxide.show groups
Will display something similar to the following:
Groups: default, admin
See permissions assigned to a group
To see all permissions assigned to a specific group, use the following command:
oxide.show perms ‘group_name’
On success, it will display:
Permissions: oxide.plugins, oxide.load, oxide.reload, oxide.unload, oxide.grant, oxide.group, oxide.revoke, oxide.show, oxide.usergroup
See all players and permissions assigned to a group
To see all players and permissions that are currently assigned to a specific group, use the following command:
oxide.show group admin
On success, it will display:
Group 'admin' players:
<STEAM64_ID> ('Player Name')
Group 'admin' permissions:
whitelist.allowAdd a player to a group
To add a player to a group:
oxide.usergroup add <player_name or STEAM64_ID> group_name
On success, it will display:
Player 'PlayerName (steam_64_bit_id)' added to group: 'group_name'
Remove a player from a group
To remove a player from a group, use the following command:
oxide.usergroup remove <player_name or STEAM64_ID> group_name
On success, it will display:
Player 'PlayerName (steam_64_bit_id)' removed from group: 'group_name'
Grant permission to a group
Granting a permission to a group will make this permission available to all players added to the group. To grant the group ‘admin’ the permission ‘coolplugin.use’, use the following command:
oxide.grant group admin coolplugin.use
On success, it will display:
Group 'admin' granted permission 'coolplugin.use'
Revoke a permission from a group
Similar to granting a group permission, revoking a permission from a group will remove this permission for all players added to that group. Use the following command:
oxide.revoke group admin coolplugin.use
On success, it will display:
Group 'admin' revoked permission 'coolplugin.use'
Create a new group
To create a custom group, use the following command:
oxide.group add supporters
On success, it will display:
Group 'supporters' created
Remove a group
Be wary of deleting the default and/or admin groups as this may have adverse or unexpected effects on the permission state of the server if permissions have already been set for these groups.
To remove a group, use the following command:
oxide.group remove supporters
On success, it will display:
Group 'supporters' removed
Setting a group rank and title
A group title is a bit like a short description of the group name. For example, the group ‘supporters’ might have the following title: Corrosion Hour Supporters.
A group rank is a number used to order groups by importance. For example, “VIPs” would be of higher importance than “Non-VIP”.
To set the group title for the group ‘supporters’, use the following command:
oxide.group set supporters “[Server Supporters]”
On success, it will display:
Group 'supporters' changed
To set the rank of the supporter group:
oxide.group set supporters “[Server Supporters]” 1
On success, it will display:
Group 'supporters' changed
Set a parent group
A group will inherit the permissions of its parent group if the parent group is set. An example of this in action would be a tiered subscription system, where each tier inherits the benefits of the previous tier as well as having its own special benefits.
To set a parent for the group tier_2, use the following command:
oxide.group parent tier_2 tier_1
On success, it will display:
Group 'tier_2' parent changed to 'tier_1'
Managing uMod permissions for players
Permissions can be added or removed for players regardless of their group permission settings. This can be useful if a server admin wishes to grant or revoke a permission for a user for a short time or grant a permission for a user for a special circumstance that would make granting a group permission inappropriate.
Grant a user permission
To grant a permission to a single user, use the following command:
oxide.grant user <user_name or STEAM64_ID> <permission>
On success, it will display:
Player 'PlayerName (steam_64_bit_id)' granted permission: 'coolplugin.use'
Revoke a user permission
To revoke a permission from a single user, use the following command:
oxide.revoke user <user_name or STEAM64_ID> <permission>
On success, it will display:
Player 'PlayerName (steam_64_bit_id)' revoked permission: 'coolplugin.use'
Show a player’s assigned permissions
To see all permissions assigned to a single player, use the following command:
oxide.show user user_name
On success, it will display:
Player 'PlayerName (steam_64_bit_id)' permissions: coolplugin.use Player 'PlayerName (steam_64_bit_id)' groups: admin, default
Show players and groups assigned a permission
To see all groups and individual players assigned to a specific permission, use the following command:
oxide.show perm coolplugin.use
On success, it will display:
Permission 'coolplugin.use' Players: steam_64_bit_id (PlayerName) Permission 'coolplugin.use' Groups: group_name
In Summary
Now that we’ve covered the surface area of the uMod permission system, the next step is to log in to your server as an admin and create the appropriate groups, then assign permissions to those groups.
If you need further details, be sure to check out uMod’s documentation around permissions.
