User:Rain/Sandbox: Difference between revisions

From Pavlov VR Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
RCON (Remote Console) is the method Pavlov VR servers can be controlled from outside of VR.
'''TODO: Rename the page to "Dedicated server" because THIS IS NOT A GUIDE!'''


== RCON Tools ==
== Hosting ==
- <nowiki>http://pavlovrcon.com/</nowiki>


- TBD: add more
'''There are no Windows binaries'''
=== Server requirements ===
'''OS''': Linux (Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working)


== RCON Commands ==
'''Memory''': 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex game modes.


'''Hypothesis: PSVR and Shack players can not crossplay-connect to dedicated servers. Requires confirmation.'''
'''CPU''': A ~2.5Ghz CPU will comfortably support a 10 player server. A ~4Ghz CPU will comfortably support 24 players.  


'''Placeholder'''
'''Note''': These are '''not''' hard limits for requirements, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.


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


[UniqueID] - Player ID (eg. SteamID (PCVR), ??? (Shack))
=== Software dependencies ===


[GameMode] - See [Gamemodes]
* gdb (TODO: do you actually need gdb to run a server? wtf?)
* curl (TODO: do you actually need curl to run a server? does pavlov download stuff using curl?)
* lib32gcc1(-s1)
* libc++-dev


[TeamID] - 0 for blue, 1 for red, if there are teams
=== SteamCMD ===
The app ID for Pavlov VR dedicated servers is <code>622970</code>.


[VehicleID] - See [Vehicles]
Instructions on how to use SteamCMD are available in the [https://developer.valvesoftware.com/wiki/SteamCMD Valve Developer Community Wiki].


[MapName/ID] - See [Default maps] or find the Map ID on Mod.io (put example)
To host '''Shack Live''' (Quest) use <code>-beta shack</code>, to host '''Shack RC''' (Quest) use <code>-beta shack_beta</code>.


[SkinID] - See [Skins]
Update 29 of the PCVR version of Pavlov VR dedicated servers require you to completely break your system:
<code>sudo rm /usr/lib/x86_64-linux-gnu/libc++.so</code>
<code>sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so</code>


[RoleID] - See [TTT Roles]
'''TODO: By all that is good and fair, modifying system files like this for one piece of software is unacceptable. This can be done in a different, less intrusive way.'''


[ItemID] - See [Items]
== Configuration ==


[True/False] - Either "True" to enable or "False" to disable
=== Moderators, Blacklist, Whitelist ===
The following three files allow you to specify moderators, banned players, and whitelist players.


[Amount] - A number indicating an amount of something
They are required to be able to use <code>AddMod</code>, <code>Ban</code>, <code>Banlist</code>, <code>ModeratorList</code>, <code>RemoveMod</code> and <code>Unban</code> [[Rcon Overview and Commands|RCON commands]] but are otherwise optional.


'''Format'''
<pre>
Pavlov/Saved/Config/mods.txt
Pavlov/Saved/Config/blacklist.txt
Pavlov/Saved/Config/whitelist.txt
</pre>'''TODO: Describe the file contents, give examples.'''


All command replies are formatted as JSON and inherit this base format:
=== Game.ini ===
{
This file contains the majority of server configuration keys.
"Command": "[The command you entered]",
It is automatically created when first starting a server, it can also be created manually. <pre>
"Comment": "[An optional comment about the command]",
Pavlov/Saved/Config/LinuxServer/Game.ini
"Successful": "[True/False]"
</pre>
}
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 their 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> is true anyway.
==== Keys ====
{| class="wikitable"
{| class="wikitable"
|+RCON Commands
|+Game.ini keys
!Command
!Key
!Parameters
!Allowed values
!Default value
!Description
!Description
!Example Command
!Example Reply
|-
|-
|Help
|bEnabled
|none
|<code>True</code><code>False</code>
|Returns the full list of commands and their parameters
|<code>True</code>
|
|Enables or disables registering with the master server to show or hide the server from the server list
Help
'''TODO: confirm that this is true''', and why is this even a thing, you can't direct connect to servers anyways...
|
"Help": [
  "AddMapRotation MapID GameMode",
  ...truncated...
  "UpdateServerName ServerName"
],
|-
|-
|AddMapRotation
|ServerName
|[MapName/ID]
|Any ASCII text value up to 35 characters
[GameMode]
|<code>DedicatedServer</code>
|Adds the specified map with the specified game mode to the bottom of the map rotation.
|Sets the name with which the server will be listed as
Writes the map to <code>Game.ini</code>.
'''TODO: confirm exact maximum character limit and which characters are allowed (utf8? unicode?)'''
|
AddMapRotation sand snd
|
|-
|-
|AddMod
|MaxPlayers
|[UniqueID]
|Integer
|Adds the specified player to the moderator list, making them an admin.
Maximum 10 for Shack, 24 for PC.
Allows them to use the admin menu in the pause menu and be immune to being vote-kicked.
|<code>10</code>
 
|Sets the amount of available player slots
Writes the player to <code>mods.txt</code>.
|
AddMod 12345678901234567
|
"AddMod": true,
"UniqueID": "12345678901234567",
|-
|-
|Ban
|ApiKey
|[UniqueID]
|Obsolete, leave empty.
|Kicks and permanently bans the specified player from the server. They will not be able to join the server anymore.
Writes the player to <code>blacklist.txt</code>.
|
|
Ban 12345678901234567
|
|
"Ban": true,
"UniqueID": "12345678901234567",
|-
|-
|Banlist
|bSecured
|none
|<code>True</code><code>False</code>
|Lists the currently banned player UniqueIDs from <code>blacklist.txt</code>.
|<code>True</code>
|
|Enables or disables Valve Anti-Cheat (VAC)
Banlist
|
"BanList": [
  "12345678901234567",
  "12345678901234568",
  ...truncated...
  "12345678901234569"
],
|-
|-
|Disconnect
|bCustomServer
|none
|<code>True</code><code>False</code>
|Closes the RCON connection.
|<code>True</code>
This should always be used when done.
|Enables or disables "some new modding tools". Save and HTTP functions.
 
Required to write to <code>blacklist.txt</code> for bans.
'''TODO: This is probably not true and there is no disadvantage to just disconnecting. Needs clarification from dev.'''
'''TODO: specify exactly what those new modding tools are.'''
|
Disconnect
|
|-
|-
|EnableCompMode
|bCompetitive
|[True/False]
|<code>True</code><code>False</code>
|Enables or disables competitive mode.
|<code>False</code>
'''Comment''': Comp mode will be changed on map rotation, this updates the config value
|Enables or disables competitive mode for SND
Writes to <code>bCompetitive</code> in <code>Game.ini</code>.
|
EnableCompMode true
|
"CompModeState": true,
"EnableCompMode": true,
|-
|-
|EnableVerboseLogging
|bVerboseLogging
|[True/False]
|<code>True</code><code>False</code>
|<code>False</code>
|Enables or disables verbose logging.
|Enables or disables verbose logging.
Writes to <code>bVerboseLogging</code> in <code>Game.ini</code>.
Verbose logging mostly consists of [[Setting up a dedicated server#Verbose Logging|detailed statistics]].
|
This will significantly increase logging.
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.
Writes to <code>bWhitelist</code> in <code>Game.ini</code>.
|
|
"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.
|
|'''TODO: Couldn't get to execute, always Succesful: false'''
|-
|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.
'''TODO: Test for dropping when slot is occupied. Primary weapons are put directly into players hands, old weapon is dropped if hands are full.'''
'''Utilities are put on the chest. Are new items dropped when chest is full?What about secondary?'''
|
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.
'''TODO: test if it really returns from game.ini or if it returns from memory.'''
|
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
|bWhitelist
|[MapName/ID]
|<code>True</code><code>False</code>
[GameMode]
|<code>False</code>
|Removes the first occurrence of the specified map and game mode combination from the map rotation.
|Enables or disables usage of the whitelist, allowing only users in <code>whitelist.txt</code> to join
[MapName/ID] and [GameMode]  are case sensitive to the entries in <code>Game.ini</code> or <code>MapList</code> respectively.
Writes the change to <code>Game.ini</code>.
|
RemoveMapRotation sand snd
|
|-
|-
|RemoveMod
|RefreshListTime
|[UniqueID]
|Integer, seconds
|Removes the specified player from the moderator list.
|<code>10</code>
Writes the change to <code>mods.txt</code>.
|Sets the interval at which the server reads changes from <code>mods.txt</code>, <code>blacklist.txt</code> and <code>whitelist.txt</code>
|
RemoveMod 12345678901234567
|
"RemoveMod": true,
"UniqueID": "12345678901234567",
|-
|-
|ResetSND
|LimitedAmmoType
|none
|Integer, Type ID
|Reset the currently running SND match.
|<code>1</code>
All players will have starting cash, no kills, deaths, assists or score.
|Sets the limited ammo type, see [[Setting up a dedicated server#Limited Ammo Types|Limited Ammo Types]]
All players are killed.
The score is reset to 0 all.
|
ResetSND
|
"ResetSND": true,
|-
|-
|PauseMatch
|TimeLimit
|[Optional Amount]
|Integer, minutes
|Pauses the currently running match for the specified amount of seconds.
|<code>60</code>
The game is frozen and displays a "Game is paused" countdown timer.
|Sets the time limit for each map
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
'''TODO: What does pausing do? Can you unpause using this command? (eg. PauseMatch 0 or just PauseMatch)'''
|
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 <code>SwitchMap</code>, the next map will be the one after the previously switched map instead of the immediate map after the current one.
'''TODO: Test if this ends match or changes immediately.'''
|
RotateMap
|
"RotateMap": true,
|-
|-
|ServerInfo
|TickRate
|none
|Integer, ticks per second
|Returns server information such as server name, player count, current map and mode, and more.
Recommended between 50 and 120
|
|<code>90</code>
ServerInfo
|Sets the rate at which the server processes and updates game state information and network events.
|
Changes weapon de-spawn time and breaks some game modes. Recommended to leave at default value.
"ServerInfo":
'''TODO: what game modes? breaks how? needs clarification.'''
{
  "MapLabel": "datacenter",
  "GameMode": "snd",
  "ServerName": "Server name",
  "Teams": true,
  "Team0Score": "4",
  "Team1Score": "1",
  "Round": "6",
  "RoundState": "Started",
  "PlayerCount": "8/10"
},
|-
|-
|SetBalanceTableURL
|Password
|[GithubURL]
|Integer, 1 to 4 digit pin
|Sets the balance table to load from the specified URL.
|<code>0000</code>
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>.
|Sets the server PIN that is required to be entered before being able to join the server.
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 <code>BalanceTableURL</code> in <code>Game.ini</code>.
'''TODO: Test if full github urls (eg. https://...) work.'''
|
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
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 Type] for details.
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: 50 (PCVR), 10 (Shack)
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.
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 <code>0001</code> which would get trimmed to <code>1</code>.
Setting the pin to <code>0</code> or <code>0000</code> does not remove the pin but sets it to <code>0</code>.
Setting the pin to <code>0</code> or <code>0000</code> does not remove the pin but sets it to <code>0</code>.
 
Commenting out or leaving the value empty will remove the pin.
Writes to <code>Password</code> in <code>Game.ini</code>.
|
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 or switches teams.
'''TODO: Test if there are other conditions where the skin is removed.'''
|
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.
|
|'''TODO: Couldn't get to execute, always Succesful: false'''
|-
|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
|BalanceTableURL
|[True/False]
|Text formatted as <code>user/repository/branch</code>
|Trouble in Terrorist Town: Enables or disables the skin menu mid-round.
|<code>vankruptgames/BalancingTable/main</code>
|
|Sets the balance table Git URL to be used by the server.
|
See [https://github.com/vankruptgames/BalancingTable Balancing Table] for instructions.
|-
|-
|TTTEndRound
|AFKTimeLimit
|[TeamID]
|Integer, seconds
|Trouble in Terrorist Town: Ends the round.
|<code>60</code>
|
|Sets the maximum amount of time a player can be idle before being automatically kicked.
|
Setting this to <code>0</code> will disable AFK kicking.
'''TODO: Pretty sure this is incorrect, while testing I've set it to 0 and got kicked nonetheless. Only being moderator prevents afk kicking. Requires further testing.'''
|-
|-
|TTTFlushKarma
|bInitialized
|none
|<code>True</code><code>False</code>
|Trouble in Terrorist Town: Resets the karma of the specified player.
|<code>False</code>
'''TODO: According to <code>Help</code> this command does not take any parameters. Previous wiki entries specified [UniqueID] as parameter. Verify whether or not there's a parameter for this command. Send bug report to Dave.'''
|'''TODO: What does this do?'''
|
|
|-
|-
|TTTGiveCredits
|DepotURL
|[UniqueID]
[Amount]
|Trouble in Terrorist Town: Adds the specified amount of credits to the specified player.
'''TODO: Are credits and cash two different things?'''
|
|
|
|
|'''TODO: What does this do?'''
|-
|-
|TTTPauseTimer
|bBroadcast
|[True/False]
|<code>True</code><code>False</code>
|Trouble in Terrorist Town: Pauses the timer.
|<code>True</code>
|
|Probably enables or disables broadcasting to pavtv?
|
'''TODO: What does this do?'''
|-
|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: Currently broken.
'''TODO: Test if still broken or if this does something now.'''
|
|
|-
|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,
|}
|}
'''TODO: Verify all default values, right now I'm just guessing'''


'''TODO: Sort alphabetically'''
For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.
==== Limited Ammo Types ====
{| class="wikitable"
{| class="wikitable"
|+Limited Ammo Types
|+
!AmmoType
!AmmoType
!Name
!Name
Line 650: Line 194:
|Players carry ammo boxes with a limited amount of ammo.
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).
One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).
Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.
Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.
An ammo count is displayed on the wrist.
An ammo count is displayed on the wrist.
|-
|-
Line 657: Line 203:
|Players carry ammo boxes with a limited amount of ammo.
|Players carry ammo boxes with a limited amount of ammo.
One box for each weapon.
One box for each weapon.
Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.
Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.
An ammo count is displayed on the wrist.
An ammo count is displayed on the wrist.
|-
|-
Line 665: Line 213:
|-
|-
|4
|4
|Limited Special
| Limited Special
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''
|'''All weapons except "special" weapons are unlimited, more clarification is needed.'''  
|-
|-
|5
|5
Line 672: Line 220:
|'''Like limited generic but without boxes? Clarification is needed.'''
|'''Like limited generic but without boxes? Clarification is needed.'''
|}
|}
'''TODO: This definitely belongs on a whole different page as ammo types are not specific to RCON.'''
 
==== Map rotation ====
The map rotation is defined in the <code>Game.ini</code>.
 
Upon server start, the first map in the rotation will be started.
 
When a map has ended, the next map in the rotation will be started.
 
When the end of the rotation has been reached, it will start from the beginning again.
 
Mod.io maps will be downloaded and updated automatically, if required, when they are rotated to.
 
Each entry requires a separate line of the following format:<pre>
MapRotation=(MapId="Name or ID", GameMode="Game Mode")
</pre><code>Name or ID</code>: 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>)
 
<code>Game Mode</code>: See [[Gamemodes|Game Modes]].
{| class="wikitable"
{| class="wikitable"
|+Game modes
|+Game modes
!GameMode
!GameMode  
!Name
!Name
!Description
|-
|-
|DM
|DM
|Death match
|Death match
|
|-
|-
|KOTH
|KOTH
|King of the hill
|King of the hill
|
|-
|-
|GUN
|GUN
|Gun game
| Gun game
|
|-
|-
|OITC
|OITC
|One in the chamber
| One in the chamber
|
|-
|-
|SND
|SND
|Search and destroy
|Search and destroy
|
|-
|-
|TANKTDM
|TANKTDM
|WW2 Team Death Match
|WW2 Team Death Match
'''TODO: WTF?'''
|
|-
|-
|TDM
| TDM
|Team Death Match
|Team Death Match
|
|-
|-
|TTT
|TTT
|Trouble in Terrorist Town
|Trouble in Terrorist Town
|
|-
|-
|WW2GUN
|WW2GUN
|WW2 gun game
|WW2 gun game
|
|-
|-
|ZWV
|ZWV
|Zombie wave survival
| Zombie wave survival
|
|-
|-
|HIDE
|HIDE
|The Hidden
|The Hidden  
|
|-
|-
|INFECTION
|INFECTION
|Hidden infection
|Hidden infection
|
|-
|-
|PUSH
|PUSH
|Push
|Push
|
|-
|-
|PH
|PH
|Prop hunt
|Prop hunt
|
|}
|}
'''TODO: This definitely belongs on a whole different page as game modes are not specific to RCON.'''
'''TODO: move this to game modes page.'''


'''TODO: Check and update list of game modes against latest update.'''
==== Example ====
<pre>
[/Script/Pavlov.DedicatedServer]
# This is a comment
bEnabled=True
ServerName=Your server
MaxPlayers=10
bSecured=True
bCustomServer=True
bWhitelist=False
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
Password=1234
bInitialized=False
DepotURL=
ApiKey=
bCompetitive=False
bBroadcast=True
BalanceTableURL=vankruptgames/BalancingTable/Beta_5.1
bVerboseLogging=True
AFKTimeLimit=0


----
MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="UGC3094680", GameMode="SND")
MapRotation=(MapId="UGC2996823", GameMode="SND")
MapRotation=(MapId="sand", GameMode="SND")
MapRotation=(MapId="UGC2841131", GameMode="SND")
MapRotation=(MapId="UGC2829349", GameMode="SND")
MapRotation=(MapId="container", GameMode="SND")
MapRotation=(MapId="UGC2844898", GameMode="SND")
MapRotation=(MapId="UGC2804502", GameMode="SND")
</pre>


=== Connecting to RCON ===
=== RCON ===
The RCON password and port are configured in <code>RconSettings.txt</code>. If the file does not exist or if the values in it are empty, no RCON will be provided.<pre>
Pavlov/Saved/Config/RconSettings.txt
</pre>


Make sure whatever port you used is open in your firewall for TCP connections. Connections are simple TCP port/telnet style connections.
==== Keys ====
{| class="wikitable"
!Key
!Allowed values
!Default value
!Description
|-
|Password
|Text
|<code>changeme</code>
|Sets the password used to authenticate with RCON
|-
|Port
|Integer, 0-65535
|<code>9100</code>
|Sets the port at which RCON will listen
|}


To test connecting to the rcon port and issuing simple commands use netcat or telnet: 
==== Example ====
<pre>nc {ip address} {port}</pre>
<pre>
<pre>telnet {ip address} {port}</pre>
Password=very secure password
Port=9100
</pre>


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>
== Running ==


If successful you should get an Authenticated=1 reply
==== Startup parameters ====
{| class="wikitable"
|+
!Parameter
!Description
|-
|
-PORT=7777
|Sets the server port to listen to.
Secondary port is <code>port + 400</code>.
For example: Base port <code>7777</code>, secondary port <code>8177</code>.
|-
|
-COMPETITIVE=1
|Enables competitive mode.
This is the same as enabling competitive move in the <code>Game.ini</code>.
|-
|
|'''TODO: Ask dev for complete list of arguments or, much easier and faster, decompile the binary and find them.'''
|}


==== Server executable ====
With the server files, a startup script <code>PavlovServer.sh</code> is shipped. It adds global execution privileges to the server executable, and adds an argument <code>Pavlov</code> to the startup parameters.


=== Tools available to access Rcon interface ===
The server executable is located in <code>Pavlov/Binaries/Linux/PavlovServer-Linux-Shipping</code> and can be executed directly. It already has global execution privileges by default.


A good first place to start is the RCON web interface run by ArcticVR. You do this at http://pavlovrcon.com/.  
Either of these can be used to start the server, the <code>PavlovServer.sh</code> script will forward all startup parameters to the server executable.


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
== Shack ==
Shack servers and PCVR servers have a few differences which will be described in this section.


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.
'''TODO: Since there are also 2 shack versions, documenting all this is a huge chore, especially for someone who doesn't touch this sh..izzle.'''
<pre>
#!/bin/bash
function slowcat(){ while read; do sleep .05; echo "$REPLY"; done; }
cat  $1 | slowcat | nc {ip address} {port}
</pre>


Example batchfile:
=== Game.ini keys ===
<pre>
The following keys do not exist for Shack servers.
8b96753b29612d8c98d6b696140b5d9f
ResetSnd
Disconnect
</pre>


* '''TODO'''


<br>
=== Custom maps ===
<hr>
Shack (both versions??) do not support Mod.io and require manual upload of any custom map.


'''There is a very brief example above '''
Also players download the custom maps directly from the server?
but it was not very detailed so i wanted to add a more detailed explanation


be aware that connecting and disconnecting a lot can hurt server performance
'''TODO: Needs figuring out!'''


first you need to make a shell script
To use custom maps, the maps folder first needs to be created manually.
<pre>nano /home/steam/test.sh</pre>
Pavlov/Saved/maps
Custom map folders will need to be placed into this folder.


<pre>#!/bin/bash
For example:<pre>Pavlov/Saved/maps
function slowcat(){ while read; do sleep .15; echo "$REPLY"; done; }
|- SVR_Arena
cat $1 | slowcat | nc {SERVER IP} {SERVER RCON PORT}</pre>
|- metadata.json
|- other mod files
|- SRV_Industrial
|- metadata.json
|- ...</pre>


now exit and save the test.sh
==== Downloading Shack maps ====
There are multiple places where you can download shack maps. Some maps are provided by the map creator.


here will will make a batch file that will just hold the rcon password and cmds we want to issue
* https://www.pavlovquest.com/maps
* https://pavlovhorde.com/mapsList
* #shack-map-showcase in the Pavlov VR Discord ('''TODO: link it!''')


<pre>nano /home/steam/batch</pre>
=== Server executable ===
<pre>{RCON PASSWORD CONVERTED TO MD5 HASH}
PavlovServer.sh exists for shack? does it do the same useless additional stuff?
{RCON CMD}
{RCON CMD}
Disconnect</pre>


here the first line has to be the rcon password converted to MD5 HASH
Is the name of the executable the same? For both shack versions?
https://www.md5hashgenerator.com/
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
'''TODO: Needs figuring out!'''
<pre>sudo chmod +x /home/steam/test.sh</pre>
 
to run the bash script
<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
 
=== Rcon access from within VR ===
 
PavlovRconWebserver, pavlov-vr-rcon and pavlov_rcon_tcl have been designed to be accessible within VR using virtual desktop view.


----
----
----
----
----
----
----
----
----
----
----
----


'''pavlov_rcon_tcl''': This is a tool designed to run on your desktop for access within VR
==== Shack Maps (Quest) ====


https://github.com/Oakraven79/pavlov_rcon_tcl
If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.


To get started, first create the directory to hold the maps


'''PavlovRconWebserver''' is an interface designed to be usable from everywhere all the time. (also in VR over desktop view)
<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre>
<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
You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach


While functional, the PavlovRconWebserver is still in development.
Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/


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.
Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server.  I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like


In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)


'''pavlov-vr-rcon''': This is tool designed to run on your desktop for access from within VR with SND team setup
In the directory dropdown (itll say /root) go back to /


https://github.com/Krzychu81/pavlov-vr-rcon
Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre>


=== RCON access from Discord ===
Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items


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.
Hit Allow


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.  
Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.


https://github.com/makupi/pavlov-bot
Pavlov Shack servers load maps at pavlovserver start. '''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.'''


'''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:
To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be
https://discord.com/oauth2/authorize?client_id=780880728992383077&scope=bot&permissions=199744


=== Tips on developing apps to use RCON ===
<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre>
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.


And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.


'''Ban/Unban'''


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).
[[Category:RCON automation]]

Latest revision as of 03:46, 6 July 2023

TODO: Rename the page to "Dedicated server" because THIS IS NOT A GUIDE!

Hosting

There are no Windows binaries

Server requirements

OS: Linux (Ubuntu 18.04 x86_64, Ubuntu 19/04 amd64, Ubuntu 20.04, and Rocky Linux 8 are confirmed working)

Memory: 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex game modes.

CPU: A ~2.5Ghz CPU will comfortably support a 10 player server. A ~4Ghz CPU will comfortably support 24 players.

Note: These are not hard limits for requirements, just suggestions for the best performance, based on experiences with many server providers on different grades of hardware.

Pavlov servers are functionally single threaded.

Software dependencies

  • gdb (TODO: do you actually need gdb to run a server? wtf?)
  • curl (TODO: do you actually need curl to run a server? does pavlov download stuff using curl?)
  • lib32gcc1(-s1)
  • libc++-dev

SteamCMD

The app ID for Pavlov VR dedicated servers is 622970.

Instructions on how to use SteamCMD are available in the Valve Developer Community Wiki.

To host Shack Live (Quest) use -beta shack, to host Shack RC (Quest) use -beta shack_beta.

Update 29 of the PCVR version of Pavlov VR dedicated servers require you to completely break your system:

sudo rm /usr/lib/x86_64-linux-gnu/libc++.so 
sudo ln -s /usr/lib/x86_64-linux-gnu/libc++.so.1 /usr/lib/x86_64-linux-gnu/libc++.so

TODO: By all that is good and fair, modifying system files like this for one piece of software is unacceptable. This can be done in a different, less intrusive way.

Configuration

Moderators, Blacklist, Whitelist

The following three files allow you to specify moderators, banned players, and whitelist players.

They are required to be able to use AddMod, Ban, Banlist, ModeratorList, RemoveMod and Unban RCON commands but are otherwise optional.

Pavlov/Saved/Config/mods.txt
Pavlov/Saved/Config/blacklist.txt
Pavlov/Saved/Config/whitelist.txt

TODO: Describe the file contents, give examples.

Game.ini

This file contains the majority of server configuration keys.

It is automatically created when first starting a server, it can also be created manually.

Pavlov/Saved/Config/LinuxServer/Game.ini

Keys

Game.ini keys
Key Allowed values Default value Description
bEnabled TrueFalse True Enables or disables registering with the master server to show or hide the server from the server list

TODO: confirm that this is true, and why is this even a thing, you can't direct connect to servers anyways...

ServerName Any ASCII text value up to 35 characters DedicatedServer Sets the name with which the server will be listed as

TODO: confirm exact maximum character limit and which characters are allowed (utf8? unicode?)

MaxPlayers Integer

Maximum 10 for Shack, 24 for PC.

10 Sets the amount of available player slots
ApiKey Obsolete, leave empty.
bSecured TrueFalse True Enables or disables Valve Anti-Cheat (VAC)
bCustomServer TrueFalse True Enables or disables "some new modding tools". Save and HTTP functions.

Required to write to blacklist.txt for bans. TODO: specify exactly what those new modding tools are.

bCompetitive TrueFalse False Enables or disables competitive mode for SND
bVerboseLogging TrueFalse False Enables or disables verbose logging.

Verbose logging mostly consists of detailed statistics. This will significantly increase logging.

bWhitelist TrueFalse False Enables or disables usage of the whitelist, allowing only users in whitelist.txt to join
RefreshListTime Integer, seconds 10 Sets the interval at which the server reads changes from mods.txt, blacklist.txt and whitelist.txt
LimitedAmmoType Integer, Type ID 1 Sets the limited ammo type, see Limited Ammo Types
TimeLimit Integer, minutes 60 Sets the time limit for each map
TickRate Integer, ticks per second

Recommended between 50 and 120

90 Sets the rate at which the server processes and updates game state information and network events.

Changes weapon de-spawn time and breaks some game modes. Recommended to leave at default value. TODO: what game modes? breaks how? needs clarification.

Password Integer, 1 to 4 digit pin 0000 Sets the server PIN that is required to be entered before being able to join the server.

Setting the pin to 0 or 0000 does not remove the pin but sets it to 0. Commenting out or leaving the value empty will remove the pin.

BalanceTableURL Text formatted as user/repository/branch vankruptgames/BalancingTable/main Sets the balance table Git URL to be used by the server.

See Balancing Table for instructions.

AFKTimeLimit Integer, seconds 60 Sets the maximum amount of time a player can be idle before being automatically kicked.

Setting this to 0 will disable AFK kicking. TODO: Pretty sure this is incorrect, while testing I've set it to 0 and got kicked nonetheless. Only being moderator prevents afk kicking. Requires further testing.

bInitialized TrueFalse False TODO: What does this do?
DepotURL TODO: What does this do?
bBroadcast TrueFalse True Probably enables or disables broadcasting to pavtv?

TODO: What does this do?

TODO: Verify all default values, right now I'm just guessing

TODO: Sort alphabetically

For maps running a Custom gamemode (CodZ, BR, Duel, etc.) it doesn't matter which gamemode you choose, as the map will automatically override it with the custom mode.

Limited Ammo Types

AmmoType Name Description
0 Unlimited Players have unlimited ammo, carry no ammo boxes and do not display an ammo count on the wrist.
1 Limited Generic Players carry ammo boxes with a limited amount of ammo.

One box for each weapon class (Pistol, Submachine gun, Rifles/MGs, Shotgun, Sniper).

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.

2 Limited Specific Players carry ammo boxes with a limited amount of ammo.

One box for each weapon.

Mags and ammo boxes can be put on the chest of the player to consolidate the ammo.

An ammo count is displayed on the wrist.

3 Custom Allows for full control over ammo by the map.
4 Limited Special All weapons except "special" weapons are unlimited, more clarification is needed.
5 Boxless Like limited generic but without boxes? Clarification is needed.

Map rotation

The map rotation is defined in the Game.ini.

Upon server start, the first map in the rotation will be started.

When a map has ended, the next map in the rotation will be started.

When the end of the rotation has been reached, it will start from the beginning again.

Mod.io maps will be downloaded and updated automatically, if required, when they are rotated to.

Each entry requires a separate line of the following format:

MapRotation=(MapId="Name or ID", GameMode="Game Mode")

Name or 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)

Game Mode: See Game Modes.

Game modes
GameMode Name
DM Death match
KOTH King of the hill
GUN Gun game
OITC One in the chamber
SND Search and destroy
TANKTDM WW2 Team Death Match
TDM Team Death Match
TTT Trouble in Terrorist Town
WW2GUN WW2 gun game
ZWV Zombie wave survival
HIDE The Hidden
INFECTION Hidden infection
PUSH Push
PH Prop hunt

TODO: move this to game modes page.

Example

[/Script/Pavlov.DedicatedServer]
# This is a comment
bEnabled=True
ServerName=Your server
MaxPlayers=10
bSecured=True
bCustomServer=True
bWhitelist=False
RefreshListTime=120
LimitedAmmoType=0
TickRate=90
TimeLimit=60
Password=1234
bInitialized=False
DepotURL=
ApiKey=
bCompetitive=False
bBroadcast=True
BalanceTableURL=vankruptgames/BalancingTable/Beta_5.1
bVerboseLogging=True
AFKTimeLimit=0

MapRotation=(MapId="datacenter", GameMode="SND")
MapRotation=(MapId="UGC3094680", GameMode="SND")
MapRotation=(MapId="UGC2996823", GameMode="SND")
MapRotation=(MapId="sand", GameMode="SND")
MapRotation=(MapId="UGC2841131", GameMode="SND")
MapRotation=(MapId="UGC2829349", GameMode="SND")
MapRotation=(MapId="container", GameMode="SND")
MapRotation=(MapId="UGC2844898", GameMode="SND")
MapRotation=(MapId="UGC2804502", GameMode="SND")

RCON

The RCON password and port are configured in RconSettings.txt. If the file does not exist or if the values in it are empty, no RCON will be provided.

Pavlov/Saved/Config/RconSettings.txt

Keys

Key Allowed values Default value Description
Password Text changeme Sets the password used to authenticate with RCON
Port Integer, 0-65535 9100 Sets the port at which RCON will listen

Example

Password=very secure password
Port=9100

Running

Startup parameters

Parameter Description
-PORT=7777
Sets the server port to listen to.

Secondary port is port + 400. For example: Base port 7777, secondary port 8177.

-COMPETITIVE=1
Enables competitive mode.

This is the same as enabling competitive move in the Game.ini.

TODO: Ask dev for complete list of arguments or, much easier and faster, decompile the binary and find them.

Server executable

With the server files, a startup script PavlovServer.sh is shipped. It adds global execution privileges to the server executable, and adds an argument Pavlov to the startup parameters.

The server executable is located in Pavlov/Binaries/Linux/PavlovServer-Linux-Shipping and can be executed directly. It already has global execution privileges by default.

Either of these can be used to start the server, the PavlovServer.sh script will forward all startup parameters to the server executable.

Shack

Shack servers and PCVR servers have a few differences which will be described in this section.

TODO: Since there are also 2 shack versions, documenting all this is a huge chore, especially for someone who doesn't touch this sh..izzle.

Game.ini keys

The following keys do not exist for Shack servers.

  • TODO

Custom maps

Shack (both versions??) do not support Mod.io and require manual upload of any custom map.

Also players download the custom maps directly from the server?

TODO: Needs figuring out!

To use custom maps, the maps folder first needs to be created manually.

Pavlov/Saved/maps

Custom map folders will need to be placed into this folder.

For example:

Pavlov/Saved/maps
|- SVR_Arena
 |- metadata.json
 |- other mod files
|- SRV_Industrial
 |- metadata.json
 |- ...

Downloading Shack maps

There are multiple places where you can download shack maps. Some maps are provided by the map creator.

Server executable

PavlovServer.sh exists for shack? does it do the same useless additional stuff?

Is the name of the executable the same? For both shack versions?

TODO: Needs figuring out!













Shack Maps (Quest)

If you try to use the steps above to add maps for Shack, youll run into issues very quickly. This is because Shack has no affiliation to Steam, and therefore cannot use Steam Workshop maps like above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading to Steam.

To get started, first create the directory to hold the maps

mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps

You can use any number of methods to move the map files onto the server, but ill go over the two simplest, starting with a GUI approach

Download and install CyberDuck onto your "home" PC (Whatever PC you use for access to the server, but not the server itsself): https://cyberduck.io/

Next, download and unzip your map of choice from https://www.pavlovquest.com/ , https://pavlovhorde.com/mapsList, or look in #shack-map-showcase channel in the discord server. I'm going to use Cheeto's WW2 Items test (http://www.mediafire.com/file/emyt9bs1z9u9ykw/SVR_Cheeto_Items.zip/file ) for this example, you do what you like

In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information. User will be root, password is whatever you set the root pw as (toor in Ubuntu by default)

In the directory dropdown (itll say /root) go back to /

Follow the directories until we arrive back at our "maps" folder

/home/steam/pavlovserver/Pavlov/Saved/maps

Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items

Hit Allow

Youll now see a folder named SVR_Cheeto_Items, and within it should be nothing but 3 files. If there is another folder in it, move this folder to the maps directory, otherwise the server wont work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.

Pavlov Shack servers load maps at pavlovserver start. YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.

To play the map, you can either use RCON switch map command, or to add the map to your servers automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example it would be

MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")

And thats all! Disconnect CyberDuck from your server before playing, otherwise youll have difficulty joining.