Summary
This guide is designed to help you understand Oxide’s permission system. It will cover the basics of what a permission is, how to give them to your players, and how to work with Oxide’s group system.
Permissions
Oxide allows you to add various plugins to your server which can alter gameplay through various commands or functionalities. Many of these features have associated permissions, allowing you to control who has access to each of them.
In short, permissions are simply a string or sequence of letters and digits, commonly separated into sections using periods. These sections are referred to as “permission nodes” or “nodes” for short.
Our example plugin features a few different permissions, for instance enhancedbansystem.banlist. When a user has this permission, it allows them to use the command /banlist
Wildcards: A wildcard acts as a “grant all” for a node, and is commonly denoted by the asterisk symbol. For example, the permission enhancedbansystem.* will grant the user all permissions from our example plugin.
Groups
Occasionally you may want to assign the same set of permissions to multiple people. For instance, you may want admins on your server to have access to commands such as banning and kicking. Instead of assigning each user the same permissions, Oxide features the group system.
Oxide’s permission groups offer the following features:
- Create multiple groups with any names.
- Quickly add and remove permissions to a group.
- Add and remove users from a group. Users inherit permissions from their groups.
- Create group hierarchies with inheritance.
Inheritance
When a user is assigned a group, they are not directly given the permissions, rather they inherit the permissions from the group. When called upon, the permission system will first check if the player has the permission, if not it will check if their groups do.
Similarly, you may assign groups a “parent” group. The “child” group will then inherit all permissions the parent has.
Below is an example of how the player Mitch inherits permissions from the Admin group, which inherits from the Mod group.
Oxide’s Permission Commands
Group Commands
|
Command
|
Description
|
|---|---|
Information commands
|
Command
|
Description
|
|---|---|
Allows you to grant permissions or groups for a specific time
|
Command
|
Description
|
|---|---|
Usage example: /grantperm GT timedpermissions.use 30d
gives GT the permission timedpermissions.use for 30 days.
- d = days
- h = hours
- m = minutes
