UMOD/Oxide Basic Usage Guide
This guide provides an overview of the basic usage of UMOD/Oxide for managing plugins on your Rust server. If you’re looking to install UMOD/Oxide, refer to this installation guide.
How to Upload Plugins
Adding plugins to your Rust server is straightforward with UMOD/Oxide. Follow these steps to upload and configure plugins:
- Upload the .cs files for the plugins to the
oxide/plugins
folder on your server. - Configuration files for most plugins can be found in the
oxide/config
folder. - Some plugins may also use the
oxide/data
folder for storing additional data.
Tip: Each plugin on the UMOD website includes a detailed description of its setup and configuration. Be sure to read the documentation for specific guidance on customising your plugins.
Basic Oxide Commands
Oxide provides a variety of commands to manage plugins and permissions effectively. Below is a list of common commands:
oxide.reload (PLUGIN NAME)
- Reloads the specified plugin.oxide.unload (PLUGIN NAME)
- Unloads the specified plugin.oxide.reload *
- Reloads all plugins at once.oxide.usergroup add (GROUP NAME)
- Creates a new Oxide user group.oxide.grant group (GROUP NAME) (PERMISSION)
- Grants a specific permission to a group for a plugin.oxide.grant user (USERNAME/STEAM64 ID) (PERMISSION)
- Grants a specific permission to a user for a plugin.
Practical Examples
Here are some examples to illustrate how these commands work:
- Reload a Plugin: If you updated a plugin called "BetterChat", use
oxide.reload BetterChat
. - Grant a Group Permission: To allow the "Admins" group to use a plugin permission called "noclip.use", use
oxide.grant group Admins noclip.use
. - Create a New User Group: To create a group called "VIPs", use
oxide.usergroup add VIPs
.
Best Practices
To ensure smooth management of your Rust server with UMOD/Oxide, consider the following tips:
- Backup Regularly: Before adding or modifying plugins, create a backup of your server files.
- Monitor Plugin Performance: Keep an eye on resource usage to ensure plugins are not causing lag or crashes.
- Keep Plugins Updated: Regularly check for updates on UMOD to ensure compatibility with your server version.
Conclusion
UMOD/Oxide provides powerful tools for customising and managing your Rust server. By following this guide, you’ll have the foundational knowledge to upload, configure, and manage plugins effectively. For more advanced features, explore the official UMOD documentation.