Changes

Jump to navigation Jump to search

Documentation/Tools/Dedicated Server

2 bytes removed, 08:10, 13 December 2022
Normalized new lines.
You may get the following error when starting a server with Linux: `[S_API FAIL] SteamAPI_Init() failed; unable to locate a running instance of Steam, or a local steamclient.dll.`
To launch server on linux `steamclient.so` library is required. You can either use provided launch_server.sh script (located in folder next to to server executable) or create a link to this library using `ln -s steamcmd/linux64/steamclient.so ~/.steam/sdk64/steamclient.so`
 
=First launch=
Next you will receive following error: "<ERROR> [MP] Error: Server packages file not found. This is required to load proper map, DLCs and mods".
This means, you have to provide additional server configuration according to following steps.
 
=Required files to run dedicated server=
In config.cfg (found in game home directory) enable game console - uset g_console "1".
When game is running press `~` to open game console and run `export_server_packages` or `export_server_packages destination file` command. server_packages.sii will be generated in the game home folder. It is necessary for map to be loaded when this command is called. This will generate server_packages.sii and server_packages.dat. These files carry dlc and mod configuration based on your current game setup.
 
=Runnung server without game installed=
It will contain server.log.txt and server_config.sii. You have to provide generated server_packages.sii and server_packages.dat to this location.
=Data requirements=
=Data requirements=
Dedicated server does not require any additional dlc or mod data. Everything needed is handled via server_packages.sii and server_packages.dat files. It is not required to copy any additional files. As the dedicated server does not use steam client, it cannot access the workshop.
 
=Network address translation (NAT)=
To search for a server use serach field in game server browser.
=Port setup=
=Port setup=
`connection_virtual_port` and `query_virtual_port` are virtual ports used for connection to server. Allowed range is <100,200>.
`connection_dedicated_port` and `query_dedicated_port` are physical ports used by steam game server api to fill sessions browser. For LAN games query_dedicated_port has be in range of <27015,27020>.
For port forwarding both TPP/IP and UPD rules are required.
=Server logon token=
=Server logon token=
By default, whenever a dedicated server is launched it is using an anonymous account. For such an account non-persistent server id is generated (used for direct search). To avoid this you can acquire a logon token on https://steamcommunity.com/dev/managegameservers (game ownership is required). This token has to be placed into server_config.
server_logon_token: 6544F7E034119F113526E96474F
=Session moderators=
=Session moderators=
As the dedicated server does not have any form or user interface, it is not possible to promote any player to a moderator while the session is running. You can register moderators in server_config using their steam_id to automatically promote them once they join the session.
where 123456789 is moderator steam id
=Quality of life=
=Quality of life=
Any player who is a moderator can now change the game time or disable radin. This can be done via chat message box by sending message containing admin command.
Available admin commands are
=How to close server=
 
Press Ctrl + C.
=Troubleshooting=
=Troubleshooting=
In game home folder server.log.txt and server.crash.txt (when server crashes) files can be found to help solve any issue with a dedicated server.
=Known issues=
 
When server is closed with message:

Navigation menu