Skip to main content

Plugins (Oxide and uMod)

Plugins add commands, kits, teleports, chat tools, events and much more to your Rust server. They run on Oxide, the framework that loads plugins, and most of them are published on uMod. The Plugins page lets you browse uMod and keep your plugins up to date without leaving the panel.

Enable Oxide​

A new server does not have plugin support turned on. When you open Plugins you will see the message 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. Wait for the server to restart. Watch Console until you see Server startup complete.

Once Oxide is enabled, the page changes to the plugin browser.

Install plugins from uMod​

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

Read the plugin's page on uMod to see its commands and permissions before you use it.

Update and remove​

  • Update: the page shows when a newer version of an installed plugin is available. Update it from the panel, then check the console for errors. Read the changelog first, because some updates change the config format.
  • Remove: remove the plugin from the page. Its config and data files may remain in the oxide folders; delete them yourself in Files if you want a clean removal (see below).

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

Folders​

Everything Oxide uses lives in the oxide folder, which you can 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 you do not need to restart the server for this. Config files are JSON: a missing comma or quote will stop the plugin from loading, so edit carefully and check the console afterwards.

Upload a plugin manually​

For a plugin you bought elsewhere or that is not in 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 picks it up automatically. If not, run oxide.reload PluginName in the console.
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.

Ask FenixAI if you need help reading an error, or contact support.

Related: Players, Optimization, Backups.