Skip to content

Plugins ​

The Plugins tab of a hosted server manages the Oxide plugins running on it. Communities install approved catalog plugins only: the RustyThrones team reviews every plugin and release, so what you install is verified and can be rolled back. Plugins tab needs the servers.configure permission (Admin). Attached servers show: "This server is attached over RCON: plugins are managed on its own host."

The page has two views: Installed and Browse catalog.

Installed ​

One list of the plugins on the server: catalog installs and files the catalog does not manage. Use the search box and the filters All, Needs attention and Not managed; the arrow keys move through the list. Compare with the server now forces a comparison of the server's plugin files with the catalog; Files opens the Oxide folder (configs and data).

Each row shows the name, version, Update available, Pinned and a status:

StatusMeaning
RunningLoaded and in sync with the catalog.
QueuedWaiting to be installed (the worker installs within minutes, at most 3 actions per run).
Deploying / VerifyingAn install is in progress; the server confirms the plugin loaded.
Retrying / Timed outThe server did not confirm in time; retried up to 3 times, then blocked.
Failed to load / Rolled back to vXThe new version did not load and the previous one was restored automatically.
Load errorOxide could not load the file (usually a Rust or Oxide update the plugin does not support yet).
OffDisabled.
Not managedA file on the server that the catalog does not manage.

Plugin detail ​

ControlEffect
VersionPick any approved release. Choosing one other than the latest pins the plugin there: it shows Pinned and platform rollouts skip it. Choosing the latest release unpins it.
Update to latestShown when a newer approved release exists.
UpdatesRight away (a new release is deployed as soon as it reaches the server, by a platform rollout or by you choosing a version) or At the next wipe (the change waits and is applied after the next wipe).
EnabledOff removes the managed file; On reinstalls it.
RetryAfter a failure, tries again.
Previous versionGoes back to the previous approved release and pins it.
SettingsTyped editor of the plugin's configuration (below).
Compiler outputThe Oxide output of a failed load, with Copy.

For files Not managed: Reload, Unload, Load. Bringing such a file under management ("Adopt into catalog") is done by platform staff; until then it gets only those three actions.

Automatic rollback ​

Every install is verified: the agent installs the file, reloads the plugin and waits up to 60 seconds for the "loaded" confirmation. If the plugin fails to compile or load, the previous version is restored on its own and the status shows Rolled back. A failed release is blocked (no retry loop) until a new release is chosen or you click Retry. At most 6 plugin writes per server per hour are accepted.

Rollouts ​

When the platform releases an update with automatic rollout, one canary server (the website server by default, see Settings) gets it first. After the soak time (30 minutes by default) with the plugin loaded, the server not offline and fewer than 5 exception lines, the other servers follow one at a time. A failure reverts the canary or that server and halts the rollout. A rollout skips servers where the plugin is Pinned, turned off, or already on that release.

Plugin settings ​

Settings shows the plugin's configuration as a form (switches, numbers, text, chip lists, tables, nested sections) with key search, per-field undo and origin badges. A change is saved to a layer:

Scope in Apply toEffect
This serverOnly this server.
All my serversA community-level layer for every server of the plugin. Fields can be locked at this level so a server cannot override them.

The effective config is the catalog default, overlaid with the community layer, overlaid with the server layer. A JSON switch edits the raw file. Save applies and reloads the plugin and verifies it; a config that fails to load is restored and blocked ("The last settings failed to load: edit to try again.").

Browse catalog ​

Plugins approved by the RustyThrones team. Search, filter by category, and open a card for the full page: summary, tags, description, Requires, Works with, Conflicts with, commands (chat and console), permissions, configuration notes and changelog.

Install ​

  1. Click Install on a card or its page.
  2. If the plugin needs others, a dialog says "Plugin needs other plugins. It requires ... Install them together?" Install all installs the dependencies first and then the plugin.
  3. If it conflicts with an installed plugin: "Plugin conflicts with installed plugins. ... Turn those off afterwards, or install anyway?" Install anyway accepts the conflict.
  4. If a dependency is not available or an installed dependency is too old (for example "v1.2 installed, needs v1.4+, update it first"), the dialog "Plugin can't be installed yet" explains what to fix.

An installed card shows Installed. Retired plugins can no longer be installed; existing installs keep running.

Platform staff ​

Platform staff can also upload plugin sources, adopt unmanaged files, approve upstream (uMod) updates and manage rollouts. These tools are not part of the community panel; ask the platform team through Discord for a plugin that is not in the catalog.

Troubleshooting ​

ProblemFix
Install stays QueuedThe server must be online and the agent reachable; the worker runs every 30 minutes at most and right after changes.
Rolled backRead Compiler output, check for a newer plugin version, then Retry.
Cannot find a pluginIt is not in the catalog (or not listed). Ask the platform team.
Settings do not applyThe config failed to load; fix the value and save again.