Documentation reviewed: · RustMods
Start with clear rules and useful server information. This guide uses a small set from the free RustMods catalogue and explains how to check it. Examples were checked against version 1.0.0 source files; review the description and config before installing a newer release.
1. Choose a small starter set
| Task | Where to start |
|---|---|
| Server information | RustMods Server Info: /server and /serverinfo, player count, map, rates and wipe description. |
| Welcome messages | RustMods Welcome: messages on connection and /welcome to read them again. |
| Scheduled shutdowns | RustMods Auto Restart: add it when you need a countdown and the hosting panel can start the process again. |
| Groups and access | Built-in Oxide commands. No extra plugin is needed to get started. |
Server Info and Welcome do not change gathering rates or the economy. They make useful first loading checks. Download the free files from their resource pages after signing in with RustMods ID.
2. Prepare the server and selection criteria
- Check that Oxide works:
oxide.versionshould return its version. - Back up
oxide/plugins,oxide/config,oxide/dataand the current world saves. - Read the selected release description: compatibility, dependencies, commands, permissions and changelog.
- Choose a testing window and record existing console errors. Install one plugin at a time.
3. Install one file at a time
Extract the downloaded ZIP. Put the .cs file in oxide/plugins and keep the README for reference. The config appears after a successful load. An example JSON file does not need to replace a config you have already customised. The paths below assume a standard Oxide installation.
oxide/plugins/RustModsServerInfo.cs
oxide/config/RustModsServerInfo.json
oxide/plugins/RustModsWelcome.cs
oxide/config/RustModsWelcome.jsonIf loading fails, check the first console error. Fix it before adding another plugin. Enter console commands in the server console or RCON; commands starting with a slash belong in game chat.
4. Configure Server Info
Download RustMods Server Info ↗
Edit the relevant fields in oxide/config/RustModsServerInfo.json. This is a fragment: merge its values into the existing config and keep the other settings. Replace the date, time zone, rates and rules with your own. The wipe field displays text; it does not schedule a wipe.
{
"Wipe information": "Friday 18:00 UTC",
"Rates information": "Vanilla",
"Show map seed": false,
"Custom lines": ["Rules: no cheating; respect other players."]
}oxide.reload RustModsServerInfo/serverinfoCheck the response as a regular player: the name, player count, rules and wipe description should match your server. If you change Primary chat command or Secondary chat command, use the new command name.
5. Add Welcome
This is a complete example of oxide/config/RustModsWelcome.json for version 1.0.0. Translate the message text if needed, keeping the field names and {name} and {server} tokens. The reference to /serverinfo assumes Server Info is already installed with its default commands.
{
"Prefix": "<color=#ff6b2d>[RustMods]</color>",
"Delay before welcome messages (seconds)": 2.0,
"Enable /welcome command": true,
"Broadcast player joins to everyone": false,
"Join broadcast message": "{name} joined the server.",
"Welcome messages": [
"Welcome, {name}! You are playing on {server}.",
"Type /serverinfo for server details.",
"Type /welcome to read this again."
]
}oxide.reload RustModsWelcome/welcomeReconnect next: the welcome should arrive after the configured delay. Join broadcasts are disabled in this example, so every connection does not add a message to everyone else’s chat.
6. Add Auto Restart when you need it
On a first installation, place a config with an empty schedule before uploading RustModsAutoRestart.cs. If the plugin is already running, unload it first with oxide.unload RustModsAutoRestart. Merge the following fields into an existing config while keeping its other values. For a new file, these fields disable the schedule and the remaining settings use their defaults.
{
"Daily restart times (24h HH:mm)": [],
"Save server before restart": true
}Once the config is ready, upload the .cs file; use oxide.load RustModsAutoRestart for an already unloaded plugin. An administrator can check its state with the command below.
/rmar statusEnable the schedule only after checking automatic startup in an agreed maintenance window. Use HH:mm in the server’s local time. Avoid overlapping countdowns in the hosting panel and another plugin.
7. Grant only the access you need
Group commands are part of Oxide. Reading Server Info and using /welcome in these versions are available to regular players. The rustmodsserverinfo.admin permission allows config reloading with /serverinfo reload; Rust administrators also have access. This example creates a separate information editors group.
STEAM64_ID with the intended person’s real SteamID64. Do not give this permission to all players: the default group includes everyone who connects.oxide.group add infoeditors
oxide.grant group infoeditors rustmodsserverinfo.admin
oxide.usergroup add STEAM64_ID infoeditors
oxide.show group infoeditorsCheck that /serverinfo reload works for an editor and is denied for a regular player. Remove the test access with the commands below. Auto Restart’s rustmodsautorestart.admin permission allows control over server shutdown; an information editor does not need it.
oxide.usergroup remove STEAM64_ID infoeditors
oxide.revoke group infoeditors rustmodsserverinfo.admin8. What to add after the first launch
| Feature | When it makes sense |
|---|---|
| Anti-spam and moderation | Once the chat rules are clear and specific limits are needed. Check staff exceptions. |
| Teleportation and homes | When they fit the server concept. Decide on delays, combat and raid restrictions first. |
| Economy and shops | After defining currency sources and prices. Check dependencies and balance persistence first. |
| Kits and increased rates | Once balance and wipe format are defined. Test rewards as a regular player. |
Give each addition one clear task and a result you can check. If two plugins change the same action, investigate compatibility first. Installing more files does not by itself make the server easier to play on.
9. Roll back one step if an error appears
- Copy the first console error and record the change that preceded it.
- Unload the affected plugin, then move its
.csfile fromoxide/pluginsto a backup folder outside the loading directory. - Restore the previous config from a backup. Do not delete
oxide/dataat random: it may contain plugin saves. - Before loading a previous version, check that its data and config formats are compatible.
oxide.unload RustModsWelcomeUnloading does not reverse changes already written to the world, economy or permissions. Those changes require a data recovery plan prepared in advance.
10. Check before inviting players
- A regular player receives the correct
/serverinfoand/welcomeresponses. - After reconnecting, the welcome arrives once and contains current rules.
- A regular player cannot use
/serverinfo reload; an editor can. - Selected settings survive a server restart and no new compilation errors appear.
- If installed, Auto Restart’s schedule, time zone and startup through the panel have been checked separately.
- A backup, version list and recent change notes are available.
Invite your first players and collect specific feedback: what is unclear on arrival, which command is missing and where the rules disagree with the settings. Use those observations to choose the next addition.
Sources and further reading
- OxideMod — Installing Plugins
- OxideMod — Configuring Plugins
- OxideMod — Permissions
- RustMods Server Info 1.0.0
- RustMods Welcome 1.0.0
- RustMods Auto Restart 1.0.0
This article covers Oxide for Rust. Carbon and other loaders require their own installation instructions.