Server Configuration

From Squad Wiki
Jump to: navigation, search

Requirements[edit | edit source]

Windows[edit | edit source]

Visual C++ Redistributable for Visual Studio 2013 vc_redist.x64.exe
Visual C++ Redistributable for Visual Studio 2015 vc_redist.x64.exe
DirectX End-User Runtimes (June 2010)

Linux[edit | edit source]

GLIBC 2.17 or higher

AppID[edit | edit source]

403240

Installation[edit | edit source]

Windows[edit | edit source]

  1. Download SteamCmd and extract to your preferred directory.
  2. Open SteamCmd or create a .bat file with the following contents
SET STEAMCMD="C:\steamcmd\steamcmd.exe"
%STEAMCMD% +login anonymous +force_install_dir "C:\servers\squad_server" +app_update 403240 validate


Linux[edit | edit source]

First of all this guide assumes you've got a Linux Distribution installed with 64 bit architecture. Most hosting companies will run 64bit so not to worry.
Other than that, this guide needs no linux experience whatsoever and will be in completely "for dummies" mode.
Anything in this guide that comes after the symbol $ is a command that you're supposed to run in the linux terminal.
PROTIP: The linux terminal autocompletes with TAB. So if you have a file or folder called "testfolder" you can write "test" and press tab and it will autofill to testfolder!
A suggested software to use to connect to your linux server terminal is PUTTY. https://the.earth.li/~sgtatham/putty/latest/w64/putty.exe


Any questions? Contact [M] Nordic Socialist on Discord, you can find me in the Squad Hosting discord http://discord.me/squadhosting or www.mumblerines.com/discord
All right, let's get started:
INSTALLING SERVER:
1. Log in as root and install the software screen and a library needed for SteamCMD

    Debian/Ubuntu: $apt-get install screen
                   $apt-get install lib32gcc1
    CentOS: $yum -y install screen
            $yum -y install lib32gcc1

2. Create a user you want to use for the squadservers.

    $adduser username

Enter a password for the user of your own choosing. You may have to change the password with "sudo passwd username" When prompted for full name, room number, work phone, home phone, and other just press enter. When asked if information is correct write Y and press enter 3. Log on to the new user account: ssh username@localhost and then the password you selected. 4. Make a directory named SquadServer

 
    $mkdir SquadServer

5. Enter the folder

    $cd SquadServer

6. Make a folder for the first server instance

    $mkdir server1

7. Download SteamCMD

    $wget https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz
    

8. Unpack steamCMD

    $tar zxvf steamcmd_linux.tar.gz

9. Create a script for installing (And later updating) the first serverinstance

    $nano updateserver1.sh - This opens a text editor.
    
    Copy paste the following into the file: "./steamcmd.sh +login anonymous +force_install_dir server1 +app_update 403240 validate"
    
    Close the file and save by pressing ctrl+o and hitting enter. Exit by pressing ctrl+x

10. Make files in the folder executeable

    $chmod +x *

11. Install the server instance (this same command is used later to update the server when a new version is released.)

    $./updateserver1.sh

12. When it's finished it will say "Success! App '403240' fully installed." Quit SteamCMD by writing

    $exit and hitting enter

13. Create a script for starting the server instance

    $nano startserver1.sh

14. Copy paste the following into the file:

cd server1; ./SquadServer.sh Port=7787 QueryPort=27165 FIXEDMAXPLAYERS=80 RANDOM=NONE

15. Save and close the file by pressing ctrl+o > Enter > Ctrl+X
16. Make the script and the server folder executeable

    $chmod +x startserver1.sh
    $chmod +x server1

17. Open a screen window to run the server in then enter that screen

    $screen -dmS server1
    $screen -r server1

18. Start your server

    $./startserver1.sh 
    

Screen allows the server to run even if you've shut down your SSH session (putty). EDITING CONFIG FILES: 1. Log on as your the user account running the server and go into the Serverconfig folder located in SquadServer/server1/Squad/ServerConfig in our example.

    $ cd SquadServer
    $ cd server1
    $ cd Squad
    $ cd ServerConfig

2. Open the file you wish to edit with NANO.

    $nano server.cfg

Edit file. When you're done, save the file with ctrl+o and then enter. Exit nano with ctrl+X. STOPPING SERVER: 1. SSH to your linux server as the user running the squadserver. (Not root) Once in the terminal, open up the screen for said server instance, in above example called server1

    $screen -r server1

2. You will now see the SquadServer log window, press CTRL+C and it will shut the server down. After that you can start it again with your startcommand.

Tips[edit | edit source]

Make sure Steam Client is closed. If its open Squad Server will not run. For support issues related to server hosting please visit our Discord Server https://discord.gg/0Z8icdJWCH1u0pYj

Ports to Open[edit | edit source]

Port = Game port = UDP (Default 7787 UDP) May even need to do Port + 1 as well in firewall.
QueryPort = Steam query port = UDP (Default 27165 UDP)
QueryPort+1 = Second Steam query port = UDP and TCP (Default 27166 UDP and TCP)

Command Line[edit | edit source]

MultiHome = The IP Address you want to bind the server to.
Port = Game port
QueryPort = Steam query port
RANDOM = Randomize map rotation (ALWAYS, FIRST, NONE) (Optional)
FIXEDMAXPLAYERS = Player count cannot go higher than this (Optional)
FIXEDMAXTICKRATE = MAX server tickrate (Optional)
PREFERPREPROCESSOR = CPU Affinity (Optional) UNTESTED
-log = Display a log window on the server (Optional)
-fullcrashdump = Save a full dump file on crash (can become quite large sometimes) (Optional)

Create a .bat file with the following. This bat file will be used to launch the game server. You will not see a window, but can confirm it is running by watching the process and logs.
start SquadServer.exe MULTIHOME=1.2.3.4 Port=7787 QueryPort=27165 FIXEDMAXPLAYERS=50 RANDOM=ALWAYS -log
You can also use the start-command for e.g. setting the core affinity for each server (if you run several servers on one machine):
start /AFFINITY 0xC0 /WAIT SquadServer.exe MULTIHOME=1.2.3.4 Port=7787 QueryPort=27165 FIXEDMAXPLAYERS=50 RANDOM=ALWAYS -log
To calculate the core affinity for a 8 core CPU, you need a 8-bit mask and calculate the binary value into a hexadecimal value. Sounds difficult, but is very easy. The bit mask looks like this:
11111111
In this case all CPU cores would be used (default). The order of the cores is right to left like this:
87654321
That means if you want to just use the cores 4 and 3 for your server, your bit mask has to look like this:
00001100

Now open your windows calculator and enable „programmer“ mode. On the left side you see some abbreviations. Select „BIN“. Now type in „1100“ (the 4 leading zeros are not needed). Press on „HEX“ now. The shown result should be „C“. For our /AFFINITY parameter we need then „0x0C“ to set the core affinty to cores 3 and 4 for our server.

Firewall[edit | edit source]

Allowing both of the SquadServer.exe files through the firewall will save you headaches. Default locations:
Steam\steamapps\common\Squad Dedicated Server\SquadServer.exe
Steam\steamapps\common\Squad Dedicated Server\Squad\Binaries\Win64\SquadServer.exe

Files[edit | edit source]

Configuration files are located in C:\servers\squad_server\Squad\ServerConfig\ Configuration files located in this directory are

Admins.cfg
Bans.cfg
License.cfg
MapRotation.cfg
Rcon.cfg
RemoteAdminListHosts.cfg
RemoteBanListHosts.cfg
Server.cfg
ServerMessages.cfg

Adding Admins in Admins.cfg[edit | edit source]

Admins are now created by groups and groups are assigned to admins. You can create as many groups as you want with any types of permissions. All the permissions will be in the config file commented out. These files will not be over writeable so when we add new permissions you will need to check here or the wiki for updates. The below are just examples. Please note that it needs to be SteamId64. You can convert your ID at steamid.io/lookup/

Group=SuperAdmin:changemap,cheat,private,balance,chat,kick,ban,config,cameraman,debug,pause
Group=Admin:changemap,balance,chat,kick,ban,cameraman,pause
Group=Moderator:changemap,chat,kick,ban
Admin=76561115695178:Moderator //Player 5
Admin=8915618948911:Moderator //Player 4
Admin=7894591951519:Admin //Player 3
Admin=7984591565611:SuperAdmin //Player 2
Admin=917236241624:SuperAdmin //Player 1
Admin=45365435431:Admin //Player 8792 

Bans in Bans.cfg[edit | edit source]

This is where your bans will go. They need to be in the format of steamid:unix timestamp of unban //comment So an example file will look like this

76561198039509812:0 //Permanent ban for cheating
7862895148978485:1454455855 //team killing

Make sure if you manually add / remove a ban that the file ends with a new line character. Each ban goes on its own line.

Map Rotation in MapRotation.cfg[edit | edit source]

If you add the general map names (such as below without a specific game mode). Our parser will do all variations of it including AAS, INS, etc. Map names can be seen from the DefaultGame.ini file. Each map entry goes on a new line.

Logar
Kohat
OP First Light
Chora
Fool's Road
Sumari
Gorodok
Yehorivka
Jensen's Range
Kokan

If you want a specifc map version you can add the below into the rotation file

Al Basrah
Al Basrah AAS v1
Al Basrah Invasion v1
Al Basrah PAAS v1
Chora
Chora AAS v1
Chora AAS v2
Chora INS v1
Chora Invasion v1 Night
Chora PAAS v1
Fool's Road
Fool's Road AAS v1
Fool's Road AAS v1 INF
Fool's Road AAS v2
Fool's Road AAS v3
Fool's Road Skirmish
Gorodok
Gorodok AAS v1
Gorodok AAS v1 INF
Gorodok AAS v2
Gorodok Conquest v1
Gorodok Invasion v1
Jensen's Range
Kohat
Kohat AAS v1
Kohat AAS v1 INF
Kohat INS v1
Kohat Invasion v1
Kokan
Kokan AAS v1
Kokan AAS v2
Kokan INS v1
Kokan PAAS v1
Logar
Logar PAAS v1
Logar Valley AAS v1
Logar Valley AAS v1 INF
Logar Valley INS v1
Logar Valley INS v1 Night
Narva
Narva PAAS v1
Narva Invasion v1
Narva AAS v1
Op First Light
Op First Light AAS v1
Op First Light Conquest v1
Sumari
Sumari AAS v1
Sumari AAS v1 INF
Sumari AAS v2
Sumari AAS v3
Sumari INS v1
Sumari ITC v1
Yehorivka
Yehorivka AAS v1
Yehorivka AAS v1 INF
Yehorivka AAS v2
Yehorivka Conquest v1
Yehorivka Invasion v1

Remote Admin Lists in RemoteAdminListHosts.cfg[edit | edit source]

Each line should contain a URL to the admin file. The admin file will follow the exact same format as above. This should be used if you run multiple servers and would like to have a single admin file for all of them. If a player is listed in multiple files, their permissions will be combined.

Remote Ban Lists in RemoteBanListHosts.cfg[edit | edit source]

Each line should contain a URL to the ban file. The ban file will follow the exact same format as above. This should be used if you run multiple servers and would like to have a single admin file for all of them.

Server Configuration Settings in Server.cfg[edit | edit source]

This is the general server config file. Each variable should be on its own line. New additions will be added to this wiki. Since we do not overwrite config files you will need to manually add them to your existing server config if you wish to alter the default value.

ServerName="Squad Dedicated Server"
MaxPlayers=40
NumReservedSlots=0
IsLANMatch=false
ShouldAdvertise=true
NumPlayersDiffForTeamChanges=3
AllowTeamChanges=true
PreventTeamChangeIfUnbalanced=true
EnforceTeamBalance=true
RejoinSquadDelayAfterKick=180
AllowCommunityAdminAccess=true
RecordDemos=false
ServerMessageInterval=300
ServerPassword=Password
AllowQA=false

Server Messages in ServerMessages.cfg[edit | edit source]

This will rotate server messages every x seconds (based on Server.cfg setting). Each message should have its own line. This should be used to display server rules and contact information.

Rcon control in Rcon.cfg[edit | edit source]

If you do not want to use RCON, leave the password= empty. NOTE: Leaving the RCONIP=0.0.0.0 will bind it to the public default IP. If your server has multiple IP's please specify the address here.

// Edit this IP to bind the RCON socket to an alternate IP address.
// Alternatively, set this from the command line with the argument:
//   RCONIP=0.0.0.0
IP=0.0.0.0
// Edit this IP to bind the RCON socket to an alternate port.
// Alternatively, set this from the command line with the argument:
//   RCONPORT=21114
Port=21114
// Set this to enable the usage of RCON with the given password for login.
// Leaving this empty will keep RCON turned off.
// Alternatively, set this from the command line with the argument:
//   RCONPASSWORD=MyPassword
Password=
// Set this to set the maximum number of allowable concurrent RCON
// connections to the server.
// Alternatively, set this from the command line with the argument:
//   RCONMAXCONNECTIONS=5
MaxConnections=5
// Edit this to customize the number of seconds without contact from a connected
// console before the server checks with that computer to see if the session is
// still active, or if it got disconnected. Supports values between 30 and 3600.
// Alternatively, set this from the command line with the argument:
//   RCONSECONDSBEFORETIMEOUTCHECK=120
SecondsBeforeTimeoutCheck=120

Tournament Mode[edit | edit source]

Inside of Game.ini add / edit the following to enable / disable tournament mode

[/Script/Squad.SQGameMode]
bTournamentMode=true