background image

Rust Oxide/uMod Plugin Installation - Knowledgebase

  1. Rent A Game Server
  2. Knowledgebase
  3. Rust
  4. Rust Oxide/uMod Plugin Installation
Knowledge Base Submit Ticket Open Tickets
Game Servers 380 7 Days to Die 4 Abiotic Factor 2 Aloft 2 alt:V 2 Americas Army Proving Grounds 2 Among Us 2 Archean 2 ARK Survival Ascended 6 ARK Survival Evolved 3 Arma 3 3 Arma Reforger 2 Aska 2 AssaultCube 2 Assetto Corsa 3 Astro Colony 2 Astroneer 2 Automobilista 2 2 Avorion 2 Banana Shooter 2 Barotrauma 3 BATTALION Legacy 2 BeamNG.drive (BeamMP) 2 Black Mesa 2 Brickadia 2 Call of Duty 2 Citadel: Forged with Fire 2 ClassiCube 2 Clone Hero 2 Colony Survival 2 Conan Exiles 4 Contagion 2 Core Keeper 2 Counter-Strike 2 3 Craftopia 2 CryoFall 2 CS2D 2 Cube 2: Sauerbraten 2 Cubic Odyssey 2 DayZ 4 DDNet 2 DDRaceNetwork 2 Dead Matter 2 Dont Starve Together 4 Eco 2 Empyrion Galactic Survival 2 Enshrouded 3 Escape from Tarkov 2 Euro Truck Simulator 2 2 Factorio 2 Farming Simulator 25 2 Fistful of Frags 2 FiveM 3 FortressCraft Evolved 2 Foundry 2 Foundry VTT 2 Frozen Flame 2 FTL Tachyon 2 Garrys Mod 3 Ground Branch 2 Half-Life 2 Deathmatch 2 Hogwarp 2 Holdfast: Nations at War 2 HumanitZ 2 Hurtworld 2 Hytale 1 Icarus 2 Insurgency Sandstorm 2 IOSoccer 2 Just Cause 3 Multiplayer 2 Kerbal Space Program 2 Killing Floor 2 3 LeagueSandbox 2 Left 4 Dead 2 Left 4 Dead 2 3 Longvinter 2 Los Angeles Crimes 2 Medal of Honor 2 Midnight Ghost Hunt 2 Mindustry 2 Minecraft 4 Minetest 2 Modiverse 2 Mordhau 3 Mount & Blade II: Bannerlord 2 Myth of Empires 2 Nazi Zombies Portable 2 Necesse 2 NeosVR 2 Neverwinter Nights EE 2 Night of the Dead 2 Nightingale 2 No Love Lost 2 No More Room in Hell 2 No One Survived 2 Nova-Life Amboise 2 Nuclear Option 2 Onset 2 Open Fortress 2 OpenArena 2 OpenRA 2 OpenRCT2 2 OpenTTD 2 Operation Harsh Doorstop 2 Palworld 3 Path of Titans 2 Pavlov VR 3 PixARK 2 Plains of Pain 2 Portal Knights 2 Post Scriptum 2 Project Zomboid 8 Puck 2 Quake Live 2 R5Reloaded 2 RedM 2 Renown 2 Resonite 2 Return to Moria 2 Rimworld Together 2 Rising World 2 Risk of Rain 2 1 Rust 4 Satisfactory 1 SCP Secret Laboratory 3 SCUM 2 Smalland 2 Solace Crafting 2 Soldat 2 Soldat 2 2 Sonic Robo Blast 2 2 Sons of the Forest 2 Soulmask 2 SourceCoop 2 Space Engineers 3 Space Station 14 2 Squad 3 Starbound 3 StarMade 2 Stationeers 2 Stormworks 2 Subnautica Nitrox 2 Sunkenland 2 SuperTuxKart 2 Sven Co-op 2 Swords 'n Magic and Stuff 2 Team Fortress 2 3 Teeworlds 2 Terraria 3 TerraTech Worlds 2 TF2 Classified 2 The Forest 3 The Front 2 The Isle 2 Tower Unite 2 Trackmania 2 Unturned 4 Urban Terror 2 V Rising 3 Valheim 3 VEIN 2 Veloren 2 Vintage Story 3 Voyagers of Nera 2 Wolfenstein: Enemy Territory 2 Wreckfest 2 Wurm Unlimited 2 Xonotic 2 Zandronum 2 Getting Started 2 Network & Connectivity 1 Server Management 2
Support
Categories

Rust Oxide/uMod Plugin Installation

rust oxide umod carbon plugins mods 0 found this helpful
Available in: ESPAÑOL

This guide covers how to install the Oxide/uMod or Carbon modding framework on your Rust server, add community plugins, and manage them via the console. For general server configuration and startup variables, see the Rust Server Configuration Guide.

Installing Oxide/uMod or Carbon

Oxide (now maintained as uMod) and Carbon are modding frameworks for Rust that allow you to install community-built plugins. These frameworks add features such as economy systems, custom kits, vote rewards, PvE protection zones, and much more.

You do not need to upload any files manually. The modding framework is installed automatically by setting a single startup variable:

  1. Stop your server from the GPanel Console tab.
  2. Log in to GPanel and go to the Startup tab.
  3. Find the FRAMEWORK variable and set it to:
    • oxide — for Oxide/uMod (the most widely used framework, with the largest plugin library)
    • carbon — for the Carbon framework (an alternative with its own plugin ecosystem)
    • vanilla — to run without any modding framework
  4. Start the server. The framework files are downloaded and applied automatically. On first start with Oxide, the oxide/ directory structure is generated.
  5. Check the console log for a line such as Loaded plugin Oxide.Core to confirm Oxide is active.
No manual download required. When you set the FRAMEWORK variable and start the server, the framework is downloaded and installed automatically. You do not need to upload Oxide or Carbon files via SFTP.

Installing Plugins

Plugins are distributed as .cs (C# source) files. Oxide compiles them on the server at runtime — no pre-compilation is required.

  1. Download the plugin .cs file from umod.org or another trusted source.
  2. Upload the .cs file to the oxide/plugins/ directory on your server using SFTP or the GPanel file manager. For help with SFTP, see How to Upload Files via SFTP.
  3. If the server is running, the plugin will be detected and compiled automatically within a few seconds. You will see output in the console confirming it loaded, e.g. Loaded plugin MyPlugin v1.2.3 by Author.
  4. If the server is not running, the plugin will load on next startup.

Oxide Directory Structure

oxide/
  plugins/
    MyPlugin.cs       <- place plugin files here
    AnotherPlugin.cs
  config/             <- auto-generated plugin config files
  data/               <- plugin data files
  logs/               <- plugin log files
Plugin files must go directly in oxide/plugins/. Files placed in subdirectories or with incorrect extensions will be ignored. Each plugin must have the .cs extension.

Configuring Plugins

Most plugins generate a JSON configuration file in oxide/config/ the first time they load. To customise a plugin:

  1. Let the plugin load at least once so it generates its default config file.
  2. Stop your server (or note that some plugins support live config reload).
  3. Open the plugin's config file in oxide/config/PluginName.json using the GPanel file manager or SFTP.
  4. Edit the settings and save the file.
  5. Reload the plugin with oxide.reload PluginName or restart the server.

Managing Plugins via Console

These commands can be run from the GPanel console or via an RCON client. For RCON setup, see Rust RCON Access and Admin Commands.

Command Description
oxide.plugins List all currently loaded plugins and their versions.
oxide.load PluginName Load a plugin that is present in oxide/plugins/ but not yet loaded.
oxide.unload PluginName Unload a plugin without removing the file.
oxide.reload PluginName Reload a plugin after updating its .cs file. Use this to apply plugin updates without a full server restart.
oxide.reload * Reload all loaded plugins at once.

Updating Plugins

To update a plugin to a newer version:

  1. Download the updated .cs file from the plugin's page on umod.org.
  2. Upload the new file to oxide/plugins/, overwriting the existing file.
  3. If the server is running, Oxide detects the file change and automatically recompiles and reloads the plugin. Alternatively, run oxide.reload PluginName.
  4. Check the console for any errors. Some plugin updates may require changes to the config file in oxide/config/.

Removing Plugins

To remove a plugin entirely:

  1. Run oxide.unload PluginName to unload the plugin while the server is running.
  2. Delete the .cs file from oxide/plugins/.
  3. Optionally delete the plugin's config file from oxide/config/ and data files from oxide/data/ if you no longer need them.

Popular Plugins

Plugin Category Description
Kits Gameplay Allow players to redeem pre-configured item kits. Useful for starter kits or VIP rewards.
Economics Economy Adds a server currency system. Used as a dependency by many shop and reward plugins.
ServerRewards Economy Point-based reward system, often combined with Economics for an in-game shop.
VoteDay Utility Lets players vote to skip to daytime. Reduces complaints about long nights.
Clans Social Adds a clan/team system with clan tags and shared access to tool cupboards.
TruePVE PvE Prevents player-vs-player damage. Essential for PvE server configurations.
Teleportation Utility Adds player-to-player and home teleport commands with configurable cooldowns.
DiscordCore / DiscordMessages Integration Sends server events (connects, chat, deaths) to a Discord webhook channel.
Only install plugins from trusted sources. The official source for uMod plugins is umod.org. Plugins from unknown sources may contain malicious code that can compromise your server. Always review plugin permissions and read community comments before installing.

Troubleshooting Plugin Issues

If your plugins are not loading, check the following:

  • Confirm Oxide is installed and active. In GPanel's Startup tab, the FRAMEWORK variable must be set to oxide. The console log should show Loaded plugin Oxide.Core during startup.
  • Plugin files must be placed directly in oxide/plugins/ with the exact .cs extension. Files in subdirectories or with wrong extensions are ignored.
  • Check the console and oxide/logs/ for compilation errors. A plugin with a syntax error will fail to load and the error message will describe the issue.
  • Some plugins have dependencies on other plugins (e.g. many shop plugins require Economics). Install all required dependencies first.

For other common server issues, see Rust Server Troubleshooting.

Need Help?

If you run into an issue not covered in this guide, our support team is available to help. Submit a support ticket and include your server ID, a description of the issue, and any relevant console output.

Was this article helpful?
Help Improve

Related Articles

Rust RCON Access and Admin Commands
This guide explains how to access RCON (Remote Console) on your Rust server and covers the most usef... Rust Server Configuration Guide
This guide covers how to configure your Rust dedicated server hosted with Legion Hosting, including ... Rust Server Troubleshooting
This guide covers common issues you may encounter when running a Rust dedicated server on Legion Hos...
Back

Ready to Get Started?

The servers are booted, select your plan and become our latest satisfied client.