Oxide Permissions

From Rust Server Wiki
Revision as of 13:14, 5 September 2023 by Hades (talk | contribs) (Created page with "=== Oxide Permissions: An In-depth Guide to Rust's Modding Control System === One of the most potent features of the Oxide modding framework for Rust is its permissions system. Oxide Permissions offer server administrators granular control over who can do what on their servers. Whether you're looking to restrict specific commands, designate special roles, or grant exclusive access to particular server functionalities, the Oxide Permissions system has you covered. This ar...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Oxide Permissions: An In-depth Guide to Rust's Modding Control System

One of the most potent features of the Oxide modding framework for Rust is its permissions system. Oxide Permissions offer server administrators granular control over who can do what on their servers. Whether you're looking to restrict specific commands, designate special roles, or grant exclusive access to particular server functionalities, the Oxide Permissions system has you covered. This article delves deep into the workings of this system, its setup, and best practices.

What are Oxide Permissions?

In the context of Rust and the Oxide framework, permissions refer to the system that regulates access to various commands and functions provided by mods and plugins. Essentially, it acts as a gatekeeper, determining which players can use which commands.

Key Concepts of Oxide Permissions

  1. Groups: These are collections of players categorized under a common label. By default, Oxide has three groups: default, moderator, and owner. However, admins can create custom groups as needed.
  2. Users: Individual players identified by their unique IDs.
  3. Permissions: Specific allowances given to groups or users, enabling them to access commands or features.
  4. Inheritance: Groups can inherit permissions from other groups, streamlining the process of setting up permissions.

Setting Up Oxide Permissions

Accessing the Console: Before setting up permissions, you need to access the Rust server console. This could be through direct server access or an RCON tool.

  1. Creating Custom Groups:
    • Command: oxide.group add [groupname]
    • Example: oxide.group add VIPs
  2. Adding Users to Groups:
    • Command: oxide.usergroup add [username] [groupname]
    • Example: oxide.usergroup add player123 VIPs
  3. Assigning Permissions to Groups:
    • Command: oxide.grant group [groupname] [permission]
    • Example: oxide.grant group VIPs homesystem.use
  4. Assigning Permissions to Individual Users:
    • Command: oxide.grant user [username] [permission]
    • Example: oxide.grant user player123 teleport.use
  5. Checking Permissions:
    • For groups: oxide.show group [groupname]
    • For users: oxide.show user [username]
  6. Removing Permissions:
    • From groups: oxide.revoke group [groupname] [permission]
    • From users: oxide.revoke user [username] [permission]

Best Practices

  1. Start Restrictive, then Loosen: Begin by granting essential permissions only, then add more as necessary. This approach minimizes potential misuse or errors.
  2. Use Descriptive Group Names: If you're setting up custom groups, use names that clearly indicate their role or access level.
  3. Regularly Review Permissions: Periodically check and update permissions to ensure they remain relevant and secure.
  4. Monitor Plugin Updates: When updating or adding new plugins, review their permissions requirements to maintain a streamlined permissions setup.