Rust wiper

Wipe a Rust server on a schedule, or right now.

License required

The Rust wiper needs the Rust Wiper license add-on. Without this add-on the tab does not appear.

The Rust Wiper stops a server, deletes the files that you list, changes the server variables, and starts the server again. You can run a wipe at once, or save it for a date, or repeat it every month.

Opening the wiper

1. Navigate to your Rust server.
2. Open the Rust Wiper tab in the sidebar.

The tab appears when your license includes the add-on and an administrator turned the module on for the egg of the server.

The page has two columns. The left column holds the Create Wipe form. The right column holds three cards: Timezone, Scheduled Wipes, and Map Library.

Setting the timezone

The wiper reads the timezone of the server for every scheduled time. Open the Timezone card and select your zone. The panel saves the change at once. The card shows the current time in that zone.

Set the timezone before you build a schedule.

The create wipe form

Server identity

Field	Description	Default
Server Name	The in-game server name after the wipe. %DAY% and %MONTH% become the wipe date. Click Load Current to copy the present name.	empty
Description	The in-game description after the wipe. The same date codes work here.	empty

The new map

Field	Description	Default
Map Size	The world size for the new map.	empty
Map Seed	The world seed. Leave the field empty for a random seed.	empty
Random Seed	Picks a new random seed at wipe time.	off
Random Map (from library)	Picks a random map from the Map Library.	off
Custom Map URL	A direct link to a .map file.	empty

These fields lock each other. A custom map URL disables the size and seed boxes. A random seed disables the seed box.

What gets deleted

Field	Description	Default
Files to Delete	One path on each line. The * wildcard works, for example /server/rust/*.map. An empty box deletes nothing.	empty
Wipe Blueprints	Deletes the player blueprint database files.	off

WARNING

The wiper deletes the files that you list and nothing else. To wipe the map, list the map and save files yourself. The wiper does not delete player data, deaths, or cargo on its own.

The schedule

Field	Description	Default
Schedule Wipe	On saves the wipe for later. Off runs the wipe at once.	on
Schedule Time (one-time)	A single date and time.	empty
Repeat Schedule	Five rows named 1st to 5th. Set a row to pick that week of the month. Each row then gives a weekday and a time.	none

Use one of the two. A one-time date disables the repeat rows, and a repeat row disables the one-time date. A new repeat row starts on Thursday at 20:00.

There is no cron field.

Pre-Wipe commands

Warn your players before a wipe. Click Add Command and give the console command and the number of minutes ahead of the wipe. A new row runs 15 minutes ahead.

An example command is say Server wiping in 15 minutes!.

Add as many rows as you need.

Saving a schedule

Leave Schedule Wipe on and click Schedule Wipe. The wipe appears in the Scheduled Wipes card.

The card shows the name of each wipe and whether it is one-time or recurring. A one-time wipe also shows the next run time.

Running a wipe now

WARNING

Tell your players before a manual wipe. The wipe deletes the files at once and you cannot undo it.

1. Clear the Schedule Wipe checkbox. The button changes to Wipe Now.

2. Click Wipe Now.

3. Read the dialog:

   The server will be stopped and its map, saves and player data deleted. This cannot be undone. Take a backup first if you might want any of it back.

4. Click Wipe now to confirm.

What happens during a wipe

1. The panel sends each pre-wipe command at its set time.
2. The panel stops the server and waits about a minute.
3. The panel deletes the files that you listed. It also deletes the blueprint files when you set that option.
4. The panel updates the server variables: the hostname, the description, the world size, the world seed, and the map URL.
5. The panel starts the server again.

The panel does not keep a wipe history. A one-time wipe leaves the Scheduled Wipes card after it runs.

Editing a schedule

Click the pencil icon on the row. The Edit Wipe dialog opens with the same fields. Change the values and click Save Changes.

Deleting a schedule

Click the trash icon on the row. The dialog reads:

It will not run. Any commands attached to it are removed too.

Click Remove to confirm.

The map library

The Map Library holds the maps that the Random Map option picks from.

To add a map:

1. Click the + button on the Map Library card.
2. Give a name. This field is optional.
3. Give the direct URL of the .map file. This field is required.
4. Click Add Map.

To remove a map, click the trash icon on the row and confirm. A scheduled wipe that used that map falls back to a random map.

Next steps

• Server Management - the other server features.
• Rust uMod - the plugin manager for Rust.