Oxide permissions 101
The permission system in Oxide handles controlling who can use specific commands and features which most plugins offer. You can input any of these commands within your console if you are logged in on an admin account. If you want to know how to set up an admin account, you should read our Knowledge Base article on how to set up an admin account in rust.
Once you finish reading that guide, we also recommend you skim through our Rust Knowledge Base. We make sure to only post content within our knowledge base which is updated every patch. You do not need to be a server owner to use the information in this guide, but we'd like you to check out our industry low prices. You can do so by visiting our Rust Server Renting Page.
You can think of UMod Oxide as a safe which holds your plugins. Within the safe, just like a real safe, you'll want a key or a code. This way you can make sure that only the people you want to have access to your safe have access to the contents of your safe. Plugin permissions are essentially the same thing.
A permission is a value which you can apply to a user group or an individual player allowing them access to a specific command within the plugin. A user group, simply, is a group for users. By default, UMod Oxide gives you an admin group and a default group. As it sounds, admins go in the admin group, everyone else is in default.
To find out if your mod requires you to pass out permissions to operate, you can tell because it will say so within the plugin overview at UMod.org.
As a hypothetical example, we'll use the permission from the made-up plugin SuperGather. Super Gather requires you to add the permission supergather.pickup in order to pick up super gather resources. It also grants users the /pickup command. If you want admins to have access to the /pickup command, and only admins, give the admin group access to this permission like so:
Press F1 to enter your console, and enter the following text:
oxide.grant group admin supergather.pickup
Then press Enter.
The admins will now have access to this command.
On a side note, the admin group is a subgroup of default, which means if you give the default group access to supergather.pickup, admins will have it as well. You can do this by entering the following text into the console:
oxide.grant group default supergather.pickup
Below, you will see a list of commands which can be entered into the console in the above format. If you need any help with this and are a member of our services, please do not hesitate to contact us via our 24/7 customer support utility.
|oxide.grant user <name><permission>||Grants a user a permission|
|oxide.revoke user <name><permission>||Revokes a users permission|
|oxide.grant group <group><permission>||Grants a group a permission|
|oxide.revoke group <group><permission>||Revokes a groups permission|
|oxide.usergroup add <name><group>||Adds a user to a group|
|oxide.usergroup remove <name><group>||Removes a user from a group|
|oxide.group add <group> <"[Title]"><rank>||Creates a new group Title and rank are optional depending on the circumstance.|
|oxide.group remove <group>||Removes a group|
|oxide.group set <group><"[Title]"><rank>||Sets the title or rank of a group.|
|oxide.group parent <parentgroup><childgroup>||Setting the parent group of another group|
|oxide.show user <name>||Shows a user's permissions|
|oxide.show group <group>||Shows a group's members and permissions|
|oxide.show perm <permission>||Shows which user or group has a permission|
|oxide.show groups/perms||Shows all groups or permissions|
|oxide.grant group <group> *||Grants a group a wildcard. Wildcard simply means all. So this would grant the right to all permissions|
|oxide.grant user oxide.*||Grants a user all permissions without adding them to the admin group.|
Some Oxide Permisions Q&A:
Q: If I set a group's permissions, do all members within the group gain access to that permission?
A: Yes, all members within the admin group have admin permissions.
Q: Are there default groups?
A: Yes, the default groups are admin and user.
If there's anything else you would like to know, don't hesitate to contact us via 24/7 live chat to answer your problem :)
Was there anything that you missed while looking in this guide? Make sure to let us know so we can update our guide and make it even better!