Rust uMod plugins
Add uMod plugins to a Rust server from the panel.
License required
The Rust plugin manager needs the Rust uMod Plugin Manager license add-on. Without this add-on the tab does not appear.
The Rust uMod manager installs a modding framework onto a Rust server, and then installs plugins from the uMod catalogue. It also reloads, removes, and upgrades them.
Opening the manager
- Navigate to your Rust server.
- Open the Rust uMod Plugins tab in the sidebar.
The tab appears when your license includes the add-on and an administrator turned the module on for the egg of the server. See the Modifications tab in Eggs.
The page shows a framework card at the top. The browse panel and the installed panel appear below it after a framework exists.
Step 1: install a framework
A plugin needs a modding framework. The manager offers two:
| Framework | Description |
|---|---|
| Oxide | The long-standing Rust modding framework. Most uMod plugins target it. |
| Carbon | A newer framework. It accepts the same plugins and the same console commands. |
Click Install Oxide.Rust or Install Carbon. The manager downloads the current release and unpacks it onto the server.
A message reads Oxide installed - restart the server to activate. Restart the server now. The framework starts with the game.
Install one framework only.
Upgrading the framework
After an install, the framework card shows the installed version. When a newer release exists, the card also shows the newest version in yellow.
Click Upgrade to download the current release again. A message reads Framework upgraded - restart the server to activate. Restart the server.
The Upgrade button is always visible. A click while you are already on the newest version reinstalls the same release and does no harm.
Removing the framework
Click Uninstall and confirm. The dialog reads:
Plugins will stay on disk but stop loading.
WARNING
An uninstall deletes the framework directory but does not undo the changes that the install made to the game files. To return a server to a clean unmodded state, reinstall the server.
Step 2: find a plugin
The Browse uMod plugins panel lists the uMod catalogue for Rust.
- Type a name in the Search plugins... box.
- Press Enter, or click Search.
The search matches the name, the title, the author, and the description. It is not case-sensitive.
Each result row shows the plugin icon, the title, the version, a one-line description, and the author.
The results run to more than one page. Each page holds 20 results. Use Prev and Next. The page counter is below the list.
The panel opens with the first page of the whole catalogue. A search with no matches leaves the list blank.
Step 3: install a plugin
Click Install on the result row. The install starts at once. There is no confirmation dialog.
A green message reads Kits installed when the install finishes.
The plugin loads straight away. A plugin does not need a server restart. The manager sends the load command to the running server.
If the plugin needs other plugins, the manager installs those first and loads them in order.
If a dependency is not in the catalogue, the message names it, for example Kits installed (warning: missing dependencies: Foo). The message is red even though the plugin installed. Find the missing plugin yourself, or remove the one that needs it.
Where the files go
| Framework | Plugins | Configuration | Data | Language files |
|---|---|---|---|---|
| Oxide | oxide/plugins | oxide/config | oxide/data | oxide/lang |
| Carbon | carbon/plugins | carbon/config | carbon/data | carbon/lang |
Managing installed plugins
The Installed plugins panel lists every plugin with its name, its version, and its file path. The heading shows the count.
Each row has three icon buttons:
| Icon | Tooltip | What it does |
|---|---|---|
| Circular arrow | Reload plugin | Reloads the plugin from disk. Use this after you edit a configuration file. |
| Grey trash | Uninstall (keeps config) | Unloads the plugin and deletes the plugin file. The configuration and data files stay. |
| Red trash | Purge (also wipes config & data) | Removes the plugin and also deletes its configuration, data, and language files. |
WARNING
The grey trash icon has no confirmation dialog. One click removes the plugin.
The red trash icon does ask for a confirmation:
This wipes the plugin including its config and data files.
Click Purge to confirm.
Reload plugin needs a running server.
Updating a plugin
The manager has no update button and no update indicator.
To move a plugin to the current version, find it in the browse panel and click Install again. The new file replaces the old one.
Editing a plugin configuration
The manager has no configuration editor. Use the Files tab of the server.
- Open the Files tab.
- Open
oxide/config(orcarbon/configfor Carbon). - Edit the
.jsonfile of the plugin and save it. - Go back to the uMod tab and click Reload plugin on that plugin.
Most plugins write their configuration file at first load. Start the server once after the install, and the file appears.
Working on a stopped server
You can install and remove plugins while the server is stopped. The file changes still happen. The load and unload commands fail without an error message, and the plugin list catches up at the next start.
Reload plugin is the one action that reports a failure on a stopped server.
Where the plugins come from
The manager reads the public uMod asset catalogue for Rust. It downloads the framework releases from the official GitHub projects. The manager accepts downloads from a fixed list of trusted hosts only.
If the browse panel stays blank for every search, the uMod catalogue is not reachable. Try again later.
Requirements
- The server must use a Rust egg with the module turned on.
- Your license must include the Rust uMod Plugin Manager add-on.
- A framework must be installed before the plugin panels appear.
Next steps
- Rust Wiper - the wipe scheduler for Rust.
- Server Management - the other server features.
- Eggs - how to turn the module on for an egg.