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.
Desk keycard	15 to 20 minutes	The keycard on a keycard desk (`desk_bluecard`, `desk_greencard`, `desk_redcard`), after a player takes it.
Diesel Collectable	30 to 45 minutes	The excavator diesel barrel (`diesel_collectable`), after a player picks it up.

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

Map Reports

For maps exported with player reports on. On other maps, the command does nothing.

Setting	Default	What it does
Enabled (players can send reports when the map takes them)	`true`	Off: players cannot send reports, also when the map takes them.
Chat command	`mapreport`	The chat command, without the `/`. Players type `/mapreport` and what is wrong.
Seconds between two reports of a player	`20`	How long a player waits after a report before the next one.
Reports per player per hour	`20`	The most reports one player can send in an hour. RustHQ takes at most 20 an hour from one player, so a higher number changes nothing.
Tell players about the command when they join	`true`	Each player who joins sees "Found a problem with this map? Type /mapreport and what is wrong." in the chat.

RustHQ also takes at most 30 reports an hour from one server, and 60 for one map from all its servers together. When a limit is reached, players see "Too many reports right now. Try again in a few minutes."

AI Zones (where scientists walk and hide)

For NPC spawners of scientists that no AI zone holds: not one of the map's own AI Zones and not one of Rust's monuments. Without an AI zone those NPCs stand still. The map's own AI Zones keep the settings you gave them in RustEdit.

Setting	Default	What it does
Make an AI zone for NPC spawners that have none	`true`	The extension makes a zone round each such spawner, as big as its Max Roam Distance plus 10 m (40 m when it has none), with move points on the floors and cover points by walls, rocks and crates. Off: no zones are made.
NPCs in made AI zones sleep while no player is near	`true`	The NPCs stop thinking while no player is near, as in Rust's monuments. This saves server time.
Wake distance of made AI zones (meters)	`100`	A player this near the zone wakes its NPCs.

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 },
    "Desk keycard": { "Minimum (minutes)": 15.0, "Maximum (minutes)": 20.0 },
    "Diesel Collectable": { "Minimum (minutes)": 30.0, "Maximum (minutes)": 45.0 }
  },
  "Map Reports": {
    "Enabled (players can send reports when the map takes them)": true,
    "Chat command": "mapreport",
    "Seconds between two reports of a player": 20,
    "Reports per player per hour": 20,
    "Tell players about the command when they join": true
  },
  "AI Zones (where scientists walk and hide)": {
    "Make an AI zone for NPC spawners that have none": true,
    "NPCs in made AI zones sleep while no player is near": true,
    "Wake distance of made AI zones (meters)": 100.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
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.reports`	Shows if the map takes player reports, when the map was exported, and how many reports were sent and refused since the server started.
`rustedit.reports test <text>`	Sends a test report with the text to the map's makers. In the F1 console it is from where you stand and look; in the server console, from the middle of the 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)​

Map Reports​

AI Zones (where scientists walk and hide)​

RustEdit 1 Maps​

Console commands​

RustEdit 1 map commands​

Related​