Summary
Setting up RCON on a Soulmask server provides administrators with remote management. It allows direct command-line access to the server, enabling admins to execute a wide range of commands without needing to be logged directly into the game or the server panel itself. This capability is invaluable for moderating players by kicking or banning, adjusting server settings on the fly, broadcasting messages to all connected players, or triggering specific in-game events.
How to Set Up RCON on a Soulmask Server
1. Log in to the BisectHosting Games panel.
2. Stop the server.
3. Go to the Startup tab.
4. Ensure the Enable RCON table is set to Enabled.
5. On the RCON Password table, copy the password.
6. Go to the Files tab.
7. Find the following directory: /home/container/WS/Saved/Config/LinuxServer .
8. Open Engine.ini.
9. Under [Server.SafeIP], add the IP to whitelist on a new line.
IP=xxx.xxx.xxx.xxx
| Note | Look up IP here. Do not remove the first set IP. |
10. Press Save Content.
11. Start the server.
12. Go to the Console tab.
13. Copy the RCON IP and Port at the top of the logs.
14. Launch the RCON client. rcon-cli is used in this example.
15. Input the RCON IP and Port from step 13.
16. Input the RCON password from step 5.
17. Enter help to view the list of RCON commands.
Soulmask RCON Commands
| Command | Aliases | Parameters | Description |
|---|---|---|---|
| BackupDatabase | 5 bk |
InNewDBName [string] | Writes the world save to a file using the given file name. Run SaveWorld 0 first to ensure a recent world state is written. |
| BackupDatabaseByHour | 6 bkh |
Writes the world save to a file using the current date and time as a file name. Run SaveWorld 0 first to ensure a recent world state is written. | |
| CreateItemForPlayer | 34 citem |
InOpPlayer [string] ItemClass [string] Nums [int] Quality [int] |
Create an item in the inventory of the player specified by their Steam ID. |
| CreateSpecifiedMan | 22 cnpc |
InPlayer [string] CreateNo [int] Sex [int] |
Spawns a preconfigured NPC in front of the player specified by their Steam ID. The spawned NPC will be owned by the player. |
| CreateSpecifiedMan_ByConfig | InOpPlayer [string] Key [string] |
||
| CreateSWByClass | 23 create |
SelectedPlayerAccount [string] CreatureClass [string] IsBaby [bool] DengJi [int] Num [int] PinZhi [int] |
Spawn an npc in front of the player specified by their Steam ID. The npc will be owned by the player. As such, only things which can normally be owned by players are allowed, like mounts. |
| DeleteItem | 37 del |
InOpPlayer [string] InItemClass [string] InCount [int] |
Deletes items from a player's inventory. |
| Disconnect | 0 q dc quit |
Disconnect from the server. | |
| DrawActorImage | 8 dai |
ActorType [int] | Outputs an image to WS/Saved that visualizes the locations of all instances of a specific type of actor. |
| DrawGrids | 13 dg |
Outputs an image to WS/Saved that visualizes a grid. | |
| Dump_AllActorPositions | 7 dap |
Dumps actor positions to the file WS/Saved/ACTOR_POSI_DATA.log. The file organizes actors by type. | |
| DumpGzImg | ObjType [int] | ||
| ExecScriptCommands | 38 run |
ScriptFileName [string] | Run all commands listed in the specified text file. The file must be saved on the server. |
| FlyMode | 24 fly |
InPlayer [string] NMode [int] |
Sets whether the player specified by their Steam ID is in ghost mode or not. |
| GotoPostion | 20 go |
InOpPlayer [string] InX [float] InY [float] InZ [float] |
Teleport the player specified by their Steam ID to the specified location. |
| GotoTarget | 21 gonpc |
InOpPlayer [string] InTarget [string] |
Teleport the player specified by their Steam ID to a target character. The target can be a player specified by Steam ID or a pawn specified by UID. |
| IncGameSeconds | Slice [int] | Increases the "uptime" counter for the server by the specified number of seconds. Negative values will decrease the timer. | |
| List_AllItemClass | 33 lai |
SubName [string] | Specify a full or partial name of an item, such as Bow, to get a list of matching item classes. |
| List_AllNPCClass | 19 lcc |
NameSubStr [string] | Specify a full or partial name of an NPC type, such as Alpaca, to get a list of matching NPC classes. |
| List_AllPlayers | 15 lap |
Lists information about all players who have accounts on the server. | |
| List_AllProficiency | Lists all proficiency types (values of the EProficiency enum). | ||
| List_AllTalent | 35 lat |
TelentLevel [int] | Lists all natural gifts (innate talents) of the specified level (1-3). Passing 0 for the level will list talents of all levels. Includes their ID, name and description. |
| List_GuildObjs | 18 lgo |
InOpGuild [string] | Lists the name and UID of all NPCs owned by the specified tribe. The tribe can be specified by name or UID. |
| List_Guilds | 17 lg |
Lists the names and UIDs of all tribes on the server. | |
| List_OnlinePlayers | 14 lp |
Lists players currently connected to the server. | |
| List_SameBelongingObjs | 16 ls |
InOpPlayer [string] | Lists the name and UID of NPCs owned by the specified character. The character can be a player specified by Steam ID or a pawn specified by UID. |
| List_ServerPermissionList | 30 lsp |
Lists information about server permission lists. | |
| QueryGridCount | 12 qg |
Prints a count. | |
| QueryInvitationCode | 9 qi |
Prints the server’s invitation code which can be given to players as a means of finding the server. | |
| SaveAndExit | 2 close exit shutdown |
AfterSeconds [int] | Saves and shuts down the server after the specified number of seconds. 0 will set the timer to 300 seconds. |
| SaveAndExitWithCode | CloseAfterSeconds [int] ExitCode [int] |
Prints a message in the server log about changing the exit code. The exit code of the process itself remains 0. | |
| SaveWorld | 4 sav |
Force [int] | Saves the world. The parameter controls whether to write the save to disk. |
| SayToSystemChannel | 36 say |
Content [string] | Sends a system chat message to everyone on the server. |
| ServerFPS | 10 fps |
Prints the average value of the server tick rate from a short period of time. | |
| ServerLoginStatus | 11 sl |
Pause [int] | This command currently has no effect. |
| Set_Coefficient | 26 sc |
ItemName [string] Val [float] |
Sets the specified gameplay setting to the specified value. |
| Set_OutputChats | 31 soc |
bOutputTolog [bool] | Sets whether chat messages will be recorded in the server log. Pass 1 to enable chat logging or 0 to disable it. |
| Set_ServerPermissionEnable | 27 ssp |
PermissionType [int] bEnabled [int] |
Enables or disables the server permission list specified by index. |
| Set_ServerPermissionFlag | 28 sspf |
PermissionFlag [int] | Sets the enabled state of all server permission lists using the specified bit mask. |
| SetGameExitCode | ExitCode [int] | Prints a message in the server log about changing the exit code. The exit code of the process itself remains 0. | |
| SetRCONSendMaxBytes | Send_Size [int] | ||
| Show_Coefficient_Settings | 25 lc |
ContainNames [string] | Lists the values of all gameplay settings. Can optionally specify a full or partial name to only list values for matching settings. |
| ShowHelp | 1 help ? |
Prints information about several of the available commands. | |
| StartAI | Resumes NPC AI that has been paused using StopAI. | ||
| StopAI | Pauses all NPC AI on the server. All AI controlled units will just stand in place and do nothing while paused. This includes enemy units no longer fighting players. | ||
| StopCloseServer | 3 cancelclose cc |
Cancels a pending server shutdown that was initiated with SaveAndExit, as long as the timer has not yet elapsed. | |
| Update_RconClientAddress | bAddOrRemove [int] | Adds (1) or removes (0) an IP address from the list of addresses which are allowed to connect to the server's RCON. Changes made by this command will be lost on server restart. | |
| Update_ServerPermissionList | 29 usp |
PermissionType [int] bRemoveOrAdd [int] Data [string] |
Adds or removes an item from a server permission list specified by index. |
