Server Extension Settings and Commands

The RustEdit server extension keeps its settings in oxide/config/RustEdit.json on the server. It makes the file with the defaults the first time it runs, and adds any setting that is missing. Restart the server after you change the file.

Automatic Updates

Setting	Default	What it does
Enabled	`true`	On: when a newer version of the extension is out on GitHub, the extension downloads it at server start and restarts the server 5 seconds later. Off: it only writes to the log that a newer version is out.

RustEdit 2 Maps

These settings are for maps exported by RustEdit 2.

Setting	Default	What it does
`Map keys (MapName \| Encryption Key) Use * as the name to work on any map`	Two example lines: `"*"` and `"mapname"`, both `"encryptionkey"`	The encryption key of each locked map, by map name. `"*"` is the key for any map with no line of its own. Replace the example lines with your own. See Give the server the map's key.
`Stop the server when the map key is missing or wrong. If false, the server will load without any RustEdit data`	`false`	`true`: the server stops when the key is missing or wrong, or the RustEdit data is damaged. `false`: the server runs the map without its RustEdit data.

Spawn Handlers

Setting	Default	What it does
Enable loot container spawn handlers	`true`	Loot containers come back after they are looted or destroyed. Off: they do not come back. Loot profiles still fill them.
Enable resource spawn handlers	`true`	Trees and ores come back after they are harvested.
Enable NPC spawn handlers	`true`	NPC spawners spawn their NPCs. Off: no NPCs from the map's spawners.
Enable APC spawn handlers	`true`	Bradley APCs drive the map's APC paths. Off: no Bradleys on them.

A respawn time that you set on an entity in RustEdit always applies, even when its switch is off.

Respawn Times (when the map sets none)

These times are for entities that have no respawn time of their own in RustEdit. Each has Minimum (minutes) and Maximum (minutes): the time is random between them. A maximum of 0 means the entities do not come back until the next server start.

Setting	Default	Used for
Default loot containers	30 to 60 minutes	Loot containers. A container's loot profile respawn time comes first.
Resources	20 to 45 minutes	Trees and ores.
Junk piles	20 to 45 minutes	Junk piles.
Traps/Barricades (Respawn/Re-Arm)	25 to 40 minutes	Landmines, bear traps and barricades.

Other entities with no respawn time of their own come back at the next server start.

Example of this part of the file, with the defaults:

"RustEdit 2 Maps": {
  "Map keys (MapName | Encryption Key) Use * as the name to work on any map": {
    "*": "encryptionkey",
    "mapname": "encryptionkey"
  },
  "Stop the server when the map key is missing or wrong. If false, the server will load without any RustEdit data": false,
  "Spawn Handlers": {
    "Enable loot container spawn handlers": true,
    "Enable resource spawn handlers": true,
    "Enable NPC spawn handlers": true,
    "Enable APC spawn handlers": true
  },
  "Respawn Times (when the map sets none)": {
    "Default loot containers": { "Minimum (minutes)": 30.0, "Maximum (minutes)": 60.0 },
    "Resources": { "Minimum (minutes)": 20.0, "Maximum (minutes)": 45.0 },
    "Junk piles": { "Minimum (minutes)": 20.0, "Maximum (minutes)": 45.0 },
    "Traps/Barricades (Respawn/Re-Arm)": { "Minimum (minutes)": 25.0, "Maximum (minutes)": 40.0 }
  }
}

RustEdit 1 Maps

These settings are for maps exported by RustEdit 1. Spawn Handlers has the same four switches as above.

Respawn Times, each with Minimum (minutes) and Maximum (minutes):

Setting	Default
Default loot containers	30 to 60 minutes
Desk keycard	15 to 20 minutes. Used on RustEdit 2 maps too.
Diesel Collectable	30 to 45 minutes
Junk piles	20 to 45 minutes
Resources	20 to 45 minutes
Traps/Barricades (Respawn/Re-Arm)	25 to 40 minutes
Vehicles	45 to 60 minutes

Console commands

Type these in the server console or through RCON. In the game's F1 console they need an owner (auth level 2). Commands that start with / are chat commands for admins.

Command	What it does
`rustedit`	Shows the extension's version and its commands.
`rustedit.key "your key"`	In `server.cfg` or as a startup argument: the map's key for this start. While the server runs: saves the key for this map in the config. Restart the server to load the map with it. See Give the server the map's key.
`rustedit.key`	Shows where the map's key came from and what the map's RustEdit data holds.
`rustedit.key clear`	Removes this map's key from the config.
`rustedit.info`	Shows what the map's RustEdit data holds and what the extension made of it: the entities spawned, NPCs, vendors, APC paths and Bradleys, cargo stops, NPC paths, splines, custom topology maps, custom entities, trigger values, the tropical look, and if the map is a large map.
`rustedit.checkupdate`	Checks GitHub for a newer version of the extension.
`rustedit.downloadupdate`	Downloads the newest version of the extension.
`rustedit.desks.populate`	Puts the keycards back on all keycard desks.
`/rustedit.io.print`	Shows the input and output connections of the IO entity you look at.
`/rustedit.spawns.show [seconds]`	Draws the map's custom player spawn points for a while: 30 seconds when you give no number.

RustEdit 1 map commands

These commands are for maps exported by RustEdit 1. On a RustEdit 2 map they do nothing, or report 0.

Command	What it does on a RustEdit 1 map
`rustedit.apc.status`	Shows the status of the map's APCs.
`rustedit.apc.killall`	Kills all the map's APCs that are alive.
`rustedit.apc.respawn`	Respawns all the map's APCs that are dead.
`rustedit.io.reset`	Sets up all the map's IO connections again.
`rustedit.vending.restockall`	Restocks all the map's vending machines.
`/rustedit.vending.restock`	Restocks the map vending machine you look at.
`rustedit.loot.respawnall`, `rustedit.loot.info`	Spawns all loot containers that wait to respawn, or counts them.
`rustedit.resource.respawnall`, `rustedit.resource.info`	Spawns all resources that wait to respawn, or counts them.
`rustedit.junkpile.respawnall`, `rustedit.junkpile.info`	Spawns all junk piles that wait to respawn, or counts them.
`/rustedit.ocean.show [seconds]`	Draws the map's ocean path.

Automatic Updates​

RustEdit 2 Maps​

Spawn Handlers​

Respawn Times (when the map sets none)​

RustEdit 1 Maps​

Console commands​

RustEdit 1 map commands​

Related​