Server Hosting – Arma Reforger

From Bohemia Interactive Community
Jump to navigation Jump to search
(Update gameHostBindAddress, gameHostBindPort, gameHostRegisterBindAddress and gameHostRegisterPort)
m (Some wiki formatting)
 
(56 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{TOC|side}}
{{TOC|side}}
Server Hosting is the fact of hosting a game instance accessible over the network to other players.
Server Hosting is the fact of hosting a game instance accessible over the network to other players.
<!--
There are two possible modes in {{armaR}}: '''player-hosted''' and '''dedicated'''.
There are two possible modes in {{armaR}}: '''player-hosted''' and '''dedicated'''.
-->
 
 
{{Feature|important|
{{Feature|important|
As of {{armaR}} v0.9.5 two '''very important''' aspects of public server hosting are:
[[File:armar-port_fowarding_connection_failed.png|thumb|Connection fails from the outside if the door is closed.]]
* Set and keep {{HashLink|#fastValidation}} to {{hl|true}}
For a hosted server to be visible from outside the local network (e.g from internet), {{Link|https://en.wikipedia.org/wiki/Port_forwarding|Port Forwarding}} must be used.
* Limit Server's max FPS with the {{hl|[[Arma Reforger:Startup Parameters#maxFPS|-maxFPS]]}} startup parameter in order to save performance
 
}}
Please refer to your router's user guide for assistance.


== Player-Hosted Server ==


Also known as '''Listen Server''', a '''Player-Hosted Server''' is a server with a local client that plays on it too.
Main router brands's documentation links:
<!-- Such server can be started from within the game, in {{hl|Play > Host}} -->
* {{Link|https://www.cisco.com/c/en/us/support/docs/smb/routers/cisco-rv-series-small-business-routers/smb5818-configure-port-forwarding-port-triggering-nat-on-rv34x-serie.html|Cisco router}}
{{Feature|important|{{armaR}} does not allow for Player-Hosted Server as of v0.9.5.}}
* {{Link|https://www.dlink.com/uk/en/support/faq/routers/mydlink-routers/dir-810l/how-do-i-configure-port-forwarding-on-my-router|D-Link router}}
* {{Link|https://kb.netgear.com/24290/How-do-I-add-a-custom-port-forwarding-service-on-my-NETGEAR-router|Netgear router}}
* {{Link|https://www.tp-link.com/us/support/faq/1379/|TP-Link router}}
}}




Line 21: Line 23:
A '''Dedicated Server''' is a server without any game instance launched; it purely processes game information and network synchronisation.
A '''Dedicated Server''' is a server without any game instance launched; it purely processes game information and network synchronisation.


=== Ports ===


{| class="wikitable"
{{Feature|informative| stable is app id: '''1874900''' - https://steamdb.info/app/1874900/
! Protocol
 
! Port
 
! Description
experimental: '''1890870''' - https://steamdb.info/app/1890870/
|-
}}
| UDP
 
| 2001
=== BattlEye ===
| Game port
 
|-
{{Feature|informative|See {{Link|http://www.battleye.com/|BattlEye}}'s {{Link|https://www.battleye.com/support/documentation/|documentation}} and {{Link|https://www.battleye.com/support/faq/|FAQ}} - there is also a [[BattlEye]] wiki article.}}
| UDP
 
| 50000..65000
It is possible to modify BattlEye's RCon port and password by '''adding''' the following settings to {{hl|Arma Reforger\BattlEye\BEServer_x64.cfg}}:
| Steam communication ports
 
|-
RConPort 5678
| UDP
RConPassword myNewBEPassword
| 17777
 
| Steam Query protocol used to provide Steam with server status (amount of players, scenario name, etc)
{{Feature|warning|
|}
When editing {{armaR}}'s BattlEye config, make sure to '''append''' new settings to it and not ''erase'' or even ''edit'' existing information.<br>
Missing information will have the kick message "Missing GameID/MasterPort server config settings" welcome (and eject) players, whereas modified values will prevent BattlEye from working.<br>
In the event of the file being already incorrectly edited, verify the game's files on {{Link|https://steampowered.com/|Steam}} (see {{Link|https://help.steampowered.com/en/faqs/view/0C48-FCBD-DA71-93EB|Steam's tutorial}}):
* delete {{hl|BEServer_x64.cfg}}
* in Steam, right-click on {{armaR}}
* select "Properties"
* click on "Local Files"
* press "Verify integrity of game files"
Steam will now verify and repair modified files. This will not erase any personal files, game progress, controls and other configurations will remain unchanged.
}}


=== Startup Parameters ===
=== Startup Parameters ===


See {{HashLink|Arma Reforger:Startup Parameters#Hosting}} and the {{HashLink|#Configuration}} section below for more information.
See {{Link|Arma Reforger:Startup Parameters#Hosting}} and the {{Link|Arma Reforger:Server Config|Server Config}} page for more information.


==== config ====
==== config ====
The Server exe uses the {{hl|-config}} [[Arma Reforger:Startup Parameters|startup parameter]] to target the configuration file.
The Server exe uses the {{hl|-config}} {{Link|Arma Reforger:Startup Parameters|startup parameter}} to target the configuration file.
  ArmaReforgerServer.exe -config ".\Configs\Campaign_SWCoast.json"
  ArmaReforgerServer.exe -config ".\Configs\Campaign_SWCoast.json"
In above example, Campaign_SWCoast.json is expected to be locted in Configs folder next to the exe.
In above example, Campaign_SWCoast.json is expected to be locted in Configs folder next to the exe.


==== maxFPS ====
==== maxFPS ====
{{Feature|warning|As of '''0.9.5''' it is '''heavily recommended''' to use this [[Arma Reforger:Startup Parameters#maxFPS|startup parameter]], set to a value in the 60..120 range; otherwise, the server can try to use all the available resources!}}
{{Feature|warning|As of '''0.9.8''' it is '''heavily recommended''' to use {{Link|Arma Reforger:Startup Parameters#maxFPS|this}} {{Link|Arma Reforger:Startup Parameters|startup parameter}}, set to a value in the 60..120 range; otherwise, the server can try to use all the available resources!}}
  ArmaReforgerServer.exe -maxFPS 60
  ArmaReforgerServer.exe -maxFPS 60
==== server ====
This parameter instructs the executable to launch '''local''' server and '''load selected world'''. When this parameter is used, config is ignored. Server parameter can be combined with {{Link|Arma Reforger:Startup Parameters#addons|addons}} and {{Link|Arma Reforger:Startup Parameters#addonsDir|addonsDir}} parameters to start a server with local mods, which can be useful when testing addon before uploading it Workshop.
ArmaReforgerServer.exe -server "worlds/MP/MPTest.ent" -addonsDir "C:\MyModsDir" -addons MyCustomMod


==== Others ====
==== Others ====
Below [[Arma Reforger:Startup Parameters]] are optional but may prove useful upon some cases:
The below {{Link|Arma Reforger:Startup Parameters}} are optional but may prove useful upon some cases:
* [[Arma Reforger:Startup Parameters#logStats|logStats]] - allows to log server's FPS every x milliseconds
* {{Link|Arma Reforger:Startup Parameters#logStats|logStats}} - allows to log server's FPS every x milliseconds
* [[Arma Reforger:Startup Parameters#logLevel|logLevel]] - sets the log detail level
* {{Link|Arma Reforger:Startup Parameters#logLevel|logLevel}} - sets the log detail level
* [[Arma Reforger:Startup Parameters#maxFPS|maxFPS]] - sets a maximum FPS limit for the server - saving performance in some cases
* {{Link|Arma Reforger:Startup Parameters#listScenarios|listScenarios}} - logs available scenario {{hl|.conf}} file paths on startup
* [[Arma Reforger:Startup Parameters#listScenarios|listScenarios]] - logs available scenario {{|.conf}} file paths on startup


=== Configuration File ===
=== Configuration File ===
{{Feature|Informative|Parameters inside the JSON file are case-sensitive!}}
{{armaR}} uses JSON configuration format to run. A configuration file looks like this:


<syntaxhighlight lang="json">
See {{Link|Arma Reforger:Server Config}}.
{
"dedicatedServerId": "",
"region": "EU",
"gameHostBindAddress": "",
"gameHostBindPort": 2001,
"gameHostRegisterBindAddress": "",
"gameHostRegisterPort": 2001,
"adminPassword": "changeme",
"game": {
"name": "Server Name - Mission Name",
"password": "",
"scenarioId": "{ECC61978EDCC2B5A}Missions/23_Campaign.conf",
"playerCountLimit": 32,
"autoJoinable": false,
"visible": true,
"gameProperties": {
"serverMaxViewDistance": 2500,
"serverMinGrassDistance": 50,
"networkViewDistance": 1000,
"disableThirdPerson": true,
"fastValidation": true,
"battlEye": true,
"missionHeader": {
"m_iPlayerCount": 40,
"m_eEditableGameFlags": 6,
"m_eDefaultGameFlags": 6,
"other": "values"
}
},
"mods": [
{
"modId": "59727DAE364DEADB",
"name": "WeaponSwitching",
"version": "1.0.1"
},
{
"modId": "59727DAE32981C7D",
"name": "Explosive Goats beta",
"version": "0.5.42"
}
]
},
"a2sQueryEnabled": true,
"steamQueryPort": 17777
}
</syntaxhighlight>


Values are strings, unless mentioned otherwise.


===== dedicatedServerId =====
{{ArgTitle|2|Player-Hosted Server|{{GVI|armaR|0.9.7}}}}
Used by the "Favourite" system. If not provided, the backend will provide a new ID and save it to the config file. It is recommended to server administrators to store this ID safe to ensure to keep their playerbase in case of a server migration or a config accident.


{{{!}} class="wikitable sortable" style="float: right; margin: 0 0 0.5em 1.5em"
Also known as '''Listen Server''', a '''Player-Hosted Server''' is a server also hosting a local player.
{{!}}+ Common {{Wikipedia|ISO 3166-1 alpha-2}} values:
Such server is started from within the game, in {{hl|Multiplayer > Host tab > Host new server}}.
! Code
! Country
{{!}}-
{{!}} US
{{!}} USA
{{!}}-
{{!}} DE
{{!}} Germany
{{!}}-
{{!}} CN
{{!}} China
{{!}}-
{{!}} CZ
{{!}} Czech Republic
{{!}}-
{{!}} FR
{{!}} France
{{!}}-
{{!}} GB
{{!}} United Kingdom of Great Britain and Northern Ireland
{{!}}-
{{!}} RU
{{!}} Russian Federation
{{!}}-
{{!}} JP
{{!}} Japan
{{!}}-
{{!}} AU
{{!}} Australia
{{!}}}
===== region =====
ID / name of region - it is needed when the server registers the launched game in the Lobby. {{Wikipedia|ISO 3166-1 alpha-2}} code can be used in this field.
Usual Nitrado values:
* "EU-FFM"
* "US-LA"
* "US-MI"


===== gameHostBindAddress =====
{{Feature|PC|Player-hosting is only available on PC.}}
IP address which server socket will be bound to. In most cases, this should be left empty.
It can be used to restrict connections to particular network interface. When left out or empty, {{hl|0.0.0.0}} is used, which allows connections through any IP address.
{{Feature|important|IP'''v6''' is '''not''' supported by {{armaR}} v0.9.5.}}


===== gameHostBindPort =====
=== Settings ===
number value, range 1..65535, default: 2001


UDP port to which the server socket will be bound.
The settings are all self-explanatory and {{Link|#Dedicated Server}} can be used.


===== gameHostRegisterBindAddress =====
==== Scenario Selection ====
IP address registered in backend.
'''Scenario''' and '''Source''' are two related fields:
This should be set to the public IP address to which clients can connect in order to reach the server (either IP of the server itself or IP of the machine that will forward data to the server).
* '''Scenario''' is the list of all available scenarios
When left out or empty, an attempt is made to automatically determine the IP address, but this will often fail and should not be relied upon as the server might not be reachable from public networks.
* '''Source''' is a read-only field telling from which mod (or {{armaR}}) the selected Scenario is.
{{Feature|important|IP'''v6''' is '''not''' supported by {{armaR}} v0.9.5.}}


===== gameHostRegisterPort =====
==== Crossplay ====
number value, range 1..65535, default: 2001
This option allows console players to join - see {{Link|#supportedGameClientTypes}}.


UDP port registered in backend. If the server itself has a public IP address, this should be the same value as in {{hl|gameHostBindPort}}. Otherwise, this is the UDP port that is forwarded to the server.
=== Mods ===


===== adminPassword =====
This tab allows to enable or disable local mods to make them available to the hosted game (or not). The {{Link|Arma Reforger:Workshop}} is accessible from here.
Defines the server's admin password, allows a server administrator to login and control the server, to access this either open the chat input box by pressing {{Controls|C}} in the lobby or {{Controls|enter}} in-game followed by: {{hl|#login [the admin password]}}


===== game =====
Define the server's settings - see the [[#game 2|game]] section below.
{{Feature|important|Only '''one''' scenario can be defined - {{armaR}} does '''not''' allow for mission rotation as of v0.9.5.}}


===== a2sQueryEnabled =====
== Linux Server ==
bool value, default: false


Enable Steam Query protocol
The game server will by default use Docker container's IP for server browser registration and client connection which will cause failure during client connection attempt.<br>
To avoid it use:
* Run the "ipconfig" command in cmd to list the local IPs
* "IP Connect" option in the server browser and insert one of the server's local IPs
* Custom server config (.json file) with "gameHostRegisterBindAddress" and "gameHostRegisterPort" parameters set to one of the local IP:Port combinations
Example:
-config "./My_Config.json"
ClientConnectAddress 192.168.39.98


===== steamQueryPort =====
=== SteamCMD Setup ===
number value, range 1..65535, default: 17777


Change Steam Query UDP port on which game listens to A2S requests
{{Feature|important|This tutorial has been tested on '''Ubuntu'''.}}


==== game ====
# Install SteamCMD - for the latest documentation, see {{Link|https://developer.valvesoftware.com/wiki/SteamCMD}}
## Download and install it (link on the {{Link|https://developer.valvesoftware.com/wiki/SteamCMD|SteamCMD}} page) - it will auto-update to the latest version
## Set the install path with the {{hl|force_install_dir}} command (otherwise the default location will be used, {{hl|home/<username>/.steam/steam/steamcmd}})
### You can name the folder ''arma-reforger, armaR, armarserver, armarexpserver'' and etc
## Login as anonymous - type in {{hl|login anonymous}}
# Download and install the server {{hl|app_update 1874900}}
## ''1890870'' for experimental version
# Quit SteamCMD {{hl|quit}}


===== name =====
{{Feature|informative|To run {{armaR}}'s server, run {{hl|./ArmaReforgerServer}} in the installation directory.}}
length 0..100 characters


===== password =====
==== Example Script ====
length 0..x characters
; update_armar_ds.txt
Based on the {{Link|https://developer.valvesoftware.com/wiki/SteamCMD|SteamCMD}} page's example
<syntaxhighlight lang="bash">
// update_armar_ds.txt
//
@ShutdownOnFailedCommand 1
@NoPromptForPassword 1
force_install_dir ../armar_ds
login anonymous
app_update 1874900 validate
quit
</syntaxhighlight>


Password required to join the server.
; Execution
<syntaxhighlight lang="bash">steamcmd +runscript update_armar_ds.txt</syntaxhighlight>


===== scenarioId =====
==== With Bash Scripts ====
The scenario's {{hl|.conf}} file path is defined here.
# Install SteamCMD<syntaxhighlight lang="bash">sudo apt install steamcmd</syntaxhighlight>
See the [[Arma Reforger:Startup Parameters#listScenarios|listScenarios]] startup parameter to list available scenarios and obtain their {{hl|.conf}} file path.
# create a directory lets say <code>armaR</code> somewhere, lets say <code>/home/<username>/armaR</code>
 
# Create in it a steam shell script that will install reforger server <code>steamShell.txt</code> with something like <syntaxhighlight lang="bash">
===== gameNumber =====
@ShutdownOnFailedCommand 1
number value, range 1..9999
login anonymous
 
// Stable ID: 1874900 EXP: 1890870
Add a suffix to the server's name, if more servers hosted by script (typically in data centers) - e.g "Server Name - 56"
app_update 1874900 validate
 
quit
===== playerCountLimit =====
</syntaxhighlight>
number value, range 1..256, default: 127
# then create bash script that will install/update game <code>steamInstall.sh</code> with: <syntaxhighlight lang="bash">
 
/usr/games/steamcmd +force_install_dir /home/<username>/armaR +runscript /home/<username>/armaR/steamShell.txt
Set the maximum amount of players on the server.
</syntaxhighlight>
 
# after that, server startup script <code>start.sh</code> with: <syntaxhighlight lang="bash">
===== autojoinable =====
// Install or Update game
bool value, default: false
./steamInstall.sh
 
// Start server
Set if the session can be selected through the auto join feature.
./ArmaReforgerServer -config /home/<username>/.config/ArmaReforgerServer/config.json -profile /home/<username>/.config/ArmaReforgerServer -maxFPS 60
 
</syntaxhighlight>
===== visible =====
# So the actual file tree will look something like this: <syntaxhighlight lang="bash">
bool value, default: true
/home/<username>/armaR
 
steamShell.txt
Set the visibility of the server in the Server Browser.
steamInstall.sh
 
start.sh
===== gameProperties =====
</syntaxhighlight>
Define the scenario's settings - see the [[#gameProperties 2|gameProperties]] section below.
# Then create actual <code>config.json</code> at <code>/home/<username>/.config/ArmaReforgerServer/config.json</code>, create folders if they don't exist
 
# Run <code>start.sh</code> to install the server and start it.
===== mods =====
The list of mods required by the client. They will automatically be downloaded and activated on join.
 
====== modID ======
GUID of the mod. It can be obtained from i.e. Workbench options when mod is running or directly from gproj file
 
[[Image:armareforger-server-hosting-guid.png|1200px]]
 
====== name ======
 
This parameter doesn't do anything and is only used as sort of comment, with human readable name of the mod.
 
====== version ======
 
{{Feature|informative|The {{hl|version}} mod parameter is optional. If it missing, the latest mod version will be used.}}
 
==== gameProperties ====
 
===== serverMaxViewDistance =====
number value, range 500..10000, default: 1600
 
===== serverMinGrassDistance =====
number value, range 0 / 50..150, default: 0
 
Minimum grass distance in meters. If set to 0 no distance is forced upon clients.
 
===== fastValidation =====
bool value, default: false
 
Validation of map entities and components loaded on client when it joins, ensuring things match with initial server state.
* true (enabled) - minimum information required to make sure data matches is exchanged between client. When a mismatch occurs, no additional information will be available for determining where client and server states start to differ.<!--
--> All servers that expect clients to connect over internet should have fast validation enabled.
* false (disabled) - extra data for every replicated entity and component in the map will be transferred when new client connects to the server.<!--
--> When a mismatch occurs, it is possible to point at particular entity or component where things start to differ.<!--
--> When developing locally (ie. both server and client run on the same machine), it is fine to disable fast validation to more easily pin point source of the problem.


{{Feature|warning|'''Always''' keep this value to {{hl|true}} for a public server!}}


===== networkViewDistance =====
Console logs etc can be found in above mentioned profile folder, addons will also install there by default, you can again change that.
number value, range 500.5000, default: 500


Maximum network streaming range of replicated entities.
You can also change profile/config directories as desired.{{Feature|informative|You can then create new service for systemctl to run start.sh and the thing will run in the background and auto restart after crashes etc}}


===== battlEye =====
=== LinuxGSM ===
bool value


true to enable BattlEye, false to disable it.
The {{Link|https://linuxgsm.com/servers/armarserver/|{{arma}} LinuxGSM Tool}} can also be used.


===== disableThirdPerson =====
# It can monitor the game server by checking that the proccess is running and querying it. Should the server go offline LinuxGSM can restart the server and send you an alert. You can use cronjobs to setup monitoring.
bool value, default: false
# Update checks for any server updates and applies them. The server will update and restart only if required. '''This also needs to be set up on a schedule.'''


Force clients to use the first-person view.


==== missionHeader ====
{{Feature|informative|For server's experimental version, add <code>appid{{=}}"1890870"</code> to your <code>./lgsm/config-lgsm/armarserver/armarserver.cfg</code> and validate files by <code>./armarserver v</code>.}}
This property overwrites the scenario's {{hl|[enfusion://ResourceManager/~ArmaReforger:scripts/Game/Mission/SCR_MissionHeaderCampaign.c SCR_MissionHeaderCampaign]}}.


==== Template ====
=== Docker Setup ===
<syntaxhighlight lang="json">
{
"dedicatedServerId": "",
"region": "",
"gameHostBindAddress": "",
"gameHostBindPort": 0,
"gameHostRegisterBindAddress": "",
"gameHostRegisterPort": 0,
"game": {
"name": "",
"password": "",
"scenarioId": "",
"playerCountLimit": 0,
"visible": true,
"gameProperties": {
"serverMaxViewDistance": 0,
"serverMinGrassDistance": 0,
"networkViewDistance": 0,
"disableThirdPerson": false,
"fastValidation": true,
"battlEye": true
},
"mods": []
}
}
</syntaxhighlight>


== Linux Setup ==
{{Feature|important|This Docker configuration is adapted to '''Ubuntu'''. Other distributions such as Fedora or Arch Linux may store their certificates at the following location: {{hl|/etc/pki/ca-trust/}} - be sure to edit the configuration accordingly.}}


{{Feature|informative|
{{Feature|informative|A community Docker image is available on GitHub: https://github.com/acemod/docker-reforger}}
The game server will by default use Docker container's IP for server browser registration and client connection which will cause failure during client connection attempt.<br>
To avoid it use:
* Run the "ipconfig" command in cmd to list the local IPs
* "IP Connect" option in the server browser and insert one of the server's local IPs
* Custom server config (.json file) with "gameHostRegisterBindAddress" and "gameHostRegisterPort" parameters set to one of the local IP:Port combinations
Example:
<pre>
-config "./My_Config.json"
ClientConnectAddress 192.168.39.98
</pre>
}}
 
=== Docker ===
 
{{Feature|informative|
A community Docker image is available on GitHub: https://github.com/acemod/docker-reforger
}}


# Install latest Docker [https://docs.docker.com/desktop/windows/install/ download link]
# Install the latest Docker:
## {{Link|https://docs.docker.com/desktop/windows/install/|Download}} and install Docker
## [https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v Enable Hyper-V in Windows] if it is not already
## [https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v Enable Hyper-V in Windows] if it is not already
## Assign HW resources in {{hl|Docker/Settings/Resources/Advanced}}:
## Assign HW resources in {{hl|Docker/Settings/Resources/Advanced}}:
### CPU: 4 cores
### CPU: 4 cores
### Memory: 6 GB
### Memory: 6 GB
# Download Ubuntu 18.04 image ''via'' batch or powershell cmd: {{ic|docker pull ubuntu:18.04}}
# Download Ubuntu 18.04 image ''via'' batch or powershell cmd: {{hl|docker pull ubuntu:18.04}}
# Run Ubuntu image
# Run Ubuntu image:
## mount volume with server data
## mount volume with server data
## expose client connection UDP port
## expose client connection UDP port
## Example: {{ic|docker container run -t -d -p 2001:2001/udp -v D:\server_data\linux_packed:/home/packed --name ubuntu_test ubuntu:18.04}}
## Example: {{hl|docker container run -t -d -p 2001:2001/udp -v D:\server_data\linux_packed:/home/packed --name ubuntu_test ubuntu:18.04}}
# Connect to bash console: {{ic|docker exec -it ubuntu_test /bin/bash}}
# Connect to bash console: {{hl|docker exec -it ubuntu_test /bin/bash}}
# Install necessary SW
# Install necessary software:
## libcurl4 - required by server app
## libcurl4 - required by server app
## net-tools - for debug purposes (enables ifconfig etc)
## net-tools - for debug purposes (enables ifconfig etc)
Line 356: Line 215:
### apt-get install net-tools
### apt-get install net-tools
### apt-get install libssl1.1
### apt-get install libssl1.1
# Create folder for logs, e.g: {{ic|mkdir /home/profile}}
# Create logs directory, e.g: {{hl|mkdir /home/profile}}
# Run server
# Run server:
## server executable needs proper execution/access rights:
## server executable needs proper execution/access rights:
### cd server_root_folder
### cd server_root_folder
### chmod +x ArmaReforgerServer
### chmod +x ArmaReforgerServer
## Example: {{ic|./ArmaReforgerServer -gproj ./addons/data/ArmaReforger.gproj -config Configs/ServerConfig/Campaign.json -backendlog -nothrow -profile /home/profile}}
## Example: {{hl|./ArmaReforgerServer -gproj ./addons/data/ArmaReforger.gproj -config Configs/ServerConfig/Campaign.json -backendlog -nothrow -profile /home/profile}}




{{GameCategory|armaR|Support}}
{{GameCategory|armaR|Support}}

Latest revision as of 14:04, 9 September 2024

Server Hosting is the fact of hosting a game instance accessible over the network to other players. There are two possible modes in Arma Reforger: player-hosted and dedicated.


Connection fails from the outside if the door is closed.

For a hosted server to be visible from outside the local network (e.g from internet), Port Forwarding must be used.

Please refer to your router's user guide for assistance.


Main router brands's documentation links:


Dedicated Server

A Dedicated Server is a server without any game instance launched; it purely processes game information and network synchronisation.


stable is app id: 1874900 - https://steamdb.info/app/1874900/


experimental: 1890870 - https://steamdb.info/app/1890870/

BattlEye

See BattlEye's documentation and FAQ - there is also a BattlEye wiki article.

It is possible to modify BattlEye's RCon port and password by adding the following settings to Arma Reforger\BattlEye\BEServer_x64.cfg:

RConPort 5678
RConPassword myNewBEPassword
When editing Arma Reforger's BattlEye config, make sure to append new settings to it and not erase or even edit existing information.

Missing information will have the kick message "Missing GameID/MasterPort server config settings" welcome (and eject) players, whereas modified values will prevent BattlEye from working.
In the event of the file being already incorrectly edited, verify the game's files on Steam (see Steam's tutorial):

  • delete BEServer_x64.cfg
  • in Steam, right-click on Arma Reforger
  • select "Properties"
  • click on "Local Files"
  • press "Verify integrity of game files"
Steam will now verify and repair modified files. This will not erase any personal files, game progress, controls and other configurations will remain unchanged.

Startup Parameters

See Startup Parameters - Hosting and the Server Config page for more information.

config

The Server exe uses the -config startup parameter to target the configuration file.

ArmaReforgerServer.exe -config ".\Configs\Campaign_SWCoast.json"

In above example, Campaign_SWCoast.json is expected to be locted in Configs folder next to the exe.

maxFPS

As of 0.9.8 it is heavily recommended to use this startup parameter, set to a value in the 60..120 range; otherwise, the server can try to use all the available resources!
ArmaReforgerServer.exe -maxFPS 60

server

This parameter instructs the executable to launch local server and load selected world. When this parameter is used, config is ignored. Server parameter can be combined with addons and addonsDir parameters to start a server with local mods, which can be useful when testing addon before uploading it Workshop.

ArmaReforgerServer.exe -server "worlds/MP/MPTest.ent" -addonsDir "C:\MyModsDir" -addons MyCustomMod

Others

The below Startup Parameters are optional but may prove useful upon some cases:

  • logStats - allows to log server's FPS every x milliseconds
  • logLevel - sets the log detail level
  • listScenarios - logs available scenario .conf file paths on startup

Configuration File

See Server Config.


Player-Hosted Server

Also known as Listen Server, a Player-Hosted Server is a server also hosting a local player. Such server is started from within the game, in Multiplayer > Host tab > Host new server.

Player-hosting is only available on PC.

Settings

The settings are all self-explanatory and Dedicated Server can be used.

Scenario Selection

Scenario and Source are two related fields:

  • Scenario is the list of all available scenarios
  • Source is a read-only field telling from which mod (or Arma Reforger) the selected Scenario is.

Crossplay

This option allows console players to join - see supportedGameClientTypes.

Mods

This tab allows to enable or disable local mods to make them available to the hosted game (or not). The Workshop is accessible from here.


Linux Server

The game server will by default use Docker container's IP for server browser registration and client connection which will cause failure during client connection attempt.
To avoid it use:

  • Run the "ipconfig" command in cmd to list the local IPs
  • "IP Connect" option in the server browser and insert one of the server's local IPs
  • Custom server config (.json file) with "gameHostRegisterBindAddress" and "gameHostRegisterPort" parameters set to one of the local IP:Port combinations

Example:

-config "./My_Config.json"
ClientConnectAddress 192.168.39.98

SteamCMD Setup

This tutorial has been tested on Ubuntu.
  1. Install SteamCMD - for the latest documentation, see https://developer.valvesoftware.com/wiki/SteamCMD
    1. Download and install it (link on the SteamCMD page) - it will auto-update to the latest version
    2. Set the install path with the force_install_dir command (otherwise the default location will be used, home/<username>/.steam/steam/steamcmd)
      1. You can name the folder arma-reforger, armaR, armarserver, armarexpserver and etc
    3. Login as anonymous - type in login anonymous
  2. Download and install the server app_update 1874900
    1. 1890870 for experimental version
  3. Quit SteamCMD quit
To run Arma Reforger's server, run ./ArmaReforgerServer in the installation directory.

Example Script

update_armar_ds.txt

Based on the SteamCMD page's example

// update_armar_ds.txt
//
@ShutdownOnFailedCommand 1
@NoPromptForPassword 1
force_install_dir ../armar_ds
login anonymous
app_update 1874900 validate
quit
Execution
steamcmd +runscript update_armar_ds.txt

With Bash Scripts

  1. Install SteamCMD
    sudo apt install steamcmd
    
  2. create a directory lets say armaR somewhere, lets say /home/<username>/armaR
  3. Create in it a steam shell script that will install reforger server steamShell.txt with something like
    @ShutdownOnFailedCommand 1
    login anonymous
    // Stable ID: 1874900 EXP: 1890870
    app_update 1874900 validate
    quit
    
  4. then create bash script that will install/update game steamInstall.sh with:
    /usr/games/steamcmd +force_install_dir /home/<username>/armaR +runscript /home/<username>/armaR/steamShell.txt
    
  5. after that, server startup script start.sh with:
    // Install or Update game
    ./steamInstall.sh
    // Start server
    ./ArmaReforgerServer -config /home/<username>/.config/ArmaReforgerServer/config.json -profile /home/<username>/.config/ArmaReforgerServer -maxFPS 60
    
  6. So the actual file tree will look something like this:
    /home/<username>/armaR
    				steamShell.txt
    				steamInstall.sh
    				start.sh
    
  7. Then create actual config.json at /home/<username>/.config/ArmaReforgerServer/config.json, create folders if they don't exist
  8. Run start.sh to install the server and start it.


Console logs etc can be found in above mentioned profile folder, addons will also install there by default, you can again change that.

You can also change profile/config directories as desired.

You can then create new service for systemctl to run start.sh and the thing will run in the background and auto restart after crashes etc

LinuxGSM

The Arma LinuxGSM Tool can also be used.

  1. It can monitor the game server by checking that the proccess is running and querying it. Should the server go offline LinuxGSM can restart the server and send you an alert. You can use cronjobs to setup monitoring.
  2. Update checks for any server updates and applies them. The server will update and restart only if required. This also needs to be set up on a schedule.


For server's experimental version, add appid="1890870" to your ./lgsm/config-lgsm/armarserver/armarserver.cfg and validate files by ./armarserver v.

Docker Setup

This Docker configuration is adapted to Ubuntu. Other distributions such as Fedora or Arch Linux may store their certificates at the following location: /etc/pki/ca-trust/ - be sure to edit the configuration accordingly.
A community Docker image is available on GitHub: https://github.com/acemod/docker-reforger
  1. Install the latest Docker:
    1. Download and install Docker
    2. Enable Hyper-V in Windows if it is not already
    3. Assign HW resources in Docker/Settings/Resources/Advanced:
      1. CPU: 4 cores
      2. Memory: 6 GB
  2. Download Ubuntu 18.04 image via batch or powershell cmd: docker pull ubuntu:18.04
  3. Run Ubuntu image:
    1. mount volume with server data
    2. expose client connection UDP port
    3. Example: docker container run -t -d -p 2001:2001/udp -v D:\server_data\linux_packed:/home/packed --name ubuntu_test ubuntu:18.04
  4. Connect to bash console: docker exec -it ubuntu_test /bin/bash
  5. Install necessary software:
    1. libcurl4 - required by server app
    2. net-tools - for debug purposes (enables ifconfig etc)
    3. Installation:
      1. apt-get update
      2. apt-get install libcurl4
      3. apt-get install net-tools
      4. apt-get install libssl1.1
  6. Create logs directory, e.g: mkdir /home/profile
  7. Run server:
    1. server executable needs proper execution/access rights:
      1. cd server_root_folder
      2. chmod +x ArmaReforgerServer
    2. Example: ./ArmaReforgerServer -gproj ./addons/data/ArmaReforger.gproj -config Configs/ServerConfig/Campaign.json -backendlog -nothrow -profile /home/profile