​
How to Install Oxide/uMod on Rust Server

Oxide (now called uMod) is the essential plugin framework that transforms your vanilla Rust server into a feature-rich multiplayer experience. This guide covers complete installation and configuration of uMod to enable plugins, admin tools, and custom gameplay features. uMod enables thousands of plugins including teleportation, economy systems, admin tools, and quality-of-life improvements that make your Rust server more engaging for players.

​
What is uMod (Oxide)?

uMod is a modding framework that allows Rust servers to run plugins written in C#. It provides:
  • Plugin system - Add custom features and commands
  • Admin tools - Enhanced server management
  • Player features - Teleport, kits, economy systems
  • API access - Developer tools for custom plugins

​
Installation Methods

​
Method 1: Easy Installation (BerryByte)

For BerryByte customers, uMod installation is simplified:
  1. Login to game panel at game.berrybyte.net
  2. Navigate to Startup tab in your server
  3. Find “Oxide/uMod” setting
  4. Toggle it to “Enabled”
  5. Restart server to apply changes
Your server now supports plugins and enhanced admin commands automatically.

​
Method 2: Manual Installation

For self-hosted servers or other providers:

​
Step 1: Download uMod

  1. Visit umod.org
  2. Download latest Rust uMod build
  3. Extract files to temporary folder

​
Step 2: Install Framework

  1. Stop your Rust server completely
  2. Navigate to server root directory
  3. Copy uMod files to server folder:
    • oxide folder → server root
    • RustDedicated_Data files → overwrite existing
  4. Ensure file permissions are correct

​
Step 3: Verify Installation

  1. Start your server normally
  2. Check console for uMod loading messages
  3. Look for “uMod framework initialized” message
  4. Test with oxide.version command

​
Configuration Setup

​
Basic Configuration

uMod creates these important directories:
  • oxide/config/ - Plugin configuration files
  • oxide/data/ - Plugin data storage
  • oxide/logs/ - Error and debug logs
  • oxide/plugins/ - Installed plugins

​
Server Startup Parameters

Add these parameters to enable uMod features: 
+oxide.directory "oxide"
+oxide.config_directory "config"
+oxide.plugin_directory "plugins"

​
Permission System

uMod includes a robust permission system:
  1. Grant admin permissions: 
    oxide.grant user STEAMID64 admin
  2. Create permission groups: 
    oxide.group add vip
oxide.grant group vip cantp
  3. Assign users to groups: 
    oxide.usergroup add STEAMID64 vip

​
Essential Commands

​
Admin Commands

  • oxide.version - Check uMod version
  • oxide.reload PluginName - Reload specific plugin
  • oxide.unload PluginName - Unload plugin
  • oxide.load PluginName - Load plugin

​
Permission Commands

  • oxide.show perms - List all permissions
  • oxide.show groups - List permission groups
  • oxide.usergroup add USER GROUP - Add user to group
  • oxide.grant user USER PERMISSION - Grant permission

​
Installing Your First Plugin

​
Step 1: Download Plugin

  1. Visit umod.org/plugins
  2. Search for plugin (e.g., “Teleportation”)
  3. Download .cs file

​
Step 2: Install Plugin

  1. Upload plugin to oxide/plugins/ folder
  2. Plugin loads automatically (check console)
  3. Configure settings in oxide/config/

​
Step 3: Test Plugin

  1. Join your server
  2. Test plugin commands (e.g., /home)
  3. Check permissions if commands don’t work

​
Admin Tools

​
Player Features

​
Quality of Life

​
Troubleshooting

​
uMod Won’t Load

Common solutions:
  • Check file permissions - Ensure server can read files
  • Verify installation - Re-download and install uMod
  • Check server logs - Look for error messages
  • Update server - Ensure Rust server is current

​
Plugins Not Working

Troubleshooting steps:
  1. Check plugin compatibility - Verify Rust version support
  2. Review error logs - Check oxide/logs/ folder
  3. Verify permissions - Ensure users have required permissions
  4. Reload plugin - Use oxide.reload PluginName

​
Performance Issues

Optimization tips:
  • Limit active plugins - Only install necessary plugins
  • Monitor resource usage - Check CPU and RAM impact
  • Update regularly - Keep plugins current
  • Remove unused plugins - Clean up plugin folder

​
Security Considerations

​
Admin Access

  • Limit admin permissions - Only trusted players
  • Use Steam64 IDs - More secure than usernames
  • Regular permission audits - Review admin lists

​
Plugin Safety

  • Download from umod.org - Avoid untrusted sources
  • Read plugin code - Review before installation
  • Test on development server - Before production use

​
Frequently Asked Questions

Need help with uMod installation? Join our Discord community or contact support.