Difference between revisions of "Server Hosting"

From Holdfast: Nations At War
Jump to navigation Jump to search
(→‎Download using SteamCMD: Adds support information for A2S queries.)
 
(27 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The following documentation details how to host a public or private gameserver for [[Holdfast: Nations At War]]. The game only offers a dedicated server for Linux, however you can still host a Windows gameserver using a full copy of the game.
+
The following documentation details how to host a public or private game server for [[Holdfast: Nations At War]]. The game offers an anonymous dedicated server for both Linux and Windows.
 +
 
 +
== Quick Start Guide ==
 +
Quick start guide for local testing:
 +
 
 +
# Download <code>Holdfast: Nations At War - Dedicated Server</code> from Steam (<code>Tools</code> Section)
 +
# Change the map rotation file (<code>serverconfig_default.txt</code>) and add mods or change maps.
 +
# Launch the server using the <code>LaunchServer.ps1</code> (Windows) or <code>LaunchServer.sh</code> (Linux) file
 +
 
 +
* In Holdfast's server browser click on "Join Custom Server", then click on the top "Connect" (leave localhost and change the port if required).
 +
* If you want other players to be able to connect, you likely have to setup port forwarding on your router and open the ports in your local firewall.
 +
'''Warning: Game updates will overwrite the changes to the <code>LaunchServer</code> script and <code>serverconfig_default.txt</code>. If you want to prevent this, create copies of both files and change the arguments of your custom <code>LaunchServer</code> script to point to your <code>serverconfig</code> file.'''
  
 
==Windows==
 
==Windows==
 
===Obtaining the game files===
 
===Obtaining the game files===
====Downloading using Steam Client====
+
====Download using Steam Client====
=====Steam library application=====
 
 
The easiest way to get access to server files would be to download though Steam, using the <code>Holdfast: Nations at War - Dedicated Server</code> app that will be in your Steam library.
 
The easiest way to get access to server files would be to download though Steam, using the <code>Holdfast: Nations at War - Dedicated Server</code> app that will be in your Steam library.
  
 
To get started, navigate to your Steam library in the Steam Client.
 
To get started, navigate to your Steam library in the Steam Client.
Select either Tools in the drop down list, or simply search <code>holdfast</code> into the search box, and you will be presented with three options.
+
 
 +
Select either Tools in the drop down list, or simply search <code>holdfast</code> into the search box (you might need to Tick "Tools" at the top of the list for the dedicated server to become visible), and you will be presented with three options.
 +
 
 
Download the application named <code>Holdfast: Nations at War - Dedicated Server</code>
 
Download the application named <code>Holdfast: Nations at War - Dedicated Server</code>
 +
 
Once downloading is complete, right click on the list in Steam > Manage > Browse local files.
 
Once downloading is complete, right click on the list in Steam > Manage > Browse local files.
 
{|style="margin: 0 auto;"
 
{|style="margin: 0 auto;"
Line 16: Line 29:
 
|}
 
|}
  
=====Copying base game files=====
+
====Download using SteamCMD====
[[File:FolderStructure2.jpg|thumb|Holdfast game files folder structure]]
 
 
 
Obtaining the game files can be done via the regular [https://store.steampowered.com/about/ Steam Client]. Download the game and copy the files to another folder. It's not recommended to use the SteamApps location as a base for the gameserver, as this might lead to file corruption if a game update overwrites files whilst the server is running.
 
 
 
This is the default directory where the [[Holdfast: Nations At War]] game files are located:
 
<pre>
 
C:\Steam\steamapps\common\Holdfast Nations At War
 
</pre>
 
Copy the files to the following location:
 
<pre>
 
C:\holdfastserver
 
</pre>
 
 
 
====Downloading using SteamCMD====
 
 
The '''Steam Console Client''' or [https://developer.valvesoftware.com/wiki/SteamCMD '''SteamCMD'''] is a command-line version of the Steam client. Its primary use is to install and update various dedicated servers available on Steam using a command-line interface. It works with games that use the SteamPipe content system. All games have been migrated from the deprecated HLDSUpdateTool to [https://developer.valvesoftware.com/wiki/SteamCMD '''SteamCMD''']. This is usually required if you are forced to use a terminal for your server setup. You can find instructions on how to download [https://developer.valvesoftware.com/wiki/SteamCMD '''SteamCMD'''] here: https://developer.valvesoftware.com/wiki/SteamCMD#Windows
 
The '''Steam Console Client''' or [https://developer.valvesoftware.com/wiki/SteamCMD '''SteamCMD'''] is a command-line version of the Steam client. Its primary use is to install and update various dedicated servers available on Steam using a command-line interface. It works with games that use the SteamPipe content system. All games have been migrated from the deprecated HLDSUpdateTool to [https://developer.valvesoftware.com/wiki/SteamCMD '''SteamCMD''']. This is usually required if you are forced to use a terminal for your server setup. You can find instructions on how to download [https://developer.valvesoftware.com/wiki/SteamCMD '''SteamCMD'''] here: https://developer.valvesoftware.com/wiki/SteamCMD#Windows
  
Line 42: Line 41:
 
: You might need to enter a ''2-Factor Auth Code'' during this step.
 
: You might need to enter a ''2-Factor Auth Code'' during this step.
 
: In case the server ever  stops working you can run the command with ''+app_update 589290 validate'' to verify the game files.
 
: In case the server ever  stops working you can run the command with ''+app_update 589290 validate'' to verify the game files.
 
===Obtaining the server files===
 
 
Download the server files from the link below and extract them over to the C:\holdfastserver folder on your server box.
 
 
[https://www.dropbox.com/sh/ppkfny3r9kcnz8x/AADiIXOrlAWPh-XbhPpimw0ja?dl=0 From Dropbox]
 
 
You can also download the folder from Baidu. This is especially useful for server hosts located in China were access to Dropbox might be blocked.This might not always be up to date with the latest version.
 
 
[https://pan.baidu.com/s/1qYqNnty From Baidu]
 
 
'''''Note:''' These files change from time to time but not necessarily every update, only reapply them if the server stops working after an update.''
 
  
 
===Basic Configuration & Starting the Server===
 
===Basic Configuration & Starting the Server===
 
[[File:FolderStructure.jpg|thumb|Holdfast merged server & game files folder structure]]
 
[[File:FolderStructure.jpg|thumb|Holdfast merged server & game files folder structure]]
  
The server files come with a selection of example serverconfigs that show off how to setup various maps and gamemodes. Consult the [[Server_Configuration|Server Configuration]] page to find out more about modifying the server config.
+
The server files come with a selection of example server configs that show off how to setup various maps and game modes. Consult the [[Server_Configuration|Server Configuration]] page to find out more about modifying the server config.
  
Duplicate one of the example configs and one of the server .bats, for example:
+
Duplicate the example config <code>serverconfig_server_default.txt</code> and the launch script <code>LaunchServer.ps1</code>
  
 
<pre>
 
<pre>
serverconfig_server1_armybattlefield.txt -> serverconfig_server1_newserver.txt
+
serverconfig_default.txt -> serverconfig_newserver.txt
start_server1_armybattlefield_headless.bat -> start_server1_newserver_headless.bat
+
LaunchServer.ps1 -> LaunchServer_newserver.ps1
 
</pre>
 
</pre>
  
Line 70: Line 57:
  
 
<pre>
 
<pre>
### Server & Steam Ports (All 3 ports must be unique per server instance).
+
### Server & Steam Ports (Both ports must be unique per server instance).
 
server_port 20100
 
server_port 20100
steam_communications_port 8700
 
 
steam_query_port 27000
 
steam_query_port 27000
 
</pre>
 
</pre>
  
Notes:
+
'''Notes:'''
:Make sure to open the appropriate firewall ports both for TCP and UDP!
+
:Make sure to open the appropriate firewall ports for UDP!
:[[Holdfast: Nations At War|Holdfast]] gameservers respond, when correctly configured, to [https://developer.valvesoftware.com/wiki/Server_queries A2S Queries] on the ''steam_query_port''. Returning map, player count and player information when requested.
+
:Holdfast game servers respond, when correctly configured, to [https://developer.valvesoftware.com/wiki/Server_queries A2S Queries] on the ''steam_query_port''. Returning map, player count and player information when requested.
 +
:Official Holdfast game servers are not configured to respond to A2S Queries. This feature is only supported by community game servers.
  
 
Basic trivial variables:
 
Basic trivial variables:
 
<pre>
 
<pre>
server_name New Server - Army Battlefield
+
server_name My Server
server_welcome_message Welcome to my new game server!
+
server_region europe #
server_region europe
+
server_admin_password defaultAdminPWReplace
server_admin_password ChangeThisPassword
+
#server_password mypassword
#server_password ChangeThisPassword
 
 
</pre>
 
</pre>
  
Networking setup (loosely "low / high tick" settings):
+
Edit the <code>LaunchServer_newserver.ps1</code> to use your newly created config:
 
<pre>
 
<pre>
# LowLatency = Reduced packet rate on close-range (high player count)
+
$args = '-s -r --serverConfigFilePath "serverconfig_newserver.txt" --outputLog "logs_output\outputlog_newserver.txt" --logArchivesDirectory "logs_archive" --framerate 120 --serverheadless --adminCommandLogFilePath "logs_adminactions\adminlog_newserver.txt" --chatLogFilePath "logs_chat\chatlog_newserver.txt" --playersLogFilePath "logs_playerlogin\playerlogin_newserver.txt" --scoreboardLogFilePath "logs_score\scorelog_newserver.txt"'
# HighAccuracy = Increased packet rate on close-range (low player count)
 
network_broadcast_mode LowLatency
 
</pre>
 
  
Edit the ''start_server1_newserver_headless.bat'' to mount your newly created config:
+
Start-Process -FilePath "vapuriloadtester.exe" -Verb RunAs -ArgumentList $args
<pre>
 
start "New Server" /affinity 3 "vapuriloadtester.exe" -s --serverConfigFilePath "serverconfig_server1_newserver.txt" --outputLog "logs_output\outputlog_server1_newserver.txt" --adminCommandLogFilePath "logs_adminactions\adminactions_server1_newserver.txt" --logArchivesDirectory "logs_archive" --framerate 120 --serverheadless
 
 
</pre>
 
</pre>
  
You can now launch gameserver by starting the ''start_server1_newserver_headless.bat''.
+
You can now launch gameserver by starting the <code>LaunchServer_newserver.ps1</code>.
  
 
==Linux==
 
==Linux==
Line 116: Line 97:
 
If you want to launch another instance you can increment the environment variables, using -e (--env):
 
If you want to launch another instance you can increment the environment variables, using -e (--env):
 
<pre>
 
<pre>
docker run -d --net=host -e SERVER_PORT=20100 -e STEAM_COM_PORT=8700 -e STEAM_QUERY_PORT=27000 --name=holdfastnaw-dedicated cm2network/holdfastnaw
+
docker run -d --net=host -e SERVER_PORT=20100 -e STEAM_QUERY_PORT=27000 --name=holdfastnaw-dedicated cm2network/holdfastnaw
 
</pre>
 
</pre>
  
Line 123: Line 104:
  
 
===Manual Setup===
 
===Manual Setup===
 
===Download Requirements===
 
====Ubuntu & Debian====
 
Install requirements:
 
<pre>
 
$ apt-get update \
 
&& apt-get install -y \
 
libsqlite3-0 \
 
wget \
 
ca-certificates
 
</pre>
 
 
If you want to perform a cleanup run the following command (recommended if run inside of container):
 
<pre>
 
$ apt-get clean autoclean \
 
&& apt-get autoremove -y \
 
&& rm -rf /var/lib/apt/lists/*
 
</pre>
 
  
 
===Obtaining the game files===
 
===Obtaining the game files===
Line 172: Line 135:
  
 
<pre>
 
<pre>
### Server & Steam Ports (All 3 ports must be unique per server instance).
+
### Server & Steam Ports (Both ports must be unique per server instance).
 
server_port 20100
 
server_port 20100
steam_communications_port 8700
 
 
steam_query_port 27000
 
steam_query_port 27000
 
</pre>
 
</pre>
  
 
Notes:
 
Notes:
:Make sure to open the appropriate firewall ports both for TCP and UDP!
+
:Make sure to open the appropriate firewall ports for UDP!
:[[Holdfast: Nations At War|Holdfast]] gameservers respond, when correctly configured, to [https://developer.valvesoftware.com/wiki/Server_queries A2S Queries] on the ''steam_query_port''. Returning map, player count and player information when requested.
+
:Holdfast gameservers respond, when correctly configured, to [https://developer.valvesoftware.com/wiki/Server_queries A2S Queries] on the ''steam_query_port''. Returning map, player count and player information when requested.
  
 
Basic trivial variables:
 
Basic trivial variables:
Line 190: Line 152:
 
</pre>
 
</pre>
  
Networking setup (loosely "server tick" settings):
+
You can then start the server using the following commands:<pre>
<pre>
 
# LowLatency = Reduced packet rate on close-range (high player count)
 
# Balanced = Balanced packet rate on close-range (medium-high player count)
 
# HighAccuracy = Increased packet rate on close-range (low player count)
 
# Realtime = Increased packet rate on close-range (very low player count / competitive setting)
 
network_broadcast_mode Balanced
 
</pre>
 
 
 
You can then start the server using the following commands:
 
 
 
<pre>
 
 
# Start holdfast server
 
# Start holdfast server
 
"./Holdfast NaW" -startserver \
 
"./Holdfast NaW" -startserver \

Latest revision as of 11:30, 30 September 2024

The following documentation details how to host a public or private game server for Holdfast: Nations At War. The game offers an anonymous dedicated server for both Linux and Windows.

Quick Start Guide

Quick start guide for local testing:

  1. Download Holdfast: Nations At War - Dedicated Server from Steam (Tools Section)
  2. Change the map rotation file (serverconfig_default.txt) and add mods or change maps.
  3. Launch the server using the LaunchServer.ps1 (Windows) or LaunchServer.sh (Linux) file
  • In Holdfast's server browser click on "Join Custom Server", then click on the top "Connect" (leave localhost and change the port if required).
  • If you want other players to be able to connect, you likely have to setup port forwarding on your router and open the ports in your local firewall.

Warning: Game updates will overwrite the changes to the LaunchServer script and serverconfig_default.txt. If you want to prevent this, create copies of both files and change the arguments of your custom LaunchServer script to point to your serverconfig file.

Windows

Obtaining the game files

Download using Steam Client

The easiest way to get access to server files would be to download though Steam, using the Holdfast: Nations at War - Dedicated Server app that will be in your Steam library.

To get started, navigate to your Steam library in the Steam Client.

Select either Tools in the drop down list, or simply search holdfast into the search box (you might need to Tick "Tools" at the top of the list for the dedicated server to become visible), and you will be presented with three options.

Download the application named Holdfast: Nations at War - Dedicated Server

Once downloading is complete, right click on the list in Steam > Manage > Browse local files.

Steam Application you need to download
Browse local files on Steam client

Download using SteamCMD

The Steam Console Client or SteamCMD is a command-line version of the Steam client. Its primary use is to install and update various dedicated servers available on Steam using a command-line interface. It works with games that use the SteamPipe content system. All games have been migrated from the deprecated HLDSUpdateTool to SteamCMD. This is usually required if you are forced to use a terminal for your server setup. You can find instructions on how to download SteamCMD here: https://developer.valvesoftware.com/wiki/SteamCMD#Windows

The files can then be obtain using the following batch command:

$ steamcmd +login [LOGINNAME] [PASSWORD] +force_install_dir "C:\holdfastserver" +app_update 589290 +quit

Notes:

+anonymous will fail because the account requires to own a copy of the game to download the game files!
You might need to enter a 2-Factor Auth Code during this step.
In case the server ever stops working you can run the command with +app_update 589290 validate to verify the game files.

Basic Configuration & Starting the Server

Holdfast merged server & game files folder structure

The server files come with a selection of example server configs that show off how to setup various maps and game modes. Consult the Server Configuration page to find out more about modifying the server config.

Duplicate the example config serverconfig_server_default.txt and the launch script LaunchServer.ps1

serverconfig_default.txt -> serverconfig_newserver.txt
LaunchServer.ps1 -> LaunchServer_newserver.ps1

This will make sure that if you ever have to reapply the server files, the server config will not be overwritten. Open the new config file using your favorite Notepad or Notepad++ and configure the basic server settings:

### Server & Steam Ports (Both ports must be unique per server instance).
server_port 20100
steam_query_port 27000

Notes:

Make sure to open the appropriate firewall ports for UDP!
Holdfast game servers respond, when correctly configured, to A2S Queries on the steam_query_port. Returning map, player count and player information when requested.
Official Holdfast game servers are not configured to respond to A2S Queries. This feature is only supported by community game servers.

Basic trivial variables:

server_name My Server
server_region europe #
server_admin_password defaultAdminPWReplace
#server_password mypassword

Edit the LaunchServer_newserver.ps1 to use your newly created config:

$args = '-s -r --serverConfigFilePath "serverconfig_newserver.txt" --outputLog "logs_output\outputlog_newserver.txt" --logArchivesDirectory "logs_archive" --framerate 120 --serverheadless --adminCommandLogFilePath "logs_adminactions\adminlog_newserver.txt" --chatLogFilePath "logs_chat\chatlog_newserver.txt" --playersLogFilePath "logs_playerlogin\playerlogin_newserver.txt" --scoreboardLogFilePath "logs_score\scorelog_newserver.txt"'

Start-Process -FilePath "vapuriloadtester.exe" -Verb RunAs -ArgumentList $args

You can now launch gameserver by starting the LaunchServer_newserver.ps1.

Linux

Docker

If your server is running Docker, you can simply use:

docker run -d --net=host --name=holdfastnaw-dedicated cm2network/holdfastnaw

The container will automatically update the game on startup, so if there is a game update just restart the container.

The config is located here: /home/steam/holdfastnaw-dedicated/

If you want to launch another instance you can increment the environment variables, using -e (--env):

docker run -d --net=host -e SERVER_PORT=20100 -e STEAM_QUERY_PORT=27000 --name=holdfastnaw-dedicated cm2network/holdfastnaw

You can find the associated Docker Hub page here: https://hub.docker.com/r/cm2network/holdfastnaw/

Manual Setup

Obtaining the game files

Downloading using SteamCMD

The Steam Console Client or SteamCMD is a command-line version of the Steam client. Its primary use is to install and update various dedicated servers available on Steam using a command-line interface. It works with games that use the SteamPipe content system. All games have been migrated from the deprecated HLDSUpdateTool to SteamCMD. This is usually required if you are forced to use a terminal for your server setup. You can find instructions on how to download SteamCMD here: https://developer.valvesoftware.com/wiki/SteamCMD#Linux

The dedicated server can then be obtain using the following bash command:

$ steamcmd.sh \
        +login anonymous \
        +force_install_dir /opt/holdfastserver \
        +app_update 1424230 +quit

Notes:

In case the server ever stops working you can run the command with +app_update 1424230 validate to verify the game files.

Basic Configuration & Starting the Server

The dedicated server comes with an example server config that shows off how to setup a basic game server. Consult the Server Configuration page to find out more about modifying server configs.

Duplicate the example config using the following command:

$ cd /opt/holdfastserver
$ cp serverconfig_default.txt serverconfig_myserver.txt

It's strongly advised to duplicate the "serverconfig_default.txt" as a game update or validate might overwrite the file.

Open the new config file using your favorite vim, nano or emacs and configure the basic server settings:

### Server & Steam Ports (Both ports must be unique per server instance).
server_port 20100
steam_query_port 27000

Notes:

Make sure to open the appropriate firewall ports for UDP!
Holdfast gameservers respond, when correctly configured, to A2S Queries on the steam_query_port. Returning map, player count and player information when requested.

Basic trivial variables:

server_name My Server
server_region europe #
server_admin_password defaultAdminPWReplace
#server_password mypassword

You can then start the server using the following commands:

# Start holdfast server
"./Holdfast NaW" -startserver \
		-batchmode \
		-nographics \
		-screen-width 640 \
		-screen-height 480 \
		-screen-quality "Fastest" \
		-framerate "120" \
		--serverheadless \
		-serverConfigFilePath "serverconfig_myserver.txt" \
		-logFile "logs_output/outputlog_server.txt" \
		-logArchivesDirectory "logs_archive/" \
		-p "20100"