Setting up a dedicated server: Difference between revisions
Smalldarkie (talk | contribs) m (Added ipv6 disable command.) |
|||
(55 intermediate revisions by 6 users not shown) | |||
Line 23: | Line 23: | ||
=== Server Requirements === | === Server Requirements === | ||
'''Pavlovserver can only be hosted under Linux.''' | ==== Operating System ==== | ||
'''Pavlovserver can only be hosted under Linux.''' | |||
Known good operating systems are: | |||
* Ubuntu 18.04 x86_64 | |||
* Ubuntu 19/04 amd64 | |||
* Ubuntu 20.04 x86_64 | |||
* Rocky Linux 8 | |||
This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide. | This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide. | ||
Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing, and they can be installed, which is not covered in the scope of this guide. | |||
==== Resources and Performance Optimisation ==== | |||
* 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes. | * 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes. | ||
* A ~2.5Ghz CPU will comfortably support a 10 player server. | |||
* A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24, however this will be changing soon to 50. | |||
Pavlovser is functionally single threaded - one thread does vast majority of work. More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server. Hence, no particular performance benefit is gained from multithreading - if you are running multiple instances of a pavlov server, you will require more CPU cores. | |||
Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower. Note that these player count numbers are just suggestions to help optimise for the best performance, based on experiences with many server providers on different grades of hardware. | |||
As of 1.0.17 (17/05/2024) 24 is the hard limits for player counts, but this will soon be increased to 50. | |||
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread. | The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread. | ||
Line 60: | Line 69: | ||
Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue. | Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue. | ||
It should go without saying that hosting at home usually invites a myriad of potential problems that will be unique to your setup - such as your ISP, router, or network configuration. There is a lively community of like-minded server hosters on the Pavlov-VR Discord, so if you get stuck, head on over to the discord and see whether you can find the answers you're looking for. | |||
---- | |||
=== Starting Server Install === | |||
==== | ====Obtaining an ApiKey ==== | ||
(Not required unless hosting large amount of servers) | |||
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server. | |||
Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS | |||
(Note that there have sometimes been reported failures of this SMS system for non-US mobiles. In this case, DM davevillz your phone number and request a key, if you have tried and have had no success.) | |||
Save this key for later, so that you can ut this key in your Game.ini as follows: | |||
ApiKey="ABC123FALSEKEYDONTUSEME" | ApiKey="ABC123FALSEKEYDONTUSEME" | ||
or if you would like (personally untested..I would use | or if you would like (personally untested..I would use Game.ini) you can call it at server runtime with flag as follows: | ||
-KEY="ABC123FALSEKEYDONTUSEME" | -KEY="ABC123FALSEKEYDONTUSEME" | ||
This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key. | This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key. | ||
====System setup and software installation==== | ====System setup and software installation==== | ||
In this step we will: | |||
Install dependencies | # Check the operating system is compatible | ||
# Install some dependencies | |||
# create the user "steam" and set it's password, and switch to that user | |||
# as "steam" user, install Steamcmd, the binary used to download steam games in linux | |||
# use Steamcmd to install Pavlov. | |||
These steps only need to be done the first time you set up the server. We'll then look at some post-installation steps. | |||
'''Ubuntu 20. | ===== Step 1: Check the operating system is compatible ===== | ||
Confirm Linux version, run the command: | |||
lsb_release -a | |||
Expect the result to say '''Ubuntu 20.04''' (or one of the other known supported operating systems - this guide assumes Ubuntu or a Fedora system) | |||
'''Rocky Linux, CentOS 8, and RHEL 8'' | ===== Step 2: Install some dependencies ===== | ||
<blockquote>'''For Ubuntu 22.04:'''</blockquote> | |||
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip | |||
<blockquote>'''For Ubuntu 20.10 or higher'''</blockquote> | |||
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip | |||
<blockquote>For Rocky Linux, CentOS 8, and RHEL 8</blockquote> | |||
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config | |||
sudo setenforce 0 | |||
sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y | |||
wget <nowiki>https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm</nowiki> | |||
sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm | |||
===== Step 3: Create the steam user ===== | |||
sudo useradd -m steam | |||
sudo useradd -m steam | |||
[Optional] Set | [Optional] Set the /bin/bash shell for the steam user this will allow you to use arrow keys in terminal and show what folder you are in at all times<pre>sudo chsh -s /bin/bash steam</pre> | ||
<pre>sudo | |||
[Optional] Set a password for steam.<pre>sudo passwd steam</pre> | |||
<pre> | Login as the Steam user. ('''You will need to do this each time you connect to your server - editing game files and interacting with the game server should be done as the steam user'''):<pre> | ||
sudo su -l steam | sudo su -l steam | ||
</pre> | </pre> | ||
===== Step 4: Install Steam, known as SteamCMD ===== | |||
Install Steam | |||
<pre> | <pre> | ||
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf - | mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf - | ||
</pre> | </pre> | ||
===== Step 5: User SteamCMD to install Pavlov ===== | |||
There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC) | There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC) | ||
(You will need to run this command each time there is a Pavlov Server update). <br /> | (You will need to run this command each time there is a Pavlov Server update). | ||
To host '''PC Server (non-beta)''': | |||
<br />To host '''PC Server (non-beta)''': | |||
<pre> | <pre> | ||
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 +exit | ~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit | ||
</pre> | </pre> | ||
Line 244: | Line 165: | ||
</pre> | </pre> | ||
Now that we've installed the server, | ===== Post Installation Steps ===== | ||
Install a fresh copy of steamclient.so | Now that we've installed the server, Install a fresh copy of steamclient.so. You may also have to do this after each update. | ||
<pre> | <pre> | ||
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit | ~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit | ||
Line 252: | Line 173: | ||
cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so | cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so | ||
</pre> | </pre> | ||
The update 29 of the PCVR version of Pavlov and after added a requirement to run these commands to change the steamclient.so: | |||
<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> | |||
Make the PavlovServer script executable. (You only need to do this once): | Make the PavlovServer script executable. (You only need to do this once): | ||
Line 259: | Line 184: | ||
</pre> | </pre> | ||
Make a note to review these steps later, if you would like to automate server and steam client updates. | |||
---- | |||
=== Server Configuration === | |||
Before being able to properly use the server we need to configure it. You should attempt to start the server, let it start up, and then shut down the server, which should create all the required configuration files and directories. | |||
- | However, if you are having trouble, it may help to create the directories manually first - make sure you are doing these actions as the "steam" user. | ||
Start by creating some directories: | |||
<pre> | <pre> | ||
Line 276: | Line 203: | ||
==== Mods/Blacklist/Whitelist (optional) ==== | ==== Mods/Blacklist/Whitelist (optional) ==== | ||
The following three files allow you to specify mods, banned players, and whitelist players. | The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later. | ||
<pre> | <pre> | ||
Line 285: | Line 212: | ||
====Configuring Game.ini==== | ====Configuring Game.ini==== | ||
If starting the server did not create a default Game.ini, create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it. | |||
Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin. | |||
You will also need to fetch your API Key you set up earlier. | |||
<pre> | <pre> | ||
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini | nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini | ||
Line 294: | Line 225: | ||
bEnabled=true | bEnabled=true | ||
ServerName="My_private_idaho" | ServerName="My_private_idaho" | ||
MaxPlayers=10 # | MaxPlayers=10 #its recommended for the best experience to keep shack servers at or below 10 players pcvr and psvr are both capped at 24 too. | ||
ApiKey="ABC123FALSEKEYDONTUSEME" | ApiKey="ABC123FALSEKEYDONTUSEME" | ||
bSecured=true | bSecured=true | ||
Line 305: | Line 236: | ||
TickRate=90 | TickRate=90 | ||
TimeLimit=60 | TimeLimit=60 | ||
AFKTimeLimit=300 | |||
#Password=0000 | #Password=0000 | ||
#BalanceTableURL="vankruptgames/BalancingTable/main" | #BalanceTableURL="vankruptgames/BalancingTable/main" | ||
Line 323: | Line 255: | ||
* '''bWhitelist''' - Only allow users in whitelist.txt to join | * '''bWhitelist''' - Only allow users in whitelist.txt to join | ||
* '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files | * '''RefreshListTime''' - sets how often the running server checks for updates in ban/whitelist/mod files | ||
* '''LimitedAmmoType''' - sets limited ammo mode | * '''LimitedAmmoType''' - sets limited ammo mode, see Limited Ammo Types table below | ||
* '''TimeLimit''' - sets time limit for each map | * '''TimeLimit''' - sets time limit for each map | ||
Line 335: | Line 261: | ||
* '''Password''' - PIN number for server #FYI - this is now also changeable via rcon. | * '''Password''' - PIN number for server #FYI - this is now also changeable via rcon. | ||
* '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one. | * '''BalanceTableURL''' - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one. | ||
* '''MapRotation''' - you can add multiple of these. The | * '''MapRotation''' - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. <nowiki>https://mod.io/g/pavlov</nowiki>. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity <nowiki>https://mod.io/g/pavlov/m/gravity1</nowiki> has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation. | ||
* '''AFKTimeLimit''' There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely. | |||
Available game modes as of 09/06/2022: See Game modes table below | |||
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" | |||
|+ | |||
!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.''' | |||
|} | |||
===== Game Modes ===== | |||
{| class="wikitable" | |||
|+ | |||
!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 | |||
|- | |||
|TTTclassic | |||
|TTT with only innocent/traitor/detective | |||
|- | |||
|WW2GUN | |||
|WW2 gun game | |||
|- | |||
|ZWV | |||
| Zombie wave survival | |||
|- | |||
|HIDE | |||
|The Hidden | |||
|- | |||
|INFECTION | |||
|Hidden infection | |||
|- | |||
|PUSH | |||
|Push | |||
|- | |||
|PH | |||
|Prop hunt | |||
|} | |||
==== Default Map ID's ==== | |||
datacenter | |||
sand | |||
bridge | |||
containeryard | |||
siberia (Prison Break) | |||
hospital (Zombies map) | |||
killhouse | |||
range | |||
tutorial | |||
santorini | |||
station | |||
industry | |||
ogcontainers (Shack only) | |||
haguenau (Shack only) | |||
foundation (Shack only) | |||
stalingrad (PC only) | |||
stalingrad_night (PC only) | |||
santorini_night (PC only) | |||
sand_night (PC only) | |||
station_night (PC only) | |||
industry_night (PC only) | |||
bunker (PC only) | |||
=== Server Administration === | |||
Installing the server is half the battle. | |||
==== Server Visibility ==== | |||
If you've followed this guide successfully to this point, you should have a running instance of pavlovserver. For your server to be visible to the Master List, and so that it can be joined by players, you will need to make sure the server has the ports forwarded. | |||
You can also check the server visibility using the vankrupt API, or on some publicly hosted game server lists, or by launching the game and just looking for your server in the game browser. | |||
==== Firewall/Port forwarding ==== | ===== Firewall/Port forwarding ===== | ||
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding. | Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding. | ||
Line 357: | Line 427: | ||
</pre> | </pre> | ||
'''Rocky Linux''' firewall commands to check firewall and open ports: | '''Rocky Linux''' firewall commands to check the firewall and open ports: | ||
<pre> | <pre> | ||
sudo firewall-cmd --zone=public --add-port=7777/tcp | sudo firewall-cmd --zone=public --add-port=7777/tcp | ||
Line 371: | Line 441: | ||
You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list. | You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list. | ||
If you are running multiple servers and have set additional ports (see http:// | If you are running multiple servers and have set additional ports (see http://pavlovwiki.com/index.php/Setting_up_a_dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open | ||
If you have setup rcon via RconSettings.txt (below) then that port also | Whilst on the topic of port forwarding, If you have setup '''rcon''' via RconSettings.txt (below) then that port also needs to be allowed access via TCP, if your RCON controller will be external to your server. | ||
If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP | If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP | ||
ipv6 is not planned to be supported. You can disable by doing the following command: | |||
sudo nano /etc/default/grub | |||
And then edit the line below to GRUB_CMDLINE_LINUX_DEFAULT=”ipv6. disable=1″ | |||
This makes sure ipv6 is disabled on operating system restart. | |||
---- | ---- | ||
Line 381: | Line 458: | ||
==== Shack Maps (Quest) ==== | ==== Shack Maps (Quest) ==== | ||
Adding maps for the Shack version of Pavlov works differently to the steam version of the game, and you'll run into issues very quickly if you do not customise your server to accomodate this. | |||
To get started, first create the directory to hold the maps | This is because Shack has no affiliation with Steam, and therefore cannot use Steam Workshop maps like the above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading it to Steam. | ||
To get started, first, create the directory to hold the maps | |||
<pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre> | <pre>mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps</pre> | ||
You can use any number of methods to move the map files onto the server, but | You can use any number of methods to move the map files onto the server, but I'll 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 itself): https://cyberduck.io/ | |||
* Next, download and unzip your map of choice | |||
** You can get them 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 | * In the top left corner, open a connection, set the connection type to SFTP, and fill in the rest of the information | ||
** This will be the same credentials you've used to connect to the server via SSH this whole time. - the username is typically `root` for Debian or Rocky systems, but you could also use the "steam" user if you set that user up with a password or private key to allow SSH. | |||
Follow the directories until we arrive back at our "maps" folder <pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre> | * In the directory dropdown (it will say /root) navigate back to / | ||
* Follow the directories until we arrive back at our "maps" folder | |||
<pre>/home/steam/pavlovserver/Pavlov/Saved/maps</pre> | |||
Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items | * Drag and drop the unzipped map folder into the main window, in this case itll be SVR_Cheeto_Items | ||
* Hit Allow | |||
** You'll 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 won't work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less. | |||
* Your map should now be ready to use, after you restart the game service (e.g. sudo systemctl restart pavlovserver.service). | |||
Pavlov Shack servers load maps when the pavlovserver starts up. | |||
'''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 server's automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example, you would add the following line to your Game.ini above or below the other MapRotation lines: | |||
If you have any trouble with the map loading (typically, the game will load into datacentre if there are problems) you may need to check the permissions of the map files, to ensure they belong to the user/group "steam:steam". | |||
<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre> | <pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre> | ||
And | And that's all! Disconnect CyberDuck from your server before playing, otherwise you'll have difficulty joining. | ||
----------- | ----------- | ||
Line 417: | Line 502: | ||
==== Adding Shack Maps over Command Line Interface ==== | ==== Adding Shack Maps over Command Line Interface ==== | ||
Pavlov Shack servers load maps | A reminder that Pavlov Shack servers load maps when the pavlovserver starts up. | ||
'''YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.''' | |||
This process is more complicated, but adding maps over the command line interface has its benefits | |||
First, CD to the maps directory you made above | First, log into the server, change to the steam user, and CD to the maps directory you made above | ||
<pre>cd ~/pavlovserver/Pavlov/Saved/maps</pre> | <pre>sudo su steam | ||
cd ~/pavlovserver/Pavlov/Saved/maps</pre> | |||
Download the map files from whatever you use to upload them. To do this, you can either use curl or wget | Download the map files from whatever you use to upload them. To do this, you can either use curl or wget | ||
Line 429: | Line 517: | ||
<pre>curl -O insertURLhere</pre> | <pre>curl -O insertURLhere</pre> | ||
'''If you download your map from Google Drive''', make sure that your .zip folder is shared with anyone. | |||
Then, get the file's URL from the shared link.<p>Example : ''<nowiki>https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view</nowiki>''</p> <p>will be ''19bI8gUHaN5tUrDvnadAacUnchQf6_k''</p> | |||
Then, get the file's | |||
Edit "fileId" and "fileName" before you execute the command. | Edit "fileId" and "fileName" before you execute the command. | ||
<pre> | <pre> | ||
Line 440: | Line 528: | ||
curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre> | curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName} </pre> | ||
To keep with the Items example, we're downloading the file from a ZIP uploaded to discord: | |||
To keep with the Items example: | |||
<pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre> | <pre>curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip</pre> | ||
Line 455: | Line 542: | ||
<pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre> | <pre>MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")</pre> | ||
==== Admin/Moderator list (optional) ==== | ==== Admin/Moderator list for Arctic-VR hosted servers (optional) ==== | ||
The only working in-game admin menu is through Arctic VR server hosting (see below). | The only working in-game admin menu is through Arctic VR server hosting (see below). | ||
Line 503: | Line 590: | ||
</pre> | </pre> | ||
=== Configure Rcon === | ==== Configure Rcon ==== | ||
To enable Rcon access create config file: | To enable Rcon access create config file: | ||
<pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre> | <pre> nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt </pre> | ||
Line 514: | Line 601: | ||
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware) | You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware) | ||
=== Starting the server === | ==== Starting the server manually ==== | ||
<pre> | <pre> | ||
cd ~/pavlovserver && ./PavlovServer.sh | cd ~/pavlovserver && ./PavlovServer.sh | ||
Line 523: | Line 608: | ||
That's it, your server will be automatically broadcast to the master server! :) | That's it, your server will be automatically broadcast to the master server! :) | ||
Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this. | |||
Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this. | |||
If you have followed the supervisor service-setup part of the guide, you can run pavlovserver as a service using systemctl. | |||
==== Seeing your server in a Master List ==== | |||
Two handy tools to determine quickly if your server is broadcasting are the [https://pavlovhorde.com/ Horde] (Shack) and [https://pavlovhorde.com/pcServers Horde] (PC version) public listings. | |||
If you're also handy with cURL, you can query the vankrupt game server listing directly, for Oculus/Shack servers, and PC servers: | |||
* <nowiki>https://prod-shack-pavlov-ms.vankrupt.net/servers/v2/list/1.0.17/oculus_app_id/0/0/0/all</nowiki> | |||
* <nowiki>https://prod-shack-pavlov-ms.vankrupt.net/servers/v2/list/1.0.17/oculus/0/0/0/all</nowiki> | |||
* <nowiki>https://prod-crossplay-pavlov-ms.vankrupt.net/servers/v2/list/1.0.17/steam/0/0/0/all</nowiki> | |||
where 1.0.17 is the version of the game. You can check the current version of the game your server is running by checking your log file (/home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log) and checking for the "version" line early in the startup of the log file. | |||
The endpoint also supports filtering - changing the '''/0/0/0''' in the URL will have the following effects: | |||
* /1/0/0/ hide empty servers | |||
* /0/1/0/ hide full servers | |||
* /0/0/1/ hide password protected servers | |||
You can also customize which gamemodes are shown by changing /all to /SND,TDM,DM,GUN,CUSTOM,ZWV,TTT,TTTCLASSIC,TANKTDM,WW2GUN,KOTH,OITC,HIDE,PH and removing what you don't want to view. | |||
---- | ---- | ||
Line 598: | Line 646: | ||
</pre> | </pre> | ||
Copy contents below into the file and save. | Copy the contents below into the file and save. | ||
<pre> | <pre> | ||
Line 642: | Line 690: | ||
sudo systemctl enable pavlovserver | sudo systemctl enable pavlovserver | ||
</pre> | </pre> | ||
---- | ---- | ||
== Advanced Server Administration == | == Advanced Server Administration == | ||
Line 857: | Line 698: | ||
=== Running multiple servers on one host === | === Running multiple servers on one host === | ||
* Pavlovserver is functionally single threaded (there are multiple threads, but vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players. | * Pavlovserver is functionally single-threaded (there are multiple threads, but the vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players. | ||
* Make multiple server installs by defining a separate install dir for each server. | * Make multiple server installs by defining a separate install dir for each server. | ||
* Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"''' | * Run each server with a unique port. eg: '''./PavlovServer.sh -PORT="Desired Port"''' | ||
* The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well) | * The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well) | ||
* If you are using RCON, each server will need a unique port defined in RconSettings.txt | * If you are using RCON, each server will need a unique port defined in RconSettings.txt | ||
* Ensure the ports are forwarded and opened in your firewall | * Ensure the ports are forwarded and opened in your firewall | ||
To duplicate directories: | To duplicate directories: | ||
Line 871: | Line 712: | ||
/home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port] | /home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port] | ||
</pre> | </pre> | ||
=== Starting server in competitive mode === | === Starting server in competitive mode === | ||
Line 880: | Line 722: | ||
</pre> | </pre> | ||
{| class="wikitable" | |||
|} | |||
=== Useful Linux Commands === | === Useful Linux Commands === | ||
List files / folders in directory, print current working directory, | List files / folders in directory, print current working directory, | ||
<pre>ls -la #list files/directories along with authorities and ownership | <pre>ls -la #list files/directories along with authorities and ownership | ||
Line 911: | Line 755: | ||
<pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre> | <pre> cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string </pre> | ||
<hr> | |||
== Advanced Scripts For Server Management == | |||
<hr> | |||
=== '''Auto-updating the server (PCVR only)''' === | |||
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server: | |||
<pre> | |||
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh | |||
#!/bin/bash | |||
USER="steam" | |||
SERVICENAME="pavlovserver.service" | |||
INSTALLDIRNAME="pavlovserver" | |||
USERHOME="/home/$USER" | |||
echo -e "Beginning Pavlov VR update run on $(date)\n\n" | |||
systemctl stop "$SERVICENAME" | |||
sleep 5 | |||
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit | |||
sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit | |||
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so" | |||
sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so" | |||
systemctl start "$SERVICENAME" | |||
echo -e "Ending Pavlov VR update run on $(date)\n\n" | |||
EOF | |||
chmod +x $HOME/pavlov_daily_update_and_restart.sh | |||
mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log | |||
CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1" | |||
(sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root - | |||
unset CRONLINE | |||
</pre> | |||
These commands will: | |||
1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory | |||
2. Make the shell script executable | |||
3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands. | |||
4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time | |||
If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to: | |||
= | |||
<pre> | <pre> | ||
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1" | |||
</pre> | </pre> | ||
If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM. | |||
< | <hr> | ||
=== '''Save Logs for records and stats''' === | |||
this is an automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection | |||
https://github.com/JTWP-org/backUpLogs2 | |||
<hr> | |||
=== | === '''Make an API request with Mod.io to get map picture and name''' === | ||
very basic script pass the script a map ID as an argument then it will give u the name and a thumbnail to use | |||
https://github.com/JTWP-org/mod.io-modcheck/tree/main | |||
=== '''Sharing Bans over gameserver on same machine''' === | |||
when you have a lot of servers keeping the bans synced can be a nightmare so using a symbolic link allows all the servers to use one file | |||
for this lets say I have pavlovserver000 and pavlovserver001 and they are located at /home/steam/pavlovserver000 and /home/steam/pavlovserver001 | |||
1 | ''step 1 will be to pick a blacklist to use as the new one and move it to a central location'' | ||
mkdir ~/shared ; mv /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ~/shared/blacklist.txt ; rm /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt | |||
now we have moved the blacklist from pavlovserver000 to a folder in our home called shared and then we removed the blacklist from pavlovserver001 | |||
step 2 making the links | |||
ln -s ~/shared/blacklist.txt /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ; ln -s ~/shared/blacklist.txt /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt | |||
now editing them in pavlovserver001's files will update the list for all of the servers it's not a sync its uses the same list if you want to check where a link is pointed if u | |||
ls -l | |||
It will show where the file is really located <hr> | |||
=== Interactive Update ALL === | |||
will find all server installs on machine and update them will update Ubuntu check what version and do correct updates for that version also UPDATE 29 PCVR STEP then it will list each server by server name and ask what type it is and then it will update and move to the next | |||
https://github.com/JTWP-org/Pavlov-updateallservers/tree/main<hr> | |||
=== getting map info with just the UGC === | |||
you will need to get a API key from mod.io for this ... running this bash script and passing a UGC number to it will return the map name mod.io url and a thumbnail | |||
HOW TO USE <pre>nano get-map.sh</pre> | |||
then enter this script <pre>#!/bin/bash | |||
ugc=000000 | |||
= | gameID=3959 #PAVLOV IS 3959 | ||
api-path="https://u-*ID NUMBER*.modapi.io/v1" #get on thhe access tab in mod.io settings | |||
api-key="" #get on thhe access tab in mod.io settings | |||
curl -X GET "${api-path}/v1/games/${gameID}/mods/$("${ugc:3})?api_key=${api-key}" -H 'Accept: application/json' | jq '.logo.thumb_1280x720, .name , .profile_url</pre> | |||
then give script perms to run <pre>sudo chmod +x get-map.sh</pre> | |||
and then run it like this | |||
<pre>bash get-map.sh UGC3409480 </pre> |
Latest revision as of 19:22, 5 September 2024
Setting up a dedicated server
There are no Windows binaries
This guide is written exclusively for Linux and covers Ubuntu/Debian/Debian-like and Red Hat RPM-based distros. Possible to run with other distros, but some of the commands won't work and you will need to know enough to figure out the software install of dependencies on your own.
If you are considering hosting from home, please read that section of the wiki first.
This guide assumes you know the basics of using a bash terminal: ssh'ing into a server, running bash commands, editing text files, etc.
If you have no experience using bash, maybe start here. Editing text files via commandline is often a challenge. Suggest using nano and reading guide here
If you are new to linux and accessing your server from Windows, highly suggest using MobaXterm as your SSH client as that can make required editing of text files easier using built in editor instead of the native linux command line editors.
And finally, ask yourself why you want to setup a server? If you look at the list, there are many, many more servers than players. If you don't have a team, discord community, or group of friends ready to play on your server, chances are it will go unused. Got one of these... great, let's go.
If you don't want to go through the hassle yourself and want to pay for a hosting service Arctic VR (PC and Shack) and Horde (Shack) provide a server hosting services and are trusted in the community. See links below.
Server Requirements
Operating System
Pavlovserver can only be hosted under Linux.
Known good operating systems are:
- Ubuntu 18.04 x86_64
- Ubuntu 19/04 amd64
- Ubuntu 20.04 x86_64
- Rocky Linux 8
This can be running as a VM under windows, but this will increase the complexity of the setup beyond this guide.
Ubuntu 15.04 x86 is known to fail to install using this guide. Recommend not running on "minimal" images as some tools are missing, and they can be installed, which is not covered in the scope of this guide.
Resources and Performance Optimisation
- 2GB RAM + 1GB RAM per each additional server with 10 players. More RAM is recommended for larger maps, higher player counts, or complex gamemodes. Not having enough RAM is a common cause of server crashes.
- A ~2.5Ghz CPU will comfortably support a 10 player server.
- A ~4Ghz CPU will comfortably support 24 players. This is a limit built into Pavlov itself, no server will allow players to join over 24, however this will be changing soon to 50.
Pavlovser is functionally single threaded - one thread does vast majority of work. More CPUs only help if you are running more servers. More clockspeed = higher performance = more users per server. Hence, no particular performance benefit is gained from multithreading - if you are running multiple instances of a pavlov server, you will require more CPU cores.
Lower player counts are recommended for complex gamemodes (E.g. CodZ) and/or highly detailed maps, so that maximum number will often be lower. Note that these player count numbers are just suggestions to help optimise for the best performance, based on experiences with many server providers on different grades of hardware.
As of 1.0.17 (17/05/2024) 24 is the hard limits for player counts, but this will soon be increased to 50.
The maximum number of servers you can run is dependent on how many CPUs you have. For example, if you have an 8 core CPU, the maximum number of servers would be 7. You should always have at least one CPU free as overhead, as Pavlov servers can use slightly more than one thread.
Hosting at home
When hosting at home there are additional requirements regarding networking: Your router has to support port-forwarding, hair-pinning/LoopbackNAT, and respond to ping requests. These techniques are necessary to allow your server to be found and to talk back to the client. please see https://en.wikipedia.org/wiki/Port_forwarding, https://en.wikipedia.org/wiki/Hairpinning, and https://www.speedguide.net/faq/how-to-become-pingable-behind-a-routerfirewall-376 for more info and google for these terms in addition to your router model to find guides on how to enable/configure it properly. If you have modern Router, it may have these features already enabled, in this case you just have to configure port-forwarding. If you can see your server but not join it while others can, this is indicative of a failure of LoopbackNAT.
A second challenge to hosting at home is CGNAT (Carrier grade NAT: https://www.a10networks.com/blog/carrier-grade-nat/). Just like NAT on your home network that has to be gotten around w/ port-forwarding, CGNAT breaks the ability of external connections to be made back to your server, but the controls are solely in your ISPs hands. Sometimes if you ask, you can be removed from CGNAT pools and/or assigned a static IP. CGNAT rollouts are becoming very common now, so if your server worked then doesn't allow connections now, your ISP may have made this change.
You can check whether you’re on a CGNAT network by visiting a Web site such as ipaddress.com or whatsmyip.com and comparing the IP address listed to the public/WAN IP address assigned to your Internet gateway. To find your gateway’s public IP address, check the status page in the administrative interface. If the two IP addresses differ, you’re likely on a CGNAT network. If so, this problem must be resolved before you go any further.
Not understanding these requirements and configuration is a frequent cause of failed setups and questions in discord. Don't skip this if you are trying to host from home
There are serious security implications of hosting this software at home. None of the devs are security experts and there has been no security review of the code. You are opening up your system to the world and publicity advertising this fact. Expect that any system hosting this software is open to compromise from the Internet and act accordingly. If your router offers a DMZ network, use it. Consider hosting on a cloud based server and think twice before running this software on any system that contains data you care about or has access to networks and computers you care about.
If you're hosting at home using Oracle's VirtualBox, there are steps you can take to prevent double NAT (which can cause issues later on)
1. Select your VM and then click Settings in VirtualBox's main window.
2. Click on Network and change Attached To from NAT to Bridged Adapter.
Once you've done this, your VM should be connected directly to your home router and double NAT should no longer be a issue.
It should go without saying that hosting at home usually invites a myriad of potential problems that will be unique to your setup - such as your ISP, router, or network configuration. There is a lively community of like-minded server hosters on the Pavlov-VR Discord, so if you get stuck, head on over to the discord and see whether you can find the answers you're looking for.
Starting Server Install
Obtaining an ApiKey
(Not required unless hosting large amount of servers)
For your server to show up in the server list, there is now a requirement to have an ApiKey issued by vankrupt. This is to prevent DOS attacks against the master server.
Get the key by going here: https://pavlov-ms.vankrupt.com/servers/v1/key and using your mobile number to get a SMS
(Note that there have sometimes been reported failures of this SMS system for non-US mobiles. In this case, DM davevillz your phone number and request a key, if you have tried and have had no success.)
Save this key for later, so that you can ut this key in your Game.ini as follows:
ApiKey="ABC123FALSEKEYDONTUSEME"
or if you would like (personally untested..I would use Game.ini) you can call it at server runtime with flag as follows:
-KEY="ABC123FALSEKEYDONTUSEME"
This key can be re-used for a reasonable number of servers (a limit of 10 has been mentioned). Contact the Devs if you need more servers per key.
System setup and software installation
In this step we will:
- Check the operating system is compatible
- Install some dependencies
- create the user "steam" and set it's password, and switch to that user
- as "steam" user, install Steamcmd, the binary used to download steam games in linux
- use Steamcmd to install Pavlov.
These steps only need to be done the first time you set up the server. We'll then look at some post-installation steps.
Step 1: Check the operating system is compatible
Confirm Linux version, run the command:
lsb_release -a
Expect the result to say Ubuntu 20.04 (or one of the other known supported operating systems - this guide assumes Ubuntu or a Fedora system)
Step 2: Install some dependencies
For Ubuntu 22.04:
sudo apt update && sudo apt install -y gdb curl lib32gcc1 libc++-dev unzip
For Ubuntu 20.10 or higher
sudo apt update && sudo apt install -y gdb curl lib32gcc-s1 libc++-dev unzip
For Rocky Linux, CentOS 8, and RHEL 8
sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/g' /etc/selinux/config sudo setenforce 0 sudo yum install gdb curl glibc.i686 libstdc++.i686 libstdc++-devel.i686 libstdc++-devel.x86_64 unzip wget -y wget https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/l/libcxx-3.8.0-3.el7.x86_64.rpm sudo rpm -i libcxx-3.8.0-3.el7.x86_64.rpm
Step 3: Create the steam user
sudo useradd -m steam
[Optional] Set the /bin/bash shell for the steam user this will allow you to use arrow keys in terminal and show what folder you are in at all times
sudo chsh -s /bin/bash steam
[Optional] Set a password for steam.
sudo passwd steam
Login as the Steam user. (You will need to do this each time you connect to your server - editing game files and interacting with the game server should be done as the steam user):
sudo su -l steam
Step 4: Install Steam, known as SteamCMD
mkdir ~/Steam && cd ~/Steam && curl -sqL "https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz" | tar zxvf -
Step 5: User SteamCMD to install Pavlov
There are different dedicated server versions for Pavlov Server - choose which server version you want to host (PC non-beta, PC Beta, Shack Live, or Shack RC) (You will need to run this command each time there is a Pavlov Server update).
To host PC Server (non-beta):
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta default +exit
To host PC BETA:
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta beta_server +exit
To host Shack Live (Quest):
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack +exit
To host Shack RC (Quest):
~/Steam/steamcmd.sh +force_install_dir /home/steam/pavlovserver +login anonymous +app_update 622970 -beta shack_beta +exit
Post Installation Steps
Now that we've installed the server, Install a fresh copy of steamclient.so. You may also have to do this after each update.
~/Steam/steamcmd.sh +login anonymous +app_update 1007 +quit mkdir -p ~/.steam/sdk64 cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/.steam/sdk64/steamclient.so cp ~/Steam/steamapps/common/Steamworks\ SDK\ Redist/linux64/steamclient.so ~/pavlovserver/Pavlov/Binaries/Linux/steamclient.so
The update 29 of the PCVR version of Pavlov and after added a requirement to run these commands to change the steamclient.so:
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
Make the PavlovServer script executable. (You only need to do this once):
chmod +x ~/pavlovserver/PavlovServer.sh
Make a note to review these steps later, if you would like to automate server and steam client updates.
Server Configuration
Before being able to properly use the server we need to configure it. You should attempt to start the server, let it start up, and then shut down the server, which should create all the required configuration files and directories.
However, if you are having trouble, it may help to create the directories manually first - make sure you are doing these actions as the "steam" user.
Start by creating some directories:
mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Logs mkdir -p /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer mkdir -p /home/steam/pavlovserver/Pavlov/Saved/maps
Mods/Blacklist/Whitelist (optional)
The following three files allow you to specify mods, banned players, and whitelist players. These are optional, but go ahead and create them. Populating the files is described later.
touch /home/steam/pavlovserver/Pavlov/Saved/Config/mods.txt touch /home/steam/pavlovserver/Pavlov/Saved/Config/blacklist.txt touch /home/steam/pavlovserver/Pavlov/Saved/Config/whitelist.txt
Configuring Game.ini
If starting the server did not create a default Game.ini, create a new Game.ini file using following command to open an editor and copy/paste the following block into it then save it.
Note not all of these options are required. For instance remove or comment out the Password=0000 line to make a public server with no pin.
You will also need to fetch your API Key you set up earlier.
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
[/Script/Pavlov.DedicatedServer] bEnabled=true ServerName="My_private_idaho" MaxPlayers=10 #its recommended for the best experience to keep shack servers at or below 10 players pcvr and psvr are both capped at 24 too. ApiKey="ABC123FALSEKEYDONTUSEME" bSecured=true bCustomServer=true bVerboseLogging=false bCompetitive=false #This only works for SND bWhitelist=false RefreshListTime=120 LimitedAmmoType=0 TickRate=90 TimeLimit=60 AFKTimeLimit=300 #Password=0000 #BalanceTableURL="vankruptgames/BalancingTable/main" MapRotation=(MapId="UGC1758245796", GameMode="GUN") MapRotation=(MapId="datacenter", GameMode="SND") MapRotation=(MapId="sand", GameMode="DM")
- bEnabled - whether the server appears in the server list (unconfirmed)
- ServerName - name it will be listed as. (approx 35 chars max)
- MaxPlayers - See suggested specs for limits. 10 standard (10 for shack), 20-24 is max recommended for large maps like Stalingrad or PUSH/RUSH modes, and servers allow a maximum of 24 players.
- ApiKey - Unique ApiKey required to register server with master server. Replace with your key
- bSecured - enabled Valve Anti-Cheat (VAC)
- bCustomServer - activates some new modding tools (save and http functions. Required to write to blacklist.txt for bans)
- bCompetitive - sets the server to competitive mode for SND. If removed the server will default to false
- bVerboseLogging - enables verbose logging, mostly detailed statistics. Be prepared for significant increase in logging.
- bWhitelist - Only allow users in whitelist.txt to join
- RefreshListTime - sets how often the running server checks for updates in ban/whitelist/mod files
- LimitedAmmoType - sets limited ammo mode, see Limited Ammo Types table below
- TimeLimit - sets time limit for each map
- TickRate - sets the server tickrate. (so far minimum stable seems around 50 and max around 120. Beware setting this changes weapon despawn time and breaks some game modes. Recommend not touching)
- Password - PIN number for server #FYI - this is now also changeable via rcon.
- BalanceTableURL - Points to a custom balance table from github. See https://github.com/vankruptgames/BalancingTable for instructions. This line isn't needed if you don't have one.
- MapRotation - you can add multiple of these. The map system has switched from the steam workshop to modio which means that the server rotation will need to be redone with modio UGCs. https://mod.io/g/pavlov. This is done by taking the resource ID from the modio page, adding “UGC” in front of it and then adding that to the rotation. For example the map gravity https://mod.io/g/pavlov/m/gravity1 has a resource ID of 2773760 so the map ID to add to the server would be “UGC2773760”. When a match ends, the server will load the next map in the rotation.
- AFKTimeLimit There is now a feature to kick players who are idle in the game. Integers are measured in seconds and 0 disables AFK kicking completely.
Available game modes as of 09/06/2022: See Game modes table below
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. |
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 |
TTTclassic | TTT with only innocent/traitor/detective |
WW2GUN | WW2 gun game |
ZWV | Zombie wave survival |
HIDE | The Hidden |
INFECTION | Hidden infection |
PUSH | Push |
PH | Prop hunt |
Default Map ID's
datacenter
sand
bridge
containeryard
siberia (Prison Break)
hospital (Zombies map)
killhouse
range
tutorial
santorini
station
industry
ogcontainers (Shack only)
haguenau (Shack only)
foundation (Shack only)
stalingrad (PC only)
stalingrad_night (PC only)
santorini_night (PC only)
sand_night (PC only)
station_night (PC only)
industry_night (PC only)
bunker (PC only)
Server Administration
Installing the server is half the battle.
Server Visibility
If you've followed this guide successfully to this point, you should have a running instance of pavlovserver. For your server to be visible to the Master List, and so that it can be joined by players, you will need to make sure the server has the ports forwarded.
You can also check the server visibility using the vankrupt API, or on some publicly hosted game server lists, or by launching the game and just looking for your server in the game browser.
Firewall/Port forwarding
Using the default settings there are two UDP ports (7777, 8177) that need to be allowed to access the server either by firewall setup or port forwarding.
Ubuntu firewall commands to check firewall and open ports:
sudo ufw status sudo ufw allow 7777 sudo ufw allow 8177 sudo ufw allow 9100 sudo ufw status
Rocky Linux firewall commands to check the firewall and open ports:
sudo firewall-cmd --zone=public --add-port=7777/tcp sudo firewall-cmd --zone=public --add-port=7777/udp sudo firewall-cmd --zone=public --add-port=8177/tcp sudo firewall-cmd --zone=public --add-port=8177/udp sudo firewall-cmd --zone=public --add-port=9100/udp sudo firewall-cmd --zone=public --add-port=9100/tcp sudo firewall-cmd --list-ports firewall-cmd --runtime-to-permanent
You may also need to allow Pings (ICMP) for the server's true latency to appear in the master list.
If you are running multiple servers and have set additional ports (see http://pavlovwiki.com/index.php/Setting_up_a_dedicated_server#Running_multiple_servers_on_one_host) then you need to allow access to the defined port plus the port 400 higher. So if you use 7000 as your port, then UDP 7000 and 7400 need to be open
Whilst on the topic of port forwarding, If you have setup rcon via RconSettings.txt (below) then that port also needs to be allowed access via TCP, if your RCON controller will be external to your server.
If you are running Shack/Quest and want to have maps that are downloadable from your server, your server ports (ex. 7777 & 8177) must also be open via TCP
ipv6 is not planned to be supported. You can disable by doing the following command:
sudo nano /etc/default/grub
And then edit the line below to GRUB_CMDLINE_LINUX_DEFAULT=”ipv6. disable=1″
This makes sure ipv6 is disabled on operating system restart.
Shack Maps (Quest)
Adding maps for the Shack version of Pavlov works differently to the steam version of the game, and you'll run into issues very quickly if you do not customise your server to accomodate this.
This is because Shack has no affiliation with Steam, and therefore cannot use Steam Workshop maps like the above. In the future, these steps will apply to PC servers as well, allowing a server to hold the map itself, instead of offloading it 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 I'll 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 itself): https://cyberduck.io/
- Next, download and unzip your map of choice
- You can get them 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
- This will be the same credentials you've used to connect to the server via SSH this whole time. - the username is typically `root` for Debian or Rocky systems, but you could also use the "steam" user if you set that user up with a password or private key to allow SSH.
- In the directory dropdown (it will say /root) navigate 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
- You'll 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 won't work. The 3 files (2 .PAK one .JSON) should be in home/steam/pavlovserver/Pavlov/Saved/maps/SVR_Cheeto_Items, no more, no less.
- Your map should now be ready to use, after you restart the game service (e.g. sudo systemctl restart pavlovserver.service).
Pavlov Shack servers load maps when the pavlovserver starts up.
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 server's automatic map rotation list, add the map's folder name to your Game.ini. This replaces the MapID section, so for our example, you would add the following line to your Game.ini above or below the other MapRotation lines:
If you have any trouble with the map loading (typically, the game will load into datacentre if there are problems) you may need to check the permissions of the map files, to ensure they belong to the user/group "steam:steam".
MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")
And that's all! Disconnect CyberDuck from your server before playing, otherwise you'll have difficulty joining.
Adding Shack Maps over Command Line Interface
A reminder that Pavlov Shack servers load maps when the pavlovserver starts up.
YOU MUST RESTART THE GAME SERVER TO USE THE MAPS.
This process is more complicated, but adding maps over the command line interface has its benefits
First, log into the server, change to the steam user, and CD to the maps directory you made above
sudo su steam cd ~/pavlovserver/Pavlov/Saved/maps
Download the map files from whatever you use to upload them. To do this, you can either use curl or wget
curl -O insertURLhere
If you download your map from Google Drive, make sure that your .zip folder is shared with anyone.
Then, get the file's URL from the shared link.
Example : https://drive.google.com/file/d/19bI8gUHaN5tUrDvnadAacUnchQf6_k/view
will be 19bI8gUHaN5tUrDvnadAacUnchQf6_k
Edit "fileId" and "fileName" before you execute the command.
fileId=19bI8gUHaN5tUrDvnadAacUnchQf6_k fileName=SVR_USER_MAPNAME curl -sc /tmp/cookie "https://drive.google.com/uc?export=download&id=${fileId}" > /dev/null code="$(awk '/_warning_/ {print $NF}' /tmp/cookie)" curl -Lb /tmp/cookie "https://drive.google.com/uc?export=download&confirm=${code}&id=${fileId}" -o ${fileName}
To keep with the Items example, we're downloading the file from a ZIP uploaded to discord:
curl -O https://cdn.discordapp.com/attachments/744185280759857234/745027406695366788/SVR_Cheeto_Items.zip
Next, unzip the file. If this next step errors out, saying the command is unknown, switch back to the root user (su root), and install unzip (sudo apt install unzip), then return to the steam user, and continue.
unzip SVR_Cheeto_Items.zip
Now finish like before by adding the map to your Game.ini
nano /home/steam/pavlovserver/Pavlov/Saved/Config/LinuxServer/Game.ini
MapRotation=(MapId="SVR_Cheeto_Items", GameMode="TDM")
Admin/Moderator list for Arctic-VR hosted servers (optional)
The only working in-game admin menu is through Arctic VR server hosting (see below).
If you add moderators to your server, they will not be subject to vote kicks.
nano ~/pavlovserver/Pavlov/Saved/Config/mods.txt
Example Mod List:
76541198397498572 #Optional Comment: Player name 76541198397498573 #Some Other Player
ArcticVR Admin Menu
Arctic-VR Offers an advanced In-Game Admin menu that is exclusive to their hosting service. Features include:
- Switch Maps+Modes
- Teleport Players to Players
- Change Player Skins
- Control Player Buying+Cash
- Spawn Items
- Clean up corpses + guns
- Spawn Bots
- Spawn Items for other players
- Control Teams + Balance/Shuffle Teams
- ResetSND
- And More
You can read more about the ArcticVR admin menu on their website: https://www.arctic-vr.com/server-admin-menu
Handy tools for finding steamIDs
Steam ID finder: https://steamidfinder.com/lookup/ or https://steamid.xyz/
You want to enter in the steamID64 format.
This tool can convert or lookup IDs: https://steamid.io/
If you are looking for a steamID of a player that has been on your server recently this is technique to find them:
grep -i playername ~/pavlovserver/Pavlov/Saved/Logs/* | grep TicketValidation
Configure Rcon
To enable Rcon access create config file:
nano /home/steam/pavlovserver/Pavlov/Saved/Config/RconSettings.txt
Copy in the following text - change password, and if desired the port:
Password=ChangeThisPassword Port=9100
You must specify a port for the Rcon server to use as well as a Password (use a different port per sever instance if running multiple server instances off the same hardware)
Starting the server manually
cd ~/pavlovserver && ./PavlovServer.sh
That's it, your server will be automatically broadcast to the master server! :)
Note that when you close your terminal, the server will go down. See the "supervisors" section below for how to prevent this.
If you have followed the supervisor service-setup part of the guide, you can run pavlovserver as a service using systemctl.
Seeing your server in a Master List
Two handy tools to determine quickly if your server is broadcasting are the Horde (Shack) and Horde (PC version) public listings.
If you're also handy with cURL, you can query the vankrupt game server listing directly, for Oculus/Shack servers, and PC servers:
- https://prod-shack-pavlov-ms.vankrupt.net/servers/v2/list/1.0.17/oculus_app_id/0/0/0/all
- https://prod-shack-pavlov-ms.vankrupt.net/servers/v2/list/1.0.17/oculus/0/0/0/all
- https://prod-crossplay-pavlov-ms.vankrupt.net/servers/v2/list/1.0.17/steam/0/0/0/all
where 1.0.17 is the version of the game. You can check the current version of the game your server is running by checking your log file (/home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log) and checking for the "version" line early in the startup of the log file.
The endpoint also supports filtering - changing the /0/0/0 in the URL will have the following effects:
- /1/0/0/ hide empty servers
- /0/1/0/ hide full servers
- /0/0/1/ hide password protected servers
You can also customize which gamemodes are shown by changing /all to /SND,TDM,DM,GUN,CUSTOM,ZWV,TTT,TTTCLASSIC,TANKTDM,WW2GUN,KOTH,OITC,HIDE,PH and removing what you don't want to view.
Supervising the server using systemd
Running ./PavlovServer.sh in your interactive shell is easy, but the server will shut down when you close your terminal. If you want to run the server in the background, you'll want to run it under a supervisor. There are many options, ranging from the simple (nohup, screen or tmux), to the more robust (supervisord, systemd).
Systemd is running by default on Ubuntu Linux, so we'll use that here.
To run the server as a systemd service, create the file /etc/systemd/system/pavlovserver.service (as root) by typing
sudo nano /etc/systemd/system/pavlovserver.service
Copy the contents below into the file and save.
[Unit] Description=Pavlov VR dedicated server [Service] Type=simple WorkingDirectory=/home/steam/pavlovserver ExecStart=/home/steam/pavlovserver/PavlovServer.sh RestartSec=1 Restart=always User=steam Group=steam [Install] WantedBy = multi-user.target
If you'd like your server to start as competitive without editing the game.ini, change the line "ExecStart=/home/steam/pavlovserver/PavlovServer.sh" to look like this below. Though it's much easier to just use the game.ini to enable competitive instead.
ExecStart=/home/steam/pavlovserver/PavlovServer.sh -COMPETITIVE=1
Change the user or paths as appropriate. After saving the service file, to start, restart, stop, or monitor the server:
sudo systemctl start pavlovserver sudo systemctl restart pavlovserver sudo systemctl stop pavlovserver sudo systemctl status pavlovserver
To view the logs:
sudo journalctl -u pavlovserver # to live-tail the logs sudo journalctl -u pavlovserver -f
If you want to run the pavlov server as soon as your server boots (e.g. a VPS you turn on and off), add pavlov as a startup service:
sudo systemctl enable pavlovserver
Advanced Server Administration
Running multiple servers on one host
- Pavlovserver is functionally single-threaded (there are multiple threads, but the vast majority of work occurs in the primary one). Make sure you have # of pavlovservers + 1 CPU available. More CPUs= more servers. Faster CPU = more players.
- Make multiple server installs by defining a separate install dir for each server.
- Run each server with a unique port. eg: ./PavlovServer.sh -PORT="Desired Port"
- The Server will use the Desired Port and the Port 400 above (Example: You choose 8200 as Port. So Port 8600 will be used as well)
- If you are using RCON, each server will need a unique port defined in RconSettings.txt
- Ensure the ports are forwarded and opened in your firewall
To duplicate directories:
be in the steam home folder
cp -r pavlovserver pavlovserver1 /home/steam/pavlovserver1/PavlovServer.sh -PORT=[Desired Port]
Starting server in competitive mode
Competitive mode will prevent dead teammates from being able to see the match, to prevent ghosting. You can either enable this via Game.ini (described in Game.ini file), or using the -COMPETITIVE=1 parameter.
/home/steam/pavlovserver1/PavlovServer.sh -COMPETITIVE=1
Useful Linux Commands
List files / folders in directory, print current working directory,
ls -la #list files/directories along with authorities and ownership pwd #print working directory sudo chown <owner> <file/directory> #change owner of file/directory. If root created something and you need to change it to steam sudo chgrp <group> <file/directory> #change group of file/directory.
Check if pavlov is running by checking process status. If the only row you see is the grep command, pavlov server is not started.
ps -ef | grep pav
Sample output:
steam 34044 1 0 16:52 ? 00:00:00 /bin/sh /home/steam/pavlovserver/PavlovServer.sh steam 34066 34044 80 16:52 ? 00:00:04 /home/steam/pavlovserver/Pavlov/Binaries/Linux/PavlovServer zombies+ 34101 34013 0 16:52 pts/0 00:00:00 grep --color=auto pav
Kill a process. Note this command uses 34044, which is a process id from the command output above.
kill -9 34044
Dump the log to the console so you can scroll through it:
cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log
Search the log for a string - replace my_string with case-sensitive string
cat /home/steam/pavlovserver/Pavlov/Saved/Logs/Pavlov.log | grep my_string
Advanced Scripts For Server Management
Auto-updating the server (PCVR only)
Assuming you have followed this guide and used the default paths, users, and install instructions, you can paste the following into your terminal to auto-update your Pavlov server:
cat << 'EOF' > $HOME/pavlov_daily_update_and_restart.sh #!/bin/bash USER="steam" SERVICENAME="pavlovserver.service" INSTALLDIRNAME="pavlovserver" USERHOME="/home/$USER" echo -e "Beginning Pavlov VR update run on $(date)\n\n" systemctl stop "$SERVICENAME" sleep 5 sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +force_install_dir "$USERHOME/$INSTALLDIRNAME" +app_update 622970 +exit sudo -iu "$USER" "$USERHOME/Steam/steamcmd.sh" +login anonymous +app_update 1007 +quit sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/.steam/sdk64/steamclient.so" sudo -iu "$USER" cp "$USERHOME/Steam/steamapps/common/Steamworks SDK Redist/linux64/steamclient.so" "$USERHOME/pavlovserver/Pavlov/Binaries/Linux/steamclient.so" systemctl start "$SERVICENAME" echo -e "Ending Pavlov VR update run on $(date)\n\n" EOF chmod +x $HOME/pavlov_daily_update_and_restart.sh mkdir $HOME/pavlov_update_logs && touch $HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log CRONLINE="00 2 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1" (sudo crontab -u root -l; echo "$CRONLINE" ) | sudo crontab -u root - unset CRONLINE
These commands will:
1. Create a shell script in the "steam" user's home directory that automatically stops the Pavlov server, pulls any updates via steam, pull updates to the Steamworks SDK Redist, and copies the latest version of steamclient.so to the Pavlov server directory
2. Make the shell script executable
3. Create a new directory called "pavlov_update_logs" in the "steam" user's directory, and create a logfile inside that directory called "pavlov_daily_update_and_restart.sh.log". You can check this logfile to see the output of the Pavlov and Steam SDK update commands.
4. Create a crontab entry for the root user that runs this shell script automatically every day at 2:00AM local time
If you want to change the time that this script runs, edit the numbers "00 2" in the line that starts with "CRONLINE=". In the example provided, 00 is the minutes column, and 2 is the hour column. For example, if you wanted the server to automatically update and restart at 4:17AM every day, change the line starting with "CRONLINE=" to:
CRONLINE="17 4 * * * $HOME/pavlov_daily_update_and_restart.sh >>$HOME/pavlov_update_logs/pavlov_daily_update_and_restart.sh.log 2>&1"
If the time is PM, use 24-hour time format, e.g. "32 18" for 6:32PM.
Save Logs for records and stats
this is an automated script that will on a timer save all the backups made by the server before they are purged by the game for admin records and starts collection
https://github.com/JTWP-org/backUpLogs2
Make an API request with Mod.io to get map picture and name
very basic script pass the script a map ID as an argument then it will give u the name and a thumbnail to use
https://github.com/JTWP-org/mod.io-modcheck/tree/main
Sharing Bans over gameserver on same machine
when you have a lot of servers keeping the bans synced can be a nightmare so using a symbolic link allows all the servers to use one file
for this lets say I have pavlovserver000 and pavlovserver001 and they are located at /home/steam/pavlovserver000 and /home/steam/pavlovserver001
step 1 will be to pick a blacklist to use as the new one and move it to a central location
mkdir ~/shared ; mv /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ~/shared/blacklist.txt ; rm /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now we have moved the blacklist from pavlovserver000 to a folder in our home called shared and then we removed the blacklist from pavlovserver001
step 2 making the links
ln -s ~/shared/blacklist.txt /home/steam/pavlovserver000/Pavlov/Saved/Config/blacklist.txt ; ln -s ~/shared/blacklist.txt /home/steam/pavlovserver001/Pavlov/Saved/Config/blacklist.txt
now editing them in pavlovserver001's files will update the list for all of the servers it's not a sync its uses the same list if you want to check where a link is pointed if u
ls -l
It will show where the file is really located
Interactive Update ALL
will find all server installs on machine and update them will update Ubuntu check what version and do correct updates for that version also UPDATE 29 PCVR STEP then it will list each server by server name and ask what type it is and then it will update and move to the next
https://github.com/JTWP-org/Pavlov-updateallservers/tree/main
getting map info with just the UGC
you will need to get a API key from mod.io for this ... running this bash script and passing a UGC number to it will return the map name mod.io url and a thumbnail
HOW TO USE
nano get-map.sh
then enter this script
#!/bin/bash ugc=000000 gameID=3959 #PAVLOV IS 3959 api-path="https://u-*ID NUMBER*.modapi.io/v1" #get on thhe access tab in mod.io settings api-key="" #get on thhe access tab in mod.io settings curl -X GET "${api-path}/v1/games/${gameID}/mods/$("${ugc:3})?api_key=${api-key}" -H 'Accept: application/json' | jq '.logo.thumb_1280x720, .name , .profile_url
then give script perms to run
sudo chmod +x get-map.sh
and then run it like this
bash get-map.sh UGC3409480