Server Config – Arma Reforger
IDarkWolfI (talk | contribs) (added joinQueue param) |
IDarkWolfI (talk | contribs) m (added joinQueue example) |
||
| Line 619: | Line 619: | ||
}, | }, | ||
"operating": { | "operating": { | ||
"lobbyPlayerSynchronise": true | "lobbyPlayerSynchronise": true, | ||
"joinQueue" : { | |||
"maxSize" : 12 | |||
} | |||
} | } | ||
} | } | ||
Revision as of 12:08, 5 September 2024
Arma Reforger servers uses JSON configuration format. Template and Example are available at the bottom of this page.
Summary
Default ports to be opened for hosting:
Port Protocol Optional Reason 2001 UDP 
Public port 17777 
A2S port 19999
RCON port
Root
bindAddress
IP address to which the server socket will be bound. In most cases, this should be left empty. It can be used to restrict connections to a particular network interface. When left out or empty, 0.0.0.0 is used, which allows connections through any IP address.
was gameHostBindAddress before 0.9.8.73
bindPort
number value, range 1..65535, default: 2001
UDP port to which the server socket will be bound.
was gameHostBindPort before 0.9.8.73
publicAddress
IP address registered in backend. 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). If the entry is missing or empty, then the public IP address will be automatically detected and used by the backend.
was gameHostRegisterBindAddress before 0.9.8.73
publicPort
number value, range 1..65535, default: 2001
UDP port registered in backend. If the server itself has a public IP address, this should be the same value as in bindPort. Otherwise, this is the UDP port that is forwarded to the server.
was gameHostRegisterPort before 0.9.8.73
a2s
0.9.9.31
Steam Query protocol definition - see the a2s section below.
0.9.9, a2s settings were:
- a2sQueryEnabled - bool value, default: false
- steamQueryPort - number value, range 1..65535, default: 17777
rcon
The RCON Protocol is a UDP-based communication protocol that allows console commands to be issued to the server via a Remote CONsole, or RCON - see the rcon section below.
game
Define the server's settings - see the game section below.
operating
Define various server settings - see the operating section below.
a2s
0.9.9.31
See A2S server queries.
address
required
IP address to which A2S socket will be bound. It can be used to restrict A2S queries to a particular network interface.
port
number value, range 1..65535, default: 17777
Change Steam Query UDP port on which game listens to A2S requests
rcon
(Optional)
See RCON protocol.
address
required
IP address to which the RCON socket will be bound. It can be used to restrict connection to a particular network interface.
port
number value, range 1..65535, default 19999
RCON protocol port on which the game listens
password
string
maxClients
number value, range 1..16, default 16
The maximum number of clients that can connect to RCON at the same time.
permission
string
Permission for all RCON clients. Possible values:
| Key | Value |
|---|---|
| admin | The admin can perform any command. |
| monitor | The monitor can only perform commands which do not change the server's state. |
blacklist
array value, default []
A list of commands excluded from execution.
whitelist
array value, default []
If defined, it specifies the list of commands that can be executed, and no other command is allowed.
game
name
length 0..100 characters
password
length 0..x characters
Password required to join the server.
passwordAdmin
length: 0..x characters
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 C in the lobby or Enter ↵ in-game followed by: #login [the admin password]
was root/passwordAdmin before 0.9.8.73
admins
0.9.9.31
array value of identityIds and/or steamIds
List players as server admins - they can be checked in script using BackendApi.IsListedServerAdmin(int playerId) regardless of their logged-in state.
1.0.0 Listed users can #login without a password.
scenarioId
The scenario's .conf file path is defined here. See the listScenarios startup parameter to list available scenarios and obtain their .conf file path.
- 1.1.0
: -------------------------------------------------- : Official scenarios (9 entries) : -------------------------------------------------- : {ECC61978EDCC2B5A}Missions/23_Campaign.conf (Conflict - Everon) : {59AD59368755F41A}Missions/21_GM_Eden.conf (Game Master - Everon) : {94FDA7451242150B}Missions/103_Arland_Tutorial.conf (Training) : {2BBBE828037C6F4B}Missions/22_GM_Arland.conf (Game Master - Arland) : {C700DB41F0C546E1}Missions/23_Campaign_NorthCentral.conf (Conflict - Northern Everon) : {28802845ADA64D52}Missions/23_Campaign_SWCoast.conf (Conflict - Southern Everon) : {DAA03C6E6099D50F}Missions/24_CombatOps.conf (Combat Ops - Arland) : {C41618FD18E9D714}Missions/23_Campaign_Arland.conf (Conflict - Arland) : {DFAC5FABD11F2390}Missions/26_CombatOpsEveron.conf (Combat Ops - Everon): -------------------------------------------------- : Workshop scenarios (8 entries) : -------------------------------------------------- : {6EA2E454519E5869}Missions/CAH_Military_Base.conf : {7C491B1FCC0FF0E1}Missions/CAH_LeMoule.conf : {F1A1BEA67132113E}Missions/CAH_Castle.conf : {589945FB9FA7B97D}Missions/CAH_Concrete_Plant.conf : {2B4183DF23E88249}Missions/CAH_Morton.conf : {3F2E005F43DBD2F8}Missions/CAH_Briars_Coast.conf : {9405201CBD22A30C}Missions/CAH_Factory.conf : {1CD06B409C6FAE56}Missions/CAH_Forest.conf : -------------------------------------------------- - 1.0.0
: {ECC61978EDCC2B5A}Missions/23_Campaign.conf (Conflict - Everon) : {59AD59368755F41A}Missions/21_GM_Eden.conf (Game Master - Everon) : {94FDA7451242150B}Missions/103_Arland_Tutorial.conf (Training) : {2BBBE828037C6F4B}Missions/22_GM_Arland.conf (Game Master - Arland) : {C700DB41F0C546E1}Missions/23_Campaign_NorthCentral.conf (Conflict - Northern Everon) : {28802845ADA64D52}Missions/23_Campaign_SWCoast.conf (Conflict - Southern Everon) : {DAA03C6E6099D50F}Missions/24_CombatOps.conf (Combat Ops - Arland) : {C41618FD18E9D714}Missions/23_Campaign_Arland.conf (Conflict - Arland) - 0.9.9
: {ECC61978EDCC2B5A}Missions/23_Campaign.conf (Conflict - Everon) : {59AD59368755F41A}Missions/21_GM_Eden.conf (Game Master - Everon) : {90F086877C27B6F6}Missions/99_Tutorial.conf (Tutorial) : {2BBBE828037C6F4B}Missions/22_GM_Arland.conf (Game Master - Arland) : {C700DB41F0C546E1}Missions/23_Campaign_NorthCentral.conf (Conflict - Northern Everon) : {28802845ADA64D52}Missions/23_Campaign_SWCoast.conf (Conflict - Southern Everon) : {DAA03C6E6099D50F}Missions/24_CombatOps.conf (Combat Ops - Arland) : {C41618FD18E9D714}Missions/23_Campaign_Arland.conf (Conflict - Arland)
maxPlayers
number value, range 1..128, default: 64
Set the maximum amount of players on the server.
was playerCountLimit before 0.9.8.73
visible
bool value, default: true (since 0.9.8.73)
Set the visibility of the server in the Server Browser.
crossPlatform
bool value, default: false
If set to true, automatically adds "PLATFORM_PC" and "PLATFORM_XBL" to supportedGameClientTypes if they are missing; does nothing if set to false.
supportedPlatforms
array value, default: ["PLATFORM_PC"]
Define the platforms which the server accepts, allowing crossplay.
Possible values:
| Key | Value |
|---|---|
| PLATFORM_PC | PC |
| PLATFORM_XBL | Xbox console |
was supportedGameClientTypes before 0.9.8.73
gameProperties
Define the scenario's settings - see the gameProperties section below.
mods
The list of mods required by the client that will automatically be downloaded and activated on join. It can be created by activating wanted mods in the Workshop and then, via the Mod manager, result can be converted to ready to be used string after navigating to JSON tab and then clicking on the Copy to clipboard button.
modID
GUID of the mod. Single GUID can be obtained from Workshop webpage
Alternatively you can grab it from Workbench options when mod is running or directly from gproj file
name
This parameter does not do anything and is only used as sort of comment, with human readable name of the mod.
version
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: true (since 0.9.6)
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.
networkViewDistance
number value, range 500..5000, default: 1500
Maximum network streaming range of replicated entities.
battlEye
bool value, default: true (since 0.9.8.73)
true to enable BattlEye, false to disable it.
disableThirdPerson
bool value, default: false
Force clients to use the first-person view.
VONDisableUI
bool value, default: false
Force clients to not have VON (Voice Over Network) UI.
VONDisableDirectSpeechUI
bool value, default: false
Force clients to not have VON (Voice Over Network) Direct Speech UI.
VONCanTransmitCrossFaction
bool value, default: false
Option to allow players to transmit on other factions radios. true is allow to communicate, false is listen-only
missionHeader
This property overwrites the scenario's SCR_MissionHeaderCampaign.
operating
lobbyPlayerSynchronise
bool value, default: true (since 0.9.8.73)
If enabled, the list of player identities present on server is sent to the GameAPI along with the server's heartbeat.
disableCrashReporter
bool value, default: false
If enabled, the automatic server-side Crash Report is disabled. Has the same effect as -disableCrashReporter.
- 1.0.0 If enabled, the server will disable navmesh streaming on all navmesh components and load the entire navmesh into memory. This setting provides slightly better server performance and reaction times of moving AIs at the cost of higher memory consumption (up to hundreds of MB depending on the terrain).
- 1.2.0 If not provided, no navmesh streaming is disabled. If provided empty, streaming of all navmeshes is disabled. If filled, only disables provided navmeshes's streaming.
was bool before 1.2.0
disableServerShutdown
bool value, default: false
If enabled, the server will not automatically shutdown if connection to backend is lost. Related to room requests errors - other causes like corrupted config will still shutdown the server.
disableAI
bool value, default: false
If enabled, the server will prevent initialization and ticking of AIWorld and its components. Will completely disable AI functionality on the server.
playerSaveTime
number value, default: 120
Default period in seconds for saving players for both Online and Local storage (player save can still be requested on demand).
aiLimit
0.9.8.64
number value, default: -1
Sets the top limit of AIs. No system will be able to spawn any AIs when this ceiling is reached (through aiWorld.CanAICharacterBeAdded())
A negative number is not considered as valid value and is then ignored - limit is not applied.
This param is overridden by the -aiLimit startup parameter.
slotReservationTimeout
0.9.9.31
number value, range 5..300, default 60
Sets the duration (in seconds) for how long will the backend and server reserve a slot for kicked player. It is considered disabled when set to the minimal value, the value being the same as for a normal disconnect.
It can be used in scripts via Game Mode events:
joinQueue
1.2.1.66
Configuration for player join queue to the server
maxSize
number value, range 0..50, default 0 (disabled)
Sets maximum size of how many people can be at one time in join queue to the server.
Template
{
"bindAddress": "",
"bindPort": 0,
"publicAddress": "",
"publicPort": 0,
"a2s": {
"address": "",
"port": 0
},
"rcon": {
"address": "",
"port": 0,
"password": "",
"permission": "monitor",
"blacklist": [],
"whitelist": []
},
"game": {
"name": "",
"password": "",
"passwordAdmin": "",
"admins" : [],
"scenarioId": "",
"maxPlayers": 0,
"visible": true,
"gameProperties": {
"serverMaxViewDistance": 0,
"serverMinGrassDistance": 0,
"networkViewDistance": 0,
"disableThirdPerson": false,
"fastValidation": true,
"battlEye": true,
"VONDisableUI": false,
"VONDisableDirectSpeechUI": false,
"VONCanTransmitCrossFaction": false
},
"mods": []
}
}
Example
{
"bindAddress": "0.0.0.0",
"bindPort": 2001,
"publicAddress": "192.168.9.10",
"publicPort": 2001,
"a2s": {
"address": "192.168.9.10",
"port": 17777
},
"rcon": {
"address": "192.168.9.10",
"port": 19999,
"password": "changeme_withoutspaces",
"permission": "monitor",
"blacklist": [],
"whitelist": []
},
"game": {
"name": "Server Name - Mission Name",
"password": "",
"passwordAdmin": "changeme",
"admins" : [
"76561198200329058"
],
"scenarioId": "{ECC61978EDCC2B5A}Missions/23_Campaign.conf",
"maxPlayers": 32,
"visible": true,
"crossPlatform": true,
"supportedPlatforms": [
"PLATFORM_PC",
"PLATFORM_XBL"
],
"gameProperties": {
"serverMaxViewDistance": 2500,
"serverMinGrassDistance": 50,
"networkViewDistance": 1000,
"disableThirdPerson": true,
"fastValidation": true,
"battlEye": true,
"VONDisableUI": true,
"VONDisableDirectSpeechUI": 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"
}
]
},
"operating": {
"lobbyPlayerSynchronise": true,
"joinQueue" : {
"maxSize" : 12
}
}
}