Schedule Soulmask RCON commands with the Scheduled Tasks button in your game panel: pick a command, set the hour and how often it repeats, and your server runs it for you, for example a world backup every 12 hours.
Soulmask allows RCON commands, and the GTX game panel can send any of them on a timer, at any hour, repeated as often as you like. Below we set up a world backup every 12 hours as an example.
How to schedule Soulmask RCON commands
- Go to the Scheduled Tasks button and create a New task by selecting Console/RCON Command from the list.
- Type the Task Name.
- Change the Type to Daily.
- Select the hour you want the task to be executed.
- Enable the Repeat task option.
- Change the Repeat Every field to 12 Hours.
- Change the For field to 24 Hours.
- Change to the Script Parameters tab on top.
- Type the Telnet Command
backup world. - Save the task.
In the screenshot the command goes into the Command to Execute field on the Script Schedule tab. If your task window shows that field instead of a Script Parameters tab, type backup world there.
Backups and the world.db save
You can schedule any RCON command, not just backups. One thing to know about the backup commands: if you create a backup with a random name, your server will not read that backup after a restart unless you rename it to world.db afterwards. world.db is the default save name Soulmask loads on server start.
All Soulmask RCON commands
Here is every available RCON command, its aliases (short forms you can type instead) and what it does.
- Disconnect (aliases
q,dc,quit): close the manage connection. - ShowHelp (aliases
help,?): view help. - SaveAndExit (aliases
close,exit,shutdown): save and exit the game world after a specified number of seconds. Example:[close 300]saves and closes the server after 300 secs. - StopCloseServer (aliases
cancelclose,cc): cancel the previous server shutdown command before the countdown ends. - SaveWorld (alias
sav): save the game world without exiting; parameter 1 forces an immediate save to hard disk. Example:[save 1]forces a save of the world. - BackupDatabase (aliases
bk,backup): back up the game archive; the parameter specifies the name of the new archive. Example:[backup new_database_name]createsnew_database_name.db. - BackupDatabaseByHour (alias
bkh): back up the archive, naming itYYYYmmddHH.dbusing UTC time. - Dump_AllActorPositions (alias
dap): export the positions of various actors in the game toSaved/ACTOR_POSI_DATA.log. - DrawActorImage (alias
dai): draw the position of a specified actor type toSaved/ACTOR_IMAGE_*.bmp. Example:[dai 0]draws all characters' positions as images. - QueryInvitationCode (alias
qi): query the game invitation code. - ServerFPS (alias
fps): query the server's average frame rate over a short period. - ServerLoginStatus (alias
sl): manage player login status; parameter0disallows,1allows new logins. Example:[sl 0]disallows new players from logging in.
The square brackets in the examples only mark the command. Type what is inside them, for example close 300. Want to run a command by hand instead? See How to use RCON commands on your Soulmask server.
Soulmask scheduled task questions
How do I schedule Soulmask RCON commands?
In the game panel, open Scheduled Tasks, create a New task of the type Console/RCON Command, set the name, type and hour, then enter the command (for example backup world) and save the task.
How do I back up my Soulmask world every 12 hours?
Create a Daily Console/RCON Command task, enable Repeat task, set Repeat Every to 12 Hours and For to 24 Hours, and use the command backup world.
Why does my server not load my named backup after a restart?
Soulmask loads world.db on server start. A backup saved under another name is not read until you rename it to world.db.
Want your own Soulmask server? GTX Soulmask servers come with scheduled tasks, the Web Console and full file access: see Soulmask server hosting.
Related guides
Any questions? Our support team is available 24/7: open a support ticket.
