Rcon Overview and Commands: Difference between revisions

From Pavlov VR Wiki
Jump to navigation Jump to search
m (Adds GiveAll command output)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
RCON (Remote CONnection) is the method pavlov servers can be controlled from outside of VR. When a server is brought online, an email is sent to the owner with the RCON credentials to connect remotely. RCON can be accessed at: <nowiki>http://pavlovrcon.com/</nowiki>  
RCON (Remote Console) is the method with which Pavlov VR servers can be controlled from outside of VR. It does not allow for reading server log messages.
----
 
== RCON Commands ==
 
=== Placeholders ===
Values in [square brackets] are placeholders and must be replaced, or will be replaced by the server in a reply.
 
[UniqueID] - Player ID (eg. [https://steamid.io/ SteamID64] (PCVR), Oculus Username (Shack))
 
[GameMode] - See [[Setting up a dedicated server#Configuring Game.ini|Gamemodes table]] and [[Gamemodes]]
 
[TeamID] - 0 for blue, 1 for red, if there are teams
 
[VehicleID] - See [[Vehicles]]
 
[MapName/ID] - See [[Default Maps|Default maps]] or find the Map ID on Mod.io and append it to "UGC" (Example: https://mod.io/g/pavlov/m/mcdonalds has Resource ID <code>2804322</code>, the MapID to use would be <code>UGC2804322</code>)
 
[SkinID] - See [[ItemIDs#Skins|Skins]]
 
[RoleID] - See [[ItemIDs#TTT Roles (Case Sensitive)|TTT Roles]]
 
[ItemID] - See [[ItemIDs|Items]]
 
[True/False] - Either "True" to enable or "False" to disable
 
[Amount] - A number indicating an amount of something


== Rcon Overview and Commands ==
=== Reply format ===
'''Ban/Unban'''
All command replies are formatted as JSON and inherit this base format:
{
"Command": "[The command name]",
"Comment": "[An optional comment about the command]",
"Successful": "[True/False]"
}
Comment will not exist if the command does not output a comment.


If you want Ban/Unban to work file /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt needs to be writable by user running server.  (If you followed the instructions on the wiki, username steam is running the server and creates the file).
Additional command output is added to the above format. The Example Reply column below only contains this additional command output.


Often, commands will contain a field with its own name and a boolean value. This is a very inconsistent value. For example in <code>SetMaxPlayers</code>, if the amount is set to the same as the current slot count, <code>Successful</code> will be <code>true</code> but <code>SetMaxPlayers</code> will be <code>false</code>. However for <code>SwitchTeam</code> for example, if a player is switched to the same team they are already in, <code>SwitchTeam</code> will be <code>true</code> anyway.


Commands:
=== Commands ===
{| class="wikitable"
|+RCON Commands
!Command
!Parameters
!Description
!Example Command
!Example Reply
|-
|Help
|none
|Returns the full list of commands and their parameters
|
Help
|
"Help": [
  "AddMapRotation MapID GameMode",
  ...truncated...
  "UpdateServerName ServerName"
],
|-
|AddMapRotation
|[MapName/ID]
[GameMode]
|Adds the specified map with the specified game mode to the bottom of the map rotation.
Writes the map to <code>Game.ini</code>.
|
AddMapRotation sand snd
|
|-
|AddMod
|[UniqueID]
|Adds the specified player to the moderator list, making them an admin.
Allows them to use the admin menu in the pause menu and be immune to being vote-kicked.


<pre>
Writes the player to <code>mods.txt</code>.
Help                                -Returns the full list of commands
|
Ban {UniqueID}                      -Bans the player from the server (adds them to blacklist.txt)
AddMod 12345678901234567
Kick {UniqueID}                    -Kicks the player from the server
|
Kill {UniqueID}                    -Kills the player
"AddMod": true,
Unban {UniqueID}                    -Unbans the player from the server (tries to remove the unique id from blacklist.txt)'
"UniqueID": "12345678901234567",
Banlist                            -Shows the current list of banned players
|-
AddMod {UniqueID}                  -Adds a mod ID to the mods.txt file
|Ban
RemoveMod {UniqueID}                -Removes a mod ID to the mods.txt file
|[UniqueID]
ItemList                            -Shows available items for GiveItem command
|Kicks and permanently bans the specified player from the server. They will not be able to join the server anymore.
RotateMap                          -Rotates to the next map in the game.ini
Writes the player to <code>blacklist.txt</code>.
SwitchMap {MapName/ID} {GameMode}  -Switches to the map/gamemode specified, ex "SwitchMap DataCenter TDM" or "SwitchMap UGC1080326389 DM"
|
SwitchTeam {UniqueID} {TeamId}      -Switches the specified players team
Ban 12345678901234567
GiveItem {UniqueID} {ItemId}        -Give the specified player the Item
|
GiveCash {UniqueID} {CashAmt}      -Give the specified player cash
"Ban": true,
GiveTeamCash {TeamId} {CashAmt}    -Gives all members of the teamId cash
"UniqueID": "12345678901234567",
GiveVehicle {UniqueID} {VehicleID} -Spawns Vehicle on top of player, see below for vehicle IDs
|-
InspectPlayer {UniqueID}            -Returns information about the player specified (PlayerName, Cash, KDA, TeamId etc)
|Banlist
RefreshList                        -Returns a list of players on the server (unique/steamId)
|none
Slap {UniqueID} {damage amt}        -Inflicts damage amount on player.  From zero to 100.
|Lists the currently banned player UniqueIDs from <code>blacklist.txt</code>.
ServerInfo                          -Returns information about the server (ServerName, CurrentMap, PlayerCount/MaxPlayerCount etc)
|
Disconnect                         -Disconnects the player from Rcon
Banlist
ResetSND                            -Resets the match back to round 1 keeping the same teams
|
SetPlayerSkin {UniqueID} {SkinId}  -Sets the skin for the specified player, see below for IDs
  "BanList": [
SetLimitedAmmoType {0-5}            -Sets the limited ammo type for the duration of the match. See below for the different ammo types available
  "12345678901234567",
SetPin {####}                      -Sets the password on your server, must be 4 digits e.g. "SetPin 0000". Running SetPin without a number will remove the pin from the server.
  "12345678901234568",
Shownametags {True/False}          -Toggles if nametags are visible or not. Useful for tactical/realistic servers, or making trailers and taking screenshots for your maps.
  ...truncated...
Shutdown                            -Shuts down the server (Shack RC only, currently untested).
  "12345678901234569"
],
|-
|ClearEmptyVehicles
|none
|Removes all vehicles that are not occupied by a player.
|
  ClearEmptyVehicles
|
|-
|Disconnect
|none
|Forces the server to closes the RCON connection.
|
Disconnect
|
Goodbye
|-
|EnableCompMode
|[True/False]
|Enables or disables competitive mode.
'''Comment''': Comp mode will be changed on map rotation, this updates the config value


TTT-only commands:
Writes to <code>bCompetitive</code> in <code>Game.ini</code>.
|
EnableCompMode true
|
"CompModeState": true,
"EnableCompMode": true,
|-
|EnableVerboseLogging
|[True/False]
|Enables or disables verbose logging.
Writes to <code>bVerboseLogging</code> in <code>Game.ini</code>.
|
EnableVerboseLogging false
|
"VerboseLoggingState": false,
"EnableVerboseLogging": true,
|-
|EnableWhitelist
|[True/False]
|Enables or disables whitelist usage.
When enabled, only players who are listed in <code>whitelist.txt</code> can join the server.


tttflushkarma {UniqueID}            -Resets a player's karma
Writes to <code>bWhitelist</code> in <code>Game.ini</code>.
tttsetkarma {UniqueID} {####}      -Sets the karma of a player to a value
|
tttsetrole {UniqueID}              -Currently broken
|
tttendround                        -Ends the round
"WhitelistState": true,
tttpausetimer                      -Pauses the timer
"EnableWhitelist": true,
TTTAlwaysEnableSkinMenu            -Enables the skin menu mid-round
|-
</pre>
|Gag
|[UniqueID]
[True/False]
|Gags or ungags the specified player.
When gagged, players can not use voice chat.
|
|
"Gag": true,
"UniqueID": "12345678901234567",
|-
|GiveAll
|[TeamID]
[ItemID]
|Gives an item to all players on a team.
The <code>GiveItem</code> RCON command description elaborates on how items are placed onto the body of the player.
|
|
"GiveAll": true,
"TeamID": "1",
"ItemID": "galul",
|-
|GiveCash
|[UniqueID]
[CashAmount]
|Gives the specified amount of cash to the specified player.
|
GiveCash 12345678901234567 200
|
"GiveCash": true,
"UniqueID": "12345678901234567",
|-
|GiveItem
|[UniqueID]
[ItemID]
|Equippes the specified item to the specified player to the corresponding item slot.
Primary guns are placed into the players main hand, replacing the held gun, which will drop.


Secondary guns are placed onto the players hip, replacing the holstered gun, which will drop.


PCVR UE5 update RCON CMDS<pre>
Utilities will be placed onto the players chest slots until all slots are full, which will cause given items to be dropped instead.
AddMapRotation [MapID] [GameMode] # add a map to the servers rotation from Mod.io
|
AddMod [UniqueID] # add user to mods.txt on server (make an admin) and allows them to use admin menu in pause menu
GiveItem 12345678901234567 syringe
Ban [UniqueID] # ban player permanently and add there ID to blacklist.txt on server
|
Banlist # shows current banned players
"GiveItem": true,
Disconnect # close rcon connection (should always be used when done)
"UniqueID": "12345678901234567",
EnableCompMode [True/False]
|-
EnableVerboseLogging [True/False] # more info printed to log file on server
|GiveTeamCash
EnableWhitelist [True/False] # only players who are on the whitelist.txt on server may join
|[TeamID]
Gag [UniqueID] [True/False] # player cant use mic
[CashAmount]
GiveAll [TeamID] [ItemID] # give all players on team a item
|Adds the specified amount of cash to each member of the specified team.
GiveCash [UniqueID] CashAmt # give player cash  
|
GiveItem [UniqueID] [ItemID] # give player item
GiveTeamCash 0 200
GiveTeamCash [TeamId] [CashAmt] # give team cash
|
InspectAll # prints detailed status for each connected player
"GiveTeamCash": true,
InspectPlayer [UniqueID] # prints detailed status for a connected player
"TeamID": "0",
InspectTeam [TeamID] # prints detailed status for one team of connected players
|-
ItemList # list items in game / map (custom items built into map will list too )
|InspectAll
Kick [UniqueID] # remove player from game
|none
Kill [UniqueID] # kills player
|Returns a list of InspectPlayer blocks for all players on the server.
MapList # shows current map rotation
|
ModeratorList # shows current server admins
InspectAll
RefreshList # shows all connected players and ID
|
RemoveMapRotation [MapID] [GameMode] # remove map from rotation
"InspectList": [
RemoveMod [UniqueID] # remove admin
  {
ResetSND
    "PlayerName": "Username",
PauseMatch [TimeInSeconds]
    "UniqueId": "12345678901234567",
RotateMap
    "KDA": "3/1/2",
ServerInfo
    "Score": "50",
SetBalanceTableURL [GithubURL]
    "Dead": false,
SetCash [UniqueID] [CashAmt]
    "Cash": "3450",
SetLimitedAmmoType [AmmoType]
    "TeamId": "1",
SetMaxPlayers [MaxPlayerNumber]
    "Ping": 39.857143402099609,
SetPin [PinNumber]
    "Gag": false
SetPlayerSkin [UniqueID] [SkinID]
  },
SetTimeLimit [TimeLimitAmount]
  ...truncated...
ShowNametags [True/False]
],
ShutdownServer
|-
Slap [UniqueID] [DamageAmount]
|InspectPlayer
SwitchMap [MapId] [GameMode]
|[UniqueID]
SwitchTeam [UniqueID] [TeamID]
|Returns a detailed status for the specified player.
Teleport [MoveUniqueID] [ToUniqueID]
The player must be listed in RefreshList.
TTTAlwaysEnableSkinMenu [True/False]
|
TTTEndRound [WinningTeamID]
InspectPlayer 12345678901234567
TTTFlushKarma
|
TTTGiveCredits [UniqueID] [CreditAmount]
"PlayerInfo":
TTTPauseTimer [True/False]
{
TTTSetKarma [UniqueID] [KarmaAmt]
TTTSetRole [UniqueID] [RoleID]
Unban [UniqueID]
UpdateServerName [ServerName]
</pre>


  "PlayerInfo":
{
  "PlayerName": "Username",
  "UniqueId": "12345678901234567",
  "KDA": "3/1/2",
  "Score": "50",
  "Dead": false,
  "Cash": "3450",
  "TeamId": "1",
  "Ping": 39.857143402099609,
  "Gag": false
},
|-
|InspectTeam
|[TeamID]
|Returns a list of InspectPlayer blocks for all player on the specified team.
|
InspectTeam 1
|
"InspectList": [
  {
    "PlayerName": "Username",
    "UniqueId": "12345678901234567",
    "KDA": "3/1/2",
    "Score": "50",
    "Dead": false,
    "Cash": "3450",
    "TeamId": "1",
    "Ping": 39.857143402099609,
    "Gag": false
  },
  ...truncated...
],
|-
|ItemList
|none
|Lists all items in the game and the current map.
Custom items built into the map will be listed.
|
ItemList
|
"ItemList": [
  "1911",
  "57",
  "acog",
  "adrenaline",
  ...truncated...
  "ww2knife",
  "ww2medkit",
  "ww2painkillers",
  "ww2syringe"
],
|-
|Kick
|[UniqueID]
|Kicks the specified player from the server.
|
Kick 12345678901234567
|
"UniqueID": "12345678901234567",
"Kick": true,
|-
|Kill
|[UniqueID]
|Kills the specified player.
|
Kill 12345678901234567
|
"UniqueID": "12345678901234567",
"Kill": true,
|-
|MapList
|none
|Returns the current map rotation from Game.ini.
|
MapList
|
"MapList": [
  {
    "MapId": "UGC2863450",
    "GameMode": "SND"
  },
  ...truncated...
  {
    "MapId": "sand",
    "GameMode": "snd"
  }
],
|-
|ModeratorList
|none
|Returns a list of UniqueIDs of all moderators from <code>mods.txt</code>.
|
ModeratorList
|
"ModeratorList": [
  "12345678901234567",
  ...truncated...
  "12345678901234568"
],
|-
|RefreshList
|none
|Returns a list of all connected player names and their corresponding UniqueIDs.
|
RefreshList
|
"PlayerList": [
  {
    "Username": "Username",
    "UniqueId": "12345678901234567"
  },
  ...truncated...
  {
    "Username": "Username2",
    "UniqueId": "12345678901234568"
  }
],
|-
|RemoveMapRotation
|[MapName/ID]
[GameMode]
|Removes the first occurrence of the specified map and game mode combination from the map rotation.
[MapName/ID] and [GameMode]  are case sensitive to the entries in <code>Game.ini</code> or <code>MapList</code> respectively.


{UniqueID} is a player's Steam ID 64. It's the 17-digit number that appears next to their names in most Rcon tools. Alternatively, if you have a player's profile URL, you can find their ID at: https://steamid.xyz/
Writes the change to <code>Game.ini</code>.
|
RemoveMapRotation sand snd
|
|-
|RemoveMod
|[UniqueID]
|Removes the specified player from the moderator list.
Writes the change to <code>mods.txt</code>.
|
RemoveMod 12345678901234567
|
"RemoveMod": true,
"UniqueID": "12345678901234567",
|-
|ResetSND
|none
|Reset the currently running SND match.
All players will have starting cash, no kills, deaths, assists or score.


'''Limited ammo types:'''
All players are killed.


0 = Unlimited<br />
The score is reset to 0 all.
1 = Limited Generic<br />
|
2 = Limited Specific<br />
ResetSND
3 = Custom (for modders)<br />
|
4 = Limited Special<br />
"ResetSND": true,
5 = Boxless Mode
|-
|PauseMatch
|[Optional Amount]
|Pauses the currently running match for the specified amount of seconds.
The game is frozen and displays a "Game is paused" countdown timer.


'''Item, skin, and vehicle IDs:'''
The game is unpaused when amount is not specified or 0.


[http://wiki.pavlov-vr.com/index.php?title=ItemIDs A full list of all items, vehicles, and skin can be found here.]
Unpausing starts a countdown timer at 15 seconds before unpausing.


You can also run the ItemList command through Rcon to receive the most recent and up to date list of all items.
Minimum: 0


'''Game Modes:''' <br />
Maximum: 3600
DM        - Death Match <br />
|
KOTH      - King Of The Hill <br />
PauseMatch 60
GUN      - Gun Game <br />
|
OITC      - One In The Chamber <br />
"PauseTime": 60,
SND      - Search and Destroy <br />
"PauseMatch": true,
TANKTDM  - WW2 Team Death Match <br />
|-
TDM      - Team Death Match <br />
|RotateMap
TTT      - Trouble in Terrorist Town <br />
|none
WW2GUN    - WW2 Gun Game <br />
|Immediately changes the current map to the next map in the map rotation.
ZWV      - Zombie Wave Survival <br />
If the current map was changed to using <code>SwitchMap</code>, the next map will be the one after the previously switched map instead of the immediate map after the current one.
HIDE      - The Hidden <br />
|
INFECTION - Hidden Infection <br />
RotateMap
PUSH      - Push <br />
|
PH        - Prophunt <br />
"RotateMap": true,
----
|-
|ServerInfo
|none
|Returns server information such as server name, player count, current map and mode, and more.
|
ServerInfo
|
"ServerInfo":
{
  "MapLabel": "datacenter",
  "GameMode": "snd",
  "ServerName": "Server name",
  "Teams": true,
  "Team0Score": "4",
  "Team1Score": "1",
  "Round": "6",
  "RoundState": "Started",
  "PlayerCount": "8/10"
},
|-
|SetBalanceTableURL
|[GithubURL]
|Sets the balance table to load from the specified URL.
The URL has the format <code>user/repo/branch</code> and must contain a <code>BalancingTable.csv</code>. For example, the [https://github.com/vankruptgames/BalancingTable/blob/Beta_5.1/BalancingTable.csv official balancing table] has the URL <code>vankruptgames/BalancingTable/Beta_5.1</code>. Full URLs (eg. http://...) do not work.


=== Connecting to RCON ===
The balance table contains the values for the prices in the buy wheel, how much money is gained from which actions and how much damage is dealt by each weapon including damage falloff and more.


Make sure whatever port you used is open in your firewall for TCP connections. Connections are simple TCP port/telnet style connections.  
Writes to <code>BalanceTableURL</code> in <code>Game.ini</code>.
|
SetBalanceTableURL vankruptgames/BalancingTable/Beta_5.1
|
"GithubURL": "<nowiki>https://raw.githubusercontent.com/vankruptgames/BalancingTable/Beta_5.1</nowiki>",
"SetBalanceTableURL": true,
|-
|SetCash
|[UniqueID]
[CashAmount]
|Sets the cash of the specified player to the specified amount.
Minimum: 0


To test connecting to the rcon port and issuing simple commands use netcat or telnet:   
Maximum: 16000
<pre>nc {ip address} {port}</pre>
|
<pre>telnet {ip address} {port}</pre>
SetCash 12345678901234567 1000
|
"SetCash": true,
  "UniqueID": "12345678901234567",
|-
|SetLimitedAmmoType
|[AmmoType]
|Sets the ammo limitation type.
0 for unlimited, 1 for limited generic, 2 for limited specific, 3 for custom, 4 for limited special, 5 for boxless.


For the password use the md5 hash of the password in the file (this may change in the future). You can get this using <pre>echo -n password | md5sum</pre>
See [[Setting up a dedicated server#Configuring Game.ini|Limited Ammo Types]] for details.


If successful you should get an Authenticated=1 reply
Writes to <code>LimitedAmmoType</code> in <code>Game.ini</code>.
|
SetLimitedAmmoType 0
|
"SetLimitedAmmoType": true,
"LimitedAmmoType": "0",
|-
|SetMaxPlayers
|[Amount]
|Sets the amount of slots on the server to the specified amount.
Minimum: 1


Maximum: 24 (PCVR), 10 (Shack)


=== Tools available to access Rcon interface ===
Writes to <code>MaxPlayers</code> in <code>Game.ini</code>.
|
SetMaxPlayers 10
|
"SetMaxPlayers": true,
"MaxPlayers": 10,
|-
|SetPin
|[Optional PinNumber]
|Sets the server pin to the specified pin number.
Supplying a pin number locks the server so that player have to enter a pin to join.


A good first place to start is the RCON web interface run by ArcticVR. You do this at http://pavlovrcon.com/.  
Not supplying a pin number unlocks the server so that players do not have to enter a pin.


If you want private control of your server, you will need to do a bit more work for it. At the simplest, using netcat (nc) or telnet as described above will give you basic access to all commands
PinNumber can be any whole number between 1 and 9999 and may not contain leading zeroes such as <code>0001</code> which would get trimmed to <code>1</code>.


If you want to batch commands (i.e. for moving players on to teams and triggering ResetSnd) the following script can be useful to call a pre-written batch files of commands. Call with your batch file as the first argument to the script. The file should have one command per line with first line being the hashed password as above.
Setting the pin to <code>0</code> or <code>0000</code> does not remove the pin but sets it to <code>0</code>.
<pre>  
#!/bin/bash
function slowcat(){ while read; do sleep .05; echo "$REPLY"; done; }
cat  $1 | slowcat | nc {ip address} {port}
</pre>


Example batchfile:
Writes to <code>Password</code> in <code>Game.ini</code>.
<pre>
|
8b96753b29612d8c98d6b696140b5d9f
SetPin 69
ResetSnd
|
Disconnect
|-
</pre>
|SetPlayerSkin
|[UniqueID]
[SkinID]
|Sets the player skin of the specified player to the specified skin.
The skin is automatically removed if the player leaves the server, switches teams or upon map change.
|
SetPlayerSkin 12345678901234567 kevin
|
"SetPlayerSkin": true,
"UniqueID": "12345678901234567",
|-
|SetTimeLimit
|[Amount]
|Sets the time limit of the current match to the specified amount in seconds.
The match will end once the time limit has counted down to 0.
|
|'''Missing data, please rectify.'''
|-
|ShowNametags
|[True/False]
|Enables or disables name tags above friendly players.
|
ShowNametags true
|
"NametagsEnabled": true,
"ShowNametags": true,
|-
|ShutdownServer
|none
|Immediately shuts down the server.
|
ShutdownServer
|
|-
|Slap
|[UniqueID]
[Amount]
|Deals the specified amount of damage to the specified player. Can be lethal if the amount exceeds the current health of the player.
The damage is dealt directly to health and ignores armor.
|
Slap 12345678901234567
|
"UniqueID": "12345678901234567",
|-
|SwitchMap
|[MapID]
[GameMode]
|Immediately switches to the specified map and game mode.
TDM is automatically selected if no game mode has been specified.
|
SwitchMap datacenter snd
|
"SwitchMap": true,
|-
|SwitchTeam
|[UniqueID]
[TeamID]
|Kills and moves the specified player into the specified team.
It will be as if the player has just joined (that team) or if they switched themselves, losing all money, kills, deaths, assists, score and gear.
|
SwitchTeam 12345678901234567 1
|
"SwitchTeam": true,
"UniqueID": "12345678901234567",
|-
|Teleport
|[Source UniqueID]
[Target UniqueID]
|Teleports the specified source player to the position of the specified target player.
Only works when both the source player and the target player are alive.
|
Teleport 12345678901234567 12345678901234568
|
"MoveUniqueID": "12345678901234567",
"ToUniqueID": "12345678901234568",
"Teleport": true,
|-
|TTTAlwaysEnableSkinMenu
|[True/False]
|Trouble in Terrorist Town: Enables or disables the skin menu mid-round.
|
|
|-
|TTTEndRound
|[TeamID]
|Trouble in Terrorist Town: Ends the round.
|
|
|-
|TTTFlushKarma
|none
|Trouble in Terrorist Town: Resets the karma of all players to 1200.
|
|
|-
|TTTGiveCredits
|[UniqueID]
[Amount]
|Trouble in Terrorist Town: Adds the specified amount of TTT credits to the specified player.
|
|
|-
|TTTPauseTimer
|[True/False]
|Trouble in Terrorist Town: Pauses the timer.
|
|
|-
|TTTSetKarma
|[UniqueID]
[Amount]
|Trouble in Terrorist Town: Sets the karma of the specified player to the specified amount.
|
|
|-
|TTTSetRole
|[UniqueID]
[RoleID]
|Trouble in Terrorist Town: Sets the TTT role of the specified player to the specified role.
|
|
|-
|Unban
|[UniqueID]
|Unbans the specified player so that they can join again.
Writes the change to <code>blacklist.txt</code>.
|
Unban 12345678901234567
|
"Unban": true,
"UniqueID": "12345678901234567",
|-
|UpdateServerName
|[Name]
|Changes the server name to the specified name.
Writes to <code>ServerName</code> in <code>Game.ini</code>.
|
UpdateServerName My server name
|
"ServerName": "My server name",
"UpdateServerName": true,
|-
|UGCAddMod
|[UGCModID]
|Adds the mods to the server.
|
UGCAddMod UGC3267926
|'''Missing data, please rectify.'''
|-
|UGCClearModList
|
|Removes all mods from the server.
|
UGCClearModList
|'''Missing data, please rectify.'''
|-
|UGCModList
|
|Lists all mods currently on the server.
|
UGCModList
|'''Missing data, please rectify.'''
|-
|UGCRemoveMod
|[UGCModID]
|Removes specified mod from the server.
|
UGCRemoveMod UGC3267926
|'''Missing data, please rectify.'''
|}


----


<br>
== Connecting to RCON ==
<hr>
RCON uses a simple UTF-8 TCP text stream allowing for a multitude of ways to connect.


'''There is a very brief example above
=== Authentication ===
but it was not very detailed so i wanted to add a more detailed explanation'''
After connecting to RCON, the first message sent is by the server requesting the RCON password to be transmitted.


be aware that connecting and disconnecting a lot can hurt server performance
For this, the server sends a 10 byte message "<code>Password:</code> " (including the trailing space) to the client.


first you need to make a shell script
The client is expected to reply with the password as lowercase hex representation of the MD5 checksum of the password.
<pre>nano /home/steam/test.sh</pre>


<pre>#!/bin/bash
No line feed or carriage return character must be transmitted as part of the password.
function slowcat(){ while read; do sleep .15; echo "$REPLY"; done; }
cat $1 | slowcat | nc {SERVER IP} {SERVER RCON PORT}</pre>


now exit and save the test.sh
If the password is correct, the server will reply with <code>Authenticated=1\r\n</code> or if the password was incorrect, the reply will be <code>Authenticated=0\r\n</code>.


here will will make a batch file that will just hold the rcon password and cmds we want to issue
'''Example'''


<pre>nano /home/steam/batch</pre>
Authentication using the password "hello test".
<pre>{RCON PASSWORD CONVERTED TO MD5 HASH}
> Password:
{RCON CMD}
< 7a6d667ea5ed4467c017b2ed6ea07e78
{RCON CMD}
> Authenticated=1\r\n
Disconnect</pre>


here the first line has to be the rcon password converted to MD5 HASH
=== Sending commands and receiving replies ===
https://www.md5hashgenerator.com/
Any data sent to the server and terminated by a line feed character will be interpreted as a command and executed.
then each line after that u can use any rcon commands
the last line must be disconnect


now we need to give the sh permissions to run
This is followed by the server sending the corresponding command response in JSON format with new lines being indicated by a line feed character
<pre>sudo chmod +x /home/steam/test.sh</pre>


to run the bash script
The response is terminated with a carriage return and line feed.  
<pre>./home/steam/test.sh /home/steam/batch</pre>


so to run the script we need to ./ the .sh then after a space we need to pass the batch
'''Example'''


=== Rcon access from within VR ===
Executing the command <code>ServerInfo</code>.
< ServerInfo\n
> {\n\t"Command": "ServerInfo",\n\t"ServerInfo":\n\t{\n\t\t"MapLabel": "UGC2863450",\n\t\t"GameMode": "SND",\n\t\t"ServerName": "Server name",\n\t\t"Teams": true,\n\t\t"Team0Score": "0",\n\t\t"Team1Score": "3",\n\t\t"Round": "3",\n\t\t"RoundState": "Ended",\n\t\t"PlayerCount": "0/10"\n\t},\n\t"Successful": true\n}\r\n


PavlovRconWebserver, pavlov-vr-rcon and pavlov_rcon_tcl have been designed to be accessible within VR using virtual desktop view.
== Tools for connecting to RCON ==


=== Third party hosted tools ===
The easiest way to access RCON is to use a third party hosted tool. These are websites that take the RCON connection information and provide an RCON web interface.


'''pavlov_rcon_tcl''': This is a tool designed to run on your desktop for access within VR
'''Warning''': These tools may not be open source and can steal RCON passwords! Because they are hosted by third parties, it is impossible to verify that they do not.


https://github.com/Oakraven79/pavlov_rcon_tcl
* [https://pavlovrcon.com/ PavlovRCON.com]: A web-based RCON client
* [https://discord.com/oauth2/authorize?client_id=780880728992383077&scope=bot&permissions=199744 Horde Bot]: Discord bot specific to [[Hosting Providers|Horde servers]]


=== Third party local tools ===
These are programs that are downloaded and ran locally to provide an RCON interface.


'''PavlovRconWebserver''' is an interface designed to be usable from everywhere all the time. (also in VR over desktop view)
'''Warning''': If a tool is not open source it is not easily possible to verify that it does not steal RCON passwords. It is recommended to only use open source tools that can be verified.
<pre>Features:
Manage multiple Linux servers with multiple pavlov servers.
Start / Stop / Update
Public player lists
Do almost all rcon commands
Change the map rotation
Determine which users can do what via roles
Manage whitelists and blacklists
Integrate the player lists on all other websites
</pre>
<pre>Requirements:
Good Linux knowledge
SSH access to a linux server
</pre>


https://github.com/devinSpitz/PavlovRconWebserver
* [https://github.com/Oakraven79/pavlov_rcon_tcl pavlov_rcon_tcl]: Python based UI which is designed to be usable from within VR. Standalone executable. Requires editing of configuration files.
* [https://github.com/Krzychu81/pavlov-vr-rcon pavlov-vr-rcon]: node.js based web UI which is designed to be usable from within VR. Requires node.js.


While functional, the PavlovRconWebserver is still in development.
=== Third party self hosted tools ===
These are services that need to be self hosted.


If you do plan on using this tool, we recommend asking for help on the official Discord or http://discord.spitzen.solutions, or contacting the creator on the Github page (devinspitz) for the latest info on how to use it. Failing to do so will likely result in you breaking your servers.
'''Warning''': If a tool is not open source it is not easily possible to verify that it does not steal RCON passwords. It is recommended to only use open source tools that can be verified.


* [https://github.com/devinSpitz/PavlovRconWebserver PavlovRconWebserver]: Feature-rich all-in-one hosting solution.
* [https://github.com/Longoon12000/PterodactylPavlovServerController PPSC]: [https://pterodactyl.io/ Pterodactyl]-based feature-rich server management software. Requires the servers to run through Pterodactyl.
* [https://github.com/makupi/pavlov-bot pavlov-bot]: A bot that allows for using RCON through Discord.


'''pavlov-vr-rcon''': This is tool designed to run on your desktop for access from within VR with SND team setup
=== Direct connect ===
Since the RCON protocol is plain text TCP, direct connection terminals can be used to connect to RCON.


https://github.com/Krzychu81/pavlov-vr-rcon
==== Netcat ====
nc ip-or-domain.com port
'''Example'''
❯ nc myserver.com 9101
Password: 7a6d667ea5ed4467c017b2ed6ea07e78
Authenticated=1
ServerInfo
{
        "Command": "ServerInfo",
        "ServerInfo":
        {
                "MapLabel": "sand",
                "GameMode": "snd",
                "ServerName": "My server",
                "Teams": true,
                "Team0Score": "0",
                "Team1Score": "2",
                "Round": "2",
                "RoundState": "Started",
                "PlayerCount": "0/10"
        },
        "Successful": true
}
Disconnect
Goodbye


=== RCON access from Discord ===
==== Telnet ====
Telnet seems to prematurely flush the buffer when entering the password, causing authentication to fail.


For the ultimate in both control and complexity of setup, use the open-source '''pavlov-bot'''. This is a discord bot that will listen for commands in your discord and execute them. Supports all RCON commands with handy features such as discord role based authentication and authorisation, player, map and team aliases (No more SteamIDs or UGC####) and enhanced "all" and team based commands. Has support for flushing non-registered players from server. Advanced features to include alerting when servers are kicking off, team killing player kick/ban and large server (PUSH/RUSH/TankTDM) player balance (count) control.  
=== Libraries ===
These are libraries for developers to interface with RCON.


For '''shack''' users it has been updated to support Oculus ids and map aliases, so is fully functional for both server versions. See Readme.md for shack specific tweaks.  
* [https://github.com/Longoon12000/PavlovVR-Rcon PavlovVR-Rcon]: .net 7 library written in C#
* [https://github.com/kaylynn234/rcon rcon]: Python library
* [https://github.com/makupi/async-pavlov async-pavlov]: Asynchronous python library


https://github.com/makupi/pavlov-bot
==== Tips on developing apps to use RCON ====
It should be avoided to open a new connection for each command. It may cause performance issues.


'''Horde''' also offers a Discord Bot to grant RCON permissions to friends in Discord, and run commands from specific channels. Invite the Horde Bot to your Discord server with this link:
It should be avoided to send multiple commands directly one after the other without a delay of 100ms. It may cause commands to be dropped.
https://discord.com/oauth2/authorize?client_id=780880728992383077&scope=bot&permissions=199744


=== Tips on developing apps to use RCON ===
Commands are not executed during a map change.
What is important if you are issuing commands using a program at high frequency is that you open one connection and put all of the commands through that open connection with a small (.1 sec is fine) delay. What you don't want to do is open a new connection for each command or shove all of the commands through super fast. First causes performance issues and the second dropped commands.

Latest revision as of 09:38, 9 June 2024

RCON (Remote Console) is the method with which Pavlov VR servers can be controlled from outside of VR. It does not allow for reading server log messages.

RCON Commands

Placeholders

Values in [square brackets] are placeholders and must be replaced, or will be replaced by the server in a reply.

[UniqueID] - Player ID (eg. SteamID64 (PCVR), Oculus Username (Shack))

[GameMode] - See Gamemodes table and Gamemodes

[TeamID] - 0 for blue, 1 for red, if there are teams

[VehicleID] - See Vehicles

[MapName/ID] - See Default maps or find the Map ID on Mod.io and append it to "UGC" (Example: https://mod.io/g/pavlov/m/mcdonalds has Resource ID 2804322, the MapID to use would be UGC2804322)

[SkinID] - See Skins

[RoleID] - See TTT Roles

[ItemID] - See Items

[True/False] - Either "True" to enable or "False" to disable

[Amount] - A number indicating an amount of something

Reply format

All command replies are formatted as JSON and inherit this base format: 

{
	"Command": "[The command name]",
	"Comment": "[An optional comment about the command]",
	"Successful": "[True/False]"
}

Comment will not exist if the command does not output a comment.

Additional command output is added to the above format. The Example Reply column below only contains this additional command output.

Often, commands will contain a field with its own name and a boolean value. This is a very inconsistent value. For example in SetMaxPlayers, if the amount is set to the same as the current slot count, Successful will be true but SetMaxPlayers will be false. However for SwitchTeam for example, if a player is switched to the same team they are already in, SwitchTeam will be true anyway.

Commands

RCON Commands
Command Parameters Description Example Command Example Reply
Help none Returns the full list of commands and their parameters 
Help

"Help": [
  "AddMapRotation MapID GameMode",
  ...truncated...
  "UpdateServerName ServerName"
],
AddMapRotation [MapName/ID]

[GameMode]

Adds the specified map with the specified game mode to the bottom of the map rotation.

Writes the map to Game.ini. 

AddMapRotation sand snd
AddMod [UniqueID] Adds the specified player to the moderator list, making them an admin.

Allows them to use the admin menu in the pause menu and be immune to being vote-kicked.

Writes the player to mods.txt. 

AddMod 12345678901234567

"AddMod": true,
"UniqueID": "12345678901234567",
Ban [UniqueID] Kicks and permanently bans the specified player from the server. They will not be able to join the server anymore.

Writes the player to blacklist.txt. 

Ban 12345678901234567

"Ban": true,
"UniqueID": "12345678901234567",
Banlist none Lists the currently banned player UniqueIDs from blacklist.txt. 
Banlist

"BanList": [
  "12345678901234567",
  "12345678901234568",
  ...truncated...
  "12345678901234569"
],
ClearEmptyVehicles none Removes all vehicles that are not occupied by a player. 
ClearEmptyVehicles
Disconnect none Forces the server to closes the RCON connection. 
Disconnect

Goodbye
EnableCompMode [True/False] Enables or disables competitive mode.

Comment: Comp mode will be changed on map rotation, this updates the config value

Writes to bCompetitive in Game.ini. 

EnableCompMode true

"CompModeState": true,
"EnableCompMode": true,
EnableVerboseLogging [True/False] Enables or disables verbose logging.

Writes to bVerboseLogging in Game.ini. 

EnableVerboseLogging false

"VerboseLoggingState": false,
"EnableVerboseLogging": true,
EnableWhitelist [True/False] Enables or disables whitelist usage.

When enabled, only players who are listed in whitelist.txt can join the server.

Writes to bWhitelist in Game.ini. 

"WhitelistState": true,
"EnableWhitelist": true,
Gag [UniqueID]

[True/False]

Gags or ungags the specified player.

When gagged, players can not use voice chat. 

"Gag": true,
"UniqueID": "12345678901234567",
GiveAll [TeamID]

[ItemID]

Gives an item to all players on a team.

The GiveItem RCON command description elaborates on how items are placed onto the body of the player. 

"GiveAll": true,
"TeamID": "1",
"ItemID": "galul",
GiveCash [UniqueID]

[CashAmount]

Gives the specified amount of cash to the specified player. 
GiveCash 12345678901234567 200

"GiveCash": true,
"UniqueID": "12345678901234567",
GiveItem [UniqueID]

[ItemID]

Equippes the specified item to the specified player to the corresponding item slot.

Primary guns are placed into the players main hand, replacing the held gun, which will drop.

Secondary guns are placed onto the players hip, replacing the holstered gun, which will drop.

Utilities will be placed onto the players chest slots until all slots are full, which will cause given items to be dropped instead. 

GiveItem 12345678901234567 syringe

"GiveItem": true,
"UniqueID": "12345678901234567",
GiveTeamCash [TeamID]

[CashAmount]

Adds the specified amount of cash to each member of the specified team. 
GiveTeamCash 0 200

"GiveTeamCash": true,
"TeamID": "0",
InspectAll none Returns a list of InspectPlayer blocks for all players on the server. 
InspectAll

"InspectList": [
  {
    "PlayerName": "Username",
    "UniqueId": "12345678901234567",
    "KDA": "3/1/2",
    "Score": "50",
    "Dead": false,
    "Cash": "3450",
    "TeamId": "1",
    "Ping": 39.857143402099609,
    "Gag": false
  },
  ...truncated...
],
InspectPlayer [UniqueID] Returns a detailed status for the specified player.

The player must be listed in RefreshList. 

InspectPlayer 12345678901234567

"PlayerInfo":
{

 "PlayerInfo":
{
  "PlayerName": "Username",
  "UniqueId": "12345678901234567",
  "KDA": "3/1/2",
  "Score": "50",
  "Dead": false,
  "Cash": "3450",
  "TeamId": "1",
  "Ping": 39.857143402099609,
  "Gag": false
},
InspectTeam [TeamID] Returns a list of InspectPlayer blocks for all player on the specified team. 
InspectTeam 1

"InspectList": [
  {
    "PlayerName": "Username",
    "UniqueId": "12345678901234567",
    "KDA": "3/1/2",
    "Score": "50",
    "Dead": false,
    "Cash": "3450",
    "TeamId": "1",
    "Ping": 39.857143402099609,
    "Gag": false
  },
  ...truncated...
],
ItemList none Lists all items in the game and the current map.

Custom items built into the map will be listed. 

ItemList

"ItemList": [
  "1911",
  "57",
  "acog",
  "adrenaline",
  ...truncated...
  "ww2knife",
  "ww2medkit",
  "ww2painkillers",
  "ww2syringe"
],
Kick [UniqueID] Kicks the specified player from the server. 
Kick 12345678901234567

"UniqueID": "12345678901234567",
"Kick": true,
Kill [UniqueID] Kills the specified player. 
Kill 12345678901234567

"UniqueID": "12345678901234567",
"Kill": true,
MapList none Returns the current map rotation from Game.ini. 
MapList

"MapList": [
  {
    "MapId": "UGC2863450",
    "GameMode": "SND"
  },
  ...truncated...
  {
    "MapId": "sand",
    "GameMode": "snd"
  }
],
ModeratorList none Returns a list of UniqueIDs of all moderators from mods.txt. 
ModeratorList

"ModeratorList": [
  "12345678901234567",
  ...truncated...
  "12345678901234568"
],
RefreshList none Returns a list of all connected player names and their corresponding UniqueIDs. 
RefreshList

"PlayerList": [
  {
    "Username": "Username",
    "UniqueId": "12345678901234567"
  },
  ...truncated...
  {
    "Username": "Username2",
    "UniqueId": "12345678901234568"
  }
],
RemoveMapRotation [MapName/ID]

[GameMode]

Removes the first occurrence of the specified map and game mode combination from the map rotation.

[MapName/ID] and [GameMode] are case sensitive to the entries in Game.ini or MapList respectively.

Writes the change to Game.ini. 

RemoveMapRotation sand snd
RemoveMod [UniqueID] Removes the specified player from the moderator list.

Writes the change to mods.txt. 

RemoveMod 12345678901234567

"RemoveMod": true,
"UniqueID": "12345678901234567",
ResetSND none Reset the currently running SND match.

All players will have starting cash, no kills, deaths, assists or score.

All players are killed.

The score is reset to 0 all. 

ResetSND

"ResetSND": true,
PauseMatch [Optional Amount] Pauses the currently running match for the specified amount of seconds.

The game is frozen and displays a "Game is paused" countdown timer.

The game is unpaused when amount is not specified or 0.

Unpausing starts a countdown timer at 15 seconds before unpausing.

Minimum: 0

Maximum: 3600 

PauseMatch 60

"PauseTime": 60,
"PauseMatch": true,
RotateMap none Immediately changes the current map to the next map in the map rotation.

If the current map was changed to using SwitchMap, the next map will be the one after the previously switched map instead of the immediate map after the current one. 

RotateMap

"RotateMap": true,
ServerInfo none Returns server information such as server name, player count, current map and mode, and more. 
ServerInfo

"ServerInfo":
{
  "MapLabel": "datacenter",
  "GameMode": "snd",
  "ServerName": "Server name",
  "Teams": true,
  "Team0Score": "4",
  "Team1Score": "1",
  "Round": "6",
  "RoundState": "Started",
  "PlayerCount": "8/10"
},
SetBalanceTableURL [GithubURL] Sets the balance table to load from the specified URL.

The URL has the format user/repo/branch and must contain a BalancingTable.csv. For example, the official balancing table has the URL vankruptgames/BalancingTable/Beta_5.1. Full URLs (eg. http://...) do not work.

The balance table contains the values for the prices in the buy wheel, how much money is gained from which actions and how much damage is dealt by each weapon including damage falloff and more.

Writes to BalanceTableURL in Game.ini. 

SetBalanceTableURL vankruptgames/BalancingTable/Beta_5.1

"GithubURL": "https://raw.githubusercontent.com/vankruptgames/BalancingTable/Beta_5.1",
"SetBalanceTableURL": true,
SetCash [UniqueID]

[CashAmount]

Sets the cash of the specified player to the specified amount.

Minimum: 0

Maximum: 16000 

SetCash 12345678901234567 1000

"SetCash": true,
"UniqueID": "12345678901234567",
SetLimitedAmmoType [AmmoType] Sets the ammo limitation type.

0 for unlimited, 1 for limited generic, 2 for limited specific, 3 for custom, 4 for limited special, 5 for boxless.

See Limited Ammo Types for details.

Writes to LimitedAmmoType in Game.ini. 

SetLimitedAmmoType 0

"SetLimitedAmmoType": true,
"LimitedAmmoType": "0",
SetMaxPlayers [Amount] Sets the amount of slots on the server to the specified amount.

Minimum: 1

Maximum: 24 (PCVR), 10 (Shack)

Writes to MaxPlayers in Game.ini. 

SetMaxPlayers 10

"SetMaxPlayers": true,
"MaxPlayers": 10,
SetPin [Optional PinNumber] Sets the server pin to the specified pin number.

Supplying a pin number locks the server so that player have to enter a pin to join.

Not supplying a pin number unlocks the server so that players do not have to enter a pin.

PinNumber can be any whole number between 1 and 9999 and may not contain leading zeroes such as 0001 which would get trimmed to 1.

Setting the pin to 0 or 0000 does not remove the pin but sets it to 0.

Writes to Password in Game.ini. 

SetPin 69
SetPlayerSkin [UniqueID]

[SkinID]

Sets the player skin of the specified player to the specified skin.

The skin is automatically removed if the player leaves the server, switches teams or upon map change. 

SetPlayerSkin 12345678901234567 kevin

"SetPlayerSkin": true,
"UniqueID": "12345678901234567",
SetTimeLimit [Amount] Sets the time limit of the current match to the specified amount in seconds.

The match will end once the time limit has counted down to 0.

Missing data, please rectify.
ShowNametags [True/False] Enables or disables name tags above friendly players. 
ShowNametags true

"NametagsEnabled": true,
"ShowNametags": true,
ShutdownServer none Immediately shuts down the server. 
ShutdownServer
Slap [UniqueID]

[Amount]

Deals the specified amount of damage to the specified player. Can be lethal if the amount exceeds the current health of the player.

The damage is dealt directly to health and ignores armor. 

Slap 12345678901234567 

"UniqueID": "12345678901234567",
SwitchMap [MapID]

[GameMode]

Immediately switches to the specified map and game mode.

TDM is automatically selected if no game mode has been specified. 

SwitchMap datacenter snd

"SwitchMap": true,
SwitchTeam [UniqueID]

[TeamID]

Kills and moves the specified player into the specified team.

It will be as if the player has just joined (that team) or if they switched themselves, losing all money, kills, deaths, assists, score and gear. 

SwitchTeam 12345678901234567 1

"SwitchTeam": true,
"UniqueID": "12345678901234567",
Teleport [Source UniqueID]

[Target UniqueID]

Teleports the specified source player to the position of the specified target player.

Only works when both the source player and the target player are alive. 

Teleport 12345678901234567 12345678901234568

"MoveUniqueID": "12345678901234567",
"ToUniqueID": "12345678901234568",
"Teleport": true,
TTTAlwaysEnableSkinMenu [True/False] Trouble in Terrorist Town: Enables or disables the skin menu mid-round.
TTTEndRound [TeamID] Trouble in Terrorist Town: Ends the round.
TTTFlushKarma none Trouble in Terrorist Town: Resets the karma of all players to 1200.
TTTGiveCredits [UniqueID]

[Amount]

Trouble in Terrorist Town: Adds the specified amount of TTT credits to the specified player.
TTTPauseTimer [True/False] Trouble in Terrorist Town: Pauses the timer.
TTTSetKarma [UniqueID]

[Amount]

Trouble in Terrorist Town: Sets the karma of the specified player to the specified amount.
TTTSetRole [UniqueID]

[RoleID]

Trouble in Terrorist Town: Sets the TTT role of the specified player to the specified role.
Unban [UniqueID] Unbans the specified player so that they can join again.

Writes the change to blacklist.txt. 

Unban 12345678901234567

"Unban": true,
"UniqueID": "12345678901234567",
UpdateServerName [Name] Changes the server name to the specified name.

Writes to ServerName in Game.ini. 

UpdateServerName My server name

"ServerName": "My server name",
"UpdateServerName": true,
UGCAddMod [UGCModID] Adds the mods to the server. 
UGCAddMod UGC3267926
Missing data, please rectify.
UGCClearModList Removes all mods from the server. 
UGCClearModList
Missing data, please rectify.
UGCModList Lists all mods currently on the server. 
UGCModList
Missing data, please rectify.
UGCRemoveMod [UGCModID] Removes specified mod from the server. 
UGCRemoveMod UGC3267926
Missing data, please rectify.

Connecting to RCON

RCON uses a simple UTF-8 TCP text stream allowing for a multitude of ways to connect.

Authentication

After connecting to RCON, the first message sent is by the server requesting the RCON password to be transmitted.

For this, the server sends a 10 byte message "Password: " (including the trailing space) to the client.

The client is expected to reply with the password as lowercase hex representation of the MD5 checksum of the password.

No line feed or carriage return character must be transmitted as part of the password.

If the password is correct, the server will reply with Authenticated=1\r\n or if the password was incorrect, the reply will be Authenticated=0\r\n.

Example

Authentication using the password "hello test". 

> Password: 
< 7a6d667ea5ed4467c017b2ed6ea07e78
> Authenticated=1\r\n

Sending commands and receiving replies

Any data sent to the server and terminated by a line feed character will be interpreted as a command and executed.

This is followed by the server sending the corresponding command response in JSON format with new lines being indicated by a line feed character

The response is terminated with a carriage return and line feed.

Example

Executing the command ServerInfo. 

< ServerInfo\n
> {\n\t"Command": "ServerInfo",\n\t"ServerInfo":\n\t{\n\t\t"MapLabel": "UGC2863450",\n\t\t"GameMode": "SND",\n\t\t"ServerName": "Server name",\n\t\t"Teams": true,\n\t\t"Team0Score": "0",\n\t\t"Team1Score": "3",\n\t\t"Round": "3",\n\t\t"RoundState": "Ended",\n\t\t"PlayerCount": "0/10"\n\t},\n\t"Successful": true\n}\r\n

Tools for connecting to RCON

Third party hosted tools

The easiest way to access RCON is to use a third party hosted tool. These are websites that take the RCON connection information and provide an RCON web interface.

Warning: These tools may not be open source and can steal RCON passwords! Because they are hosted by third parties, it is impossible to verify that they do not.

Third party local tools

These are programs that are downloaded and ran locally to provide an RCON interface.

Warning: If a tool is not open source it is not easily possible to verify that it does not steal RCON passwords. It is recommended to only use open source tools that can be verified.

  • pavlov_rcon_tcl: Python based UI which is designed to be usable from within VR. Standalone executable. Requires editing of configuration files.
  • pavlov-vr-rcon: node.js based web UI which is designed to be usable from within VR. Requires node.js.

Third party self hosted tools

These are services that need to be self hosted.

Warning: If a tool is not open source it is not easily possible to verify that it does not steal RCON passwords. It is recommended to only use open source tools that can be verified.

  • PavlovRconWebserver: Feature-rich all-in-one hosting solution.
  • PPSC: Pterodactyl-based feature-rich server management software. Requires the servers to run through Pterodactyl.
  • pavlov-bot: A bot that allows for using RCON through Discord.

Direct connect

Since the RCON protocol is plain text TCP, direct connection terminals can be used to connect to RCON.

Netcat

nc ip-or-domain.com port

Example 

❯ nc myserver.com 9101
Password: 7a6d667ea5ed4467c017b2ed6ea07e78
Authenticated=1
ServerInfo
{
        "Command": "ServerInfo",
        "ServerInfo":
        {
                "MapLabel": "sand",
                "GameMode": "snd",
                "ServerName": "My server",
                "Teams": true,
                "Team0Score": "0",
                "Team1Score": "2",
                "Round": "2",
                "RoundState": "Started",
                "PlayerCount": "0/10"
        },
        "Successful": true
}
Disconnect
Goodbye

Telnet

Telnet seems to prematurely flush the buffer when entering the password, causing authentication to fail.

Libraries

These are libraries for developers to interface with RCON.

Tips on developing apps to use RCON

It should be avoided to open a new connection for each command. It may cause performance issues.

It should be avoided to send multiple commands directly one after the other without a delay of 100ms. It may cause commands to be dropped.

Commands are not executed during a map change.

Retrieved from "http://pavlovwiki.com/index.php?title=Rcon_Overview_and_Commands&oldid=1005"