Rust: installing Oxide/uMod plugins and running a wipe

Two things nearly every Rust server owner needs: the Oxide (uMod) modding framework so you can run plugins, and a reliable wipe routine for when Facepunch pushes the monthly forced update. This guide covers both.

Install Oxide (uMod)

Oxide (also called uMod) is the plugin framework almost every modded Rust server runs on. On ServerPrism the easiest way to get it is built into your server type:

1. Open your server and go to the Startup tab.
2. Look for a modding framework / Oxide option (many Rust eggs have a toggle or a build variable like Oxide/Carbon).
3. Set it to Oxide, then reinstall or restart so the framework is downloaded.
4. After it boots, the console shows the Oxide version on startup, and an oxide/ folder appears in the File Manager.

If your server type doesn't expose a toggle, open a support ticket and we'll switch you to the Oxide build.

Install plugins

Rust plugins are single .cs files.

1. Download the plugin .cs file from umod.org.
2. In the File Manager, drop it into oxide/plugins/.
3. Oxide hot-loads plugins — no restart needed. The console prints Loaded plugin <Name> within a few seconds.

Config and data files generate under oxide/config/ and oxide/data/ on first load. Edit the config, then reload the plugin with oxide.reload <PluginName> in the console.

Useful console commands:

oxide.plugins           # list loaded plugins
oxide.reload PluginName  # apply config changes
oxide.unload PluginName  # disable without deleting
oxide.grant group admin PluginName.permission  # permissions

Wiping your server

A wipe resets progress. There are two levels:

• Map wipe — regenerates the map and clears buildings/loot, but keeps blueprints. Do this when you want a fresh map.
• Full wipe (BP wipe) — map wipe plus clearing player blueprints. This is what most servers do on the monthly forced update.

How to wipe

1. Stop the server from the Console tab.
2. In the File Manager, open the server/<identity>/ folder (the identity is set on your Startup tab).
3. To map wipe, delete the map files: *.map and *.sav (and their .1, .2 backups).
4. For a full wipe, also delete the blueprint data — remove the player.blueprints.*.db files (or the whole storage/blueprint files depending on your build).
5. Optionally change the world seed and/or map size on the Startup tab for a brand-new map.
6. Start the server. It generates a fresh world on boot.

Always back up first. Take a backup before wiping so a mistake is reversible — see Backing up your server.

Force wipe timing

Facepunch pushes a mandatory update on the first Thursday of each month, which breaks Oxide and plugins until they update. On force-wipe day: update the server, wait for Oxide and your plugins to release updated versions, then wipe. Running an outdated Oxide after a force update will fail to load — this is expected until uMod updates.

Common issues

• Plugins won't load after the monthly update: Oxide/plugins aren't updated yet for the new Rust version — update the server and wait for uMod to catch up.
• Failed to compile a plugin: wrong plugin version for your Oxide build, or a missing dependency plugin — check the plugin's uMod page.
• Wipe "didn't work": you deleted files in the wrong identity folder, or didn't stop the server first — stop, delete in the correct server/<identity>/ folder, then start.
• Server not in the browser: still booting, or the description/server.hostname isn't set — check the console.

Need a hand with a wipe or a stubborn plugin? Open a support ticket and we'll sort it on the node.