Skip to main content

Plugins (Oxide and uMod)

Plugins add commands, kits, teleports, chat tools and events to your Rust server. They run on Oxide, the framework that loads them, and most are published on uMod. The Plugins page lets you browse uMod and update plugins from the panel.

Enable Oxide​

A new server has no plugin support. Plugins first shows Plugins need Oxide:

Oxide is the framework that loads plugins. Enabling it restarts the server.

  1. Warn your players if the server is busy.
  2. Press Enable Oxide.
  3. Watch Console until you see Server startup complete.

The page then becomes the plugin browser.

Install plugins from uMod​

  1. Open Plugins in the RUST group.
  2. Browse the catalog or search for a plugin.
  3. Install it from its entry. The panel downloads it to your server.
  4. Check the console: Oxide loads the plugin and prints a line when it is ready. If it does not load, run oxide.reload PluginName.

Read the plugin's uMod page for its commands and permissions.

Update and remove​

  • Update: the page flags newer versions of installed plugins. Read the changelog first, because some updates change the config format, then check the console for errors after updating.
  • Remove: remove the plugin from the page. Its config and data files may remain in the oxide folders; delete them in Files for a clean removal.

After a Rust update, some plugins break until their authors publish a fix. If the console fills with errors, wait a day or two and look for plugin updates.

Folders​

Everything Oxide uses is in the oxide folder, open from Files:

FolderWhat is in it
/oxide/pluginsThe plugin files (.cs).
/oxide/configOne config file per plugin (.json).
/oxide/dataData the plugins save: players, balances, homes and so on.

To change a plugin's settings, edit its file in /oxide/config, save, and reload it from the Console:

oxide.reload PluginName

Oxide hot-loads plugins, so no restart is needed. Config files are JSON: a missing comma or quote stops the plugin from loading, so check the console afterwards.

Upload a plugin manually​

For a plugin bought elsewhere or missing from the catalog:

  1. Download the .cs file from a source you trust.
  2. In Files, open /oxide/plugins.
  3. Press Upload and choose the file (or use SFTP).
  4. Oxide loads it automatically. If not, run oxide.reload PluginName.
warning

Only install plugins from sources you trust. A plugin runs with full access to your server. Prefer uMod and well-known marketplaces, and read the reviews.

Useful Oxide commands​

Type these in the Console:

CommandWhat it does
oxide.pluginsLists loaded plugins.
oxide.reload PluginNameReloads one plugin after a config change or an update.
oxide.unload PluginNameUnloads a plugin without deleting its file.
oxide.grant user NameOrSteamId permissionGives a permission to a player.
oxide.grant group GroupName permissionGives a permission to a group.

Common problems​

  • A plugin does not load. Read the console: the error usually says what is missing, such as a required plugin or a newer Oxide version.
  • A command says you have no permission. Most plugins use Oxide permissions. Grant the permission to a player or group as above.
  • The server lags after installing plugins. See Optimization and remove what you do not use.

Fenix can help read an error; otherwise contact support.

Related: Players, Optimization, Backups.