server.cfg

From Bohemia Interactive Community
Jump to: navigation, search

Introduction

This article deals with the server.cfg, a configuration file which you can use to configure various game server settings such as the difficulty level, how many votes are needed, and welcome messages. etc.

The name server.cfg means nothing, and this file can be called anything. The real name is determined by the -config command line option when launching the dedicated server. There is no default name - when you do not specify the filename, no server configuration file is loaded.

Please feel free to add more information.

Server Options

Parameter Description
passwordAdmin = "xyzxyz"; Password to protect admin access.
password = "xyz"; Password required to connect to server.
serverCommandPassword = "xyzxyz"; Password required by alternate syntax of serverCommand server-side scripting.
hostname="My Server"; Servername visible in the game browser.
maxPlayers = 10; The maximum number of players that can connect to server ( seems to be out by 1 in the demo at least ). Number of mission slots override this setting.
motd[]= {"Welcome to my server.", "Hosted in the net."}; Two lines welcome message. Comma is the 'new line' separator.


Server Behavior Description
voteThreshold = 0.33; Percentage of votes needed to confirm a vote. 33% in this example.
voteMissionPlayers = 3; Start mission-voting when X numberOfPlayers connect. 3 players in this example.
reportingIP = "<>";
  • Private server - no reporting: "noreport".
  • Arma: "armedass.master.gamespy.com" to report to the gamespy master server.
  • Arma 2: "arma2pc.master.gamespy.com"
  • Arma 2:OA: "arma2oapc.master.gamespy.com" //this option is deprecated since A2: OA version 1.63
  • Arma 3: "" //not used at all in Arma 3
kickduplicate = 1; Do not allow duplicate game IDs. Second player with an existing ID will be kicked automatically. 1 means active, 0 disabled.
loopback = true; While using the Dev version of Arma III, adding this option will force server into LAN mode. This will allow multiple local instances of the game to connect to the server for testing purposes. At the same time it will prevent all non-local instances from connecting.
checkfiles[]= {"dta\bin.pbo", "a10\config.bin"}; Outdated - replaced by verifySignatures! Only use if you really understand what it does.

List of files to check for integrity with crc check. Possible to check pbo files or files inside pbos.

Beware checking large files, which takes serious processing on the server and can cause various issues.

equalModRequired = 1; Outdated - replaced by verifySignatures! Only use if you really understand what it does.

Clients require the exact same modfolder naming, order and amount as the server. 1 means active, 0 disabled.

upnp = 1; Automatically creates port mapping on UPNP/IGD enabled router. This option allows you to create a server behind NAT (your router must have public IP and support UPNP/IGD protocol). Read more Internet Gateway Device (IGD) Standardized Device Control Protocol


Arma Only Parameters Description
verifySignatures = 2; Enables or disables the signature verification for addons.
  • Default = 0.
  • Weak protection = 1.
  • Full protection = 2.

From Arma 3 use only level 2 (level 1 is outdated and not efficent) - Changed in 1.59 patch

disableVoN = 1; Enables or disables the Voice over Net. Default = 0.
vonCodecQuality = 10; Sets VoN codec quality. Value range is from 1 to 20.
  • Default = 3.
  • Since 1.62.95417 supports range 1-20
  • Since 1.63.x will support range 1-30
  • 8kHz is 0-10, 16kHz is 11-20, 32kHz is 21-30
logFile = "server_console.log"; Enables output of dedicated server console into textfile. Default location of log is same as crash dumps and other logs.

(Local settings) Note that this does not change the location of the "net.log" file, which you enable with the -netlog command line option.

doubleIdDetected = "command"; see Server Side Scripting
onUserConnected = "command";
onUserDisconnected = "command";
onHackedData = "command";
onDifferentData = "command";
onUnsignedData = "command";
regularCheck = "command";
BattlEye = 1; Enables or disables the BattlEye anti-cheat engine. Default 0. - since 1.09 beta, in Arma 3 default is 1. Note that this requires specific dlls to be installed on the server and all clients joining the game
timeStampFormat = "short"; Set the timestamp format used on each report line in server-side RPT file. Possible values are "none" (default), "short", "full".
forceRotorLibSimulation = 0; Enforces the Advanced Flight Model on the server. Default = 0 (up to the player). 1 - forced AFM, 2 - forced SFM.
persistent = 1; Enables or disables the persistent battlefield. Default = 0. See note below.
requiredBuild = xxxxx; From 1.60 Patchlog: requiredBuild=xxxxx; in server.cfg preventing obsolete clients to connect. Since 95691 the required version is limited to the server version.


Comments

Enabling the persistence option will make missions that have either base or instant respawn keep on running after all players have disconnected.

The other respawn types will not make a mission persistent. The kind of respawn a certain mission uses is set in its Description.ext.

If you do not include the regularCheck option or set regularCheck = ""; it will be activated.

The server checks the files from time to time by hashing them and comparing the hash to the hash values of the clients.

The heavy I/O operation might be stressful for some systems with weak I/O, slow HDD etc.
In case you still have these problems post 1.60 release, please report to CIT ticket with details.

To turn this function off, write regularCheck = "{}";. It's strongly recommended to NOT DISABLE regularCheck as this will make the server prone to cheating.

Server Voting

Documentation for server-side voting settings (since 1.39 DEV)

allowedVoteCmds

Definition of available voting commands

allowedVoteCmds[] = { { "CMD1", pre-init, post-init, threshold },{ "CMD2", pre-init, post-init, threshold }, ... ,{ "CMDn", pre-init, post-init, threshold }};

Second, third and fourth parameters are optional. If not specified, pre-init and post-init are true by default. (pre-init means prior to mission start, post-init means after a mission started)
Threshold equals "voteThreshold" by default.

Not listing any command ( allowedVoteCmds[] = {}; ) means voting is disabled.
Not specifing allowedVoteCmds at all means everything is allowed!

Example:

allowedVoteCmds[] = {
{"admin", true, true, 0.5},
{"missions", true, "true", "0.5"},
{"mission", true, true}, // will use global "voteThreshold"
{"kick", false, false, 0.75},
{"restart", false, true, -1}, // invalid threshold value. Will default to global "voteThreshold"
{"reassign", true, true, 0.5}
};

allowedVotedAdminCmds

Definition of available commands for voted-in admins (this doesn't affect abilities of normal server admins)
allowedVotedAdminCmds[] = { { "CMD1", pre-init, post-init },{ "CMD2", pre-init, post-init }, ... ,{ "CMDn", pre-init, post-init }};

Second and third parameter are optional. If not specified otherwise, they are true by default. (pre-init means prior to mission start, post-init means after a mission started)

Not listing any command ( allowedVotedAdminCmds[] = {}; ) means such commands are disabled for voted-in admin.
Not specifing allowedVotedAdminCmds at all means everything is allowed anytime for voted-in admin!

Commands available for voted admins:

allowedVotedAdminCmds[] = {
{"mission", true, true}, //
{"missions", true, true}, //
{"restart", true, true}, //
{"reassign", true, true}, //
{"kick", true, true} //
};

Global voting settings

Global voting settings are used if no voting threshold defined in allowedVoteCmds or/and allowedVotedAdminCmds

voteThreshold = <number>; // Percentage of votes needed to confirm a vote.
voteMissionPlayers = <number>; //Start mission-voting when X numberOfPlayers connect.

Server Security

Several of these settings directly contribute to the security of the server and have been highlighted as important, particularly for running Public (no password) servers.

The most updated ones that give a good protection (and are, de facto, the standard for public servers) are
battlEye = 1;
verifySignatures = 2;
allowedLoadFileExtensions[] = {"hpp","sqs","sqf","fsm","cpp","paa","txt","xml","inc","ext","sqm","ods","fxy","lip","csv","kb","bik","bikb","html","htm","biedi"};
allowedPreprocessFileExtensions[] = {"hpp","sqs","sqf","fsm","cpp","paa","txt","xml","inc","ext","sqm","ods","fxy","lip","csv","kb","bik","bikb","html","htm","biedi"};
allowedHTMLLoadExtensions[] = {"htm","html","xml","txt"};
serverCommandPassword = "xyzxyz";

Note: allowed* commands are for server side use, it covers both files inside and outside PBO so don't change the above defaults oo there's a chance you'll break the game.

Refer to ArmA: Addon Signatures for current best practices in server mod signing and the use of key signature files.

To further increase security of your servers remember BattlEye has ability to utilize server-side (including preventing remote execution) and client-side script check filters.

Note: these BattlEye filters needs to be written specifically for each mission and mod as the scripting differs in each of them.

Example Configuration File

//
// server.cfg
//
// comments are written with "//" in front of them.
 
 
// GLOBAL SETTINGS
hostname = "Fun and Test Server";		// The name of the server that shall be displayed in the public server list
password = "";					// Password for joining, eg connecting to the server
passwordAdmin = "xyz";				// Password to become server admin. When you're in Arma MP and connected to the server, type '#login xyz'
serverCommandPassword = "xyzxyz";               // Password required by alternate syntax of [[serverCommand]] server-side scripting.
 
//reportingIP = "armedass.master.gamespy.com";	// For ArmA1 publicly list your server on GameSpy. Leave empty for private servers
//reportingIP = "arma2pc.master.gamespy.com";	// For ArmA2 publicly list your server on GameSpy. Leave empty for private servers
//reportingIP = "arma2oapc.master.gamespy.com";	// For Arma2: Operation Arrowhead  //this option is deprecated since A2: OA version 1.63
//reportingIP = "arma3" //not used at all
logFile = "server_console.log";			// Tells ArmA-server where the logfile should go and what it should be called
 
 
// WELCOME MESSAGE ("message of the day")
// It can be several lines, separated by comma
// Empty messages "" will not be displayed at all but are only for increasing the interval
motd[] = {
	"", "",  
	"Two empty lines above for increasing interval",
	"Welcome to our server",
	"", "",  
	"We are looking for fun - Join us Now !",
	"http://www.example.com",
	"One more empty line below for increasing interval",
	""
};
motdInterval = 5;				// Time interval (in seconds) between each message
 
 
// JOINING RULES
checkfiles[] = {};				// Outdated.
maxPlayers = 64;				// Maximum amount of players. Civilians and watchers, beholder, bystanders and so on also count as player.
kickDuplicate = 1;				// Each ArmA version has its own ID. If kickDuplicate is set to 1, a player will be kicked when he joins a server where another player with the same ID is playing.
verifySignatures = 2;				// Verifies .pbos against .bisign files. Valid values 0 (disabled), 1 (prefer v2 sigs but accept v1 too) and 2 (only v2 sigs are allowed). 
equalModRequired = 0;				// Outdated. If set to 1, player has to use exactly the same -mod= startup parameter as the server.
//requiredBuild = 12345				// Require clients joining to have at least build 12345 of game, preventing obsolete clients to connect
 
 
// VOTING
voteMissionPlayers = 1;				// Tells the server how many people must connect so that it displays the mission selection screen.
voteThreshold = 0.33;				// 33% or more players need to vote for something, for example an admin or a new map, to become effective
 
 
// INGAME SETTINGS
disableVoN = 1;					// If set to 1, Voice over Net will not be available
vonCodecQuality = 0;				// since 1.62.95417 supports range 1-20 //since 1.63.x will supports range 1-30 //8kHz is 0-10, 16kHz is 11-20, 32kHz is 21-30
persistent = 1;					// If 1, missions still run on even after the last player disconnected.
timeStampFormat = "short";			// Set the timestamp format used on each report line in server-side RPT file. Possible values are "none" (default),"short","full".
BattlEye = 1;					// Server to use BattlEye system
allowedLoadFileExtensions[] = {"hpp","sqs","sqf","fsm","cpp","paa","txt","xml","inc","ext","sqm","ods","fxy","lip","csv","kb","bik","bikb","html","htm","biedi"}; //only allow files with those extensions to be loaded via loadFile command (since Arma 3 build 1.19.124216)
allowedPreprocessFileExtensions[] = {"hpp","sqs","sqf","fsm","cpp","paa","txt","xml","inc","ext","sqm","ods","fxy","lip","csv","kb","bik","bikb","html","htm","biedi"}; //only allow files with those extensions to be loaded via preprocessFile/preprocessFileLineNumber commands (since Arma 3 build 1.19.124323)
allowedHTMLLoadExtensions[] = {"htm","html","xml","txt"}; //only allow files with those extensions to be loaded via HTMLLoad command (since Arma 3 build 1.27.126715)
 
 
// SCRIPTING ISSUES
onUserConnected = "";				//
onUserDisconnected = "";			//
doubleIdDetected = "";				//
//regularCheck = "{}";				//  Server checks files from time to time by hashing them and comparing the hash to the hash values of the clients. //deprecated
 
// SIGNATURE VERIFICATION
onUnsignedData = "kick (_this select 0)";	// unsigned data detected
onHackedData = "ban (_this select 0)";		// tampering of the signature detected
onDifferentData = "";				// data with a valid signature, but different version than the one present on server detected
 
 
// MISSIONS CYCLE (see below)
class Missions {};				// An empty Missions class means there will be no mission rotation
 
missionWhitelist[] = {}; //an empty whitelist means there is no restriction on what missions' available

Mission rotation

One can set an automatic mission rotation. It will automatically select a mission join a player joins with no admin logged inClarify. Once the mission is done and if there are still players on the server, it automatically switches to the next in the cycle.

Arma

The following example shows one for the missions included with the demo.

class Missions
{
	class MPCTF_01 // name for the mission, can be anything
	{
		template = M02CaptureTheFlag.SaraLite; // omit the .pbo suffix
		cadetMode = 1; // difficulty 0=veteran 1=cadet
	};
	class MPCOOP_01
	{
		template = M01Cooperative.SaraLite;
		cadetMode = 1;
	};
	class MPCTI_01
	{
		template = M03ConquerTheIsland.SaraLite;
		cadetMode = 1;
	};
};

Arma 2

This example shows how to put all the stock Arma 2 1.05 multiplayer missions into rotation:

class Missions
{
	class DM_Deathmatch
	{
		template = "MP_Deathmatch.Chernarus"; // omit the .pbo suffix
		difficulty = "recruit"; // difficulty: recruit, regular, veteran or mercenary (see CfgDifficulties in the main game config)
	};
	class DM_Detector
	{
		template = "MP_Detector.Chernarus";
		difficulty = "regular";
	};
	class Team_TeamDeathmatch
	{
		template = "MP_TeamDeathmatch.Chernarus";
		difficulty = "veteran";
	};
	class COOP_Paradrop
	{
		template = "MP_Paradrop.Chernarus";
		difficulty = "mercenary";
	};
	class CTI_CivilWar
	{
		template = "MP_CivilWar.Chernarus";
		difficulty = "regular";
	};
	class CTI_SuperPowers
	{
		template = "MP_Superpowers.Chernarus";
		difficulty = "regular";
	};
	class CTI_WarWelcome
	{
		template = "MP_WarWelcome.utes";
		difficulty = "regular";
	};
	class CTI_WhenDiplomacyFails
	{
		template = "MP_WhenDiplomacyFails.Chernarus";
		difficulty = "regular";
	};
};

Arma 2: Operation Arrowhead

This example contains all the MP missions from the Operation Arrowhead expansion:

class Missions
{
	class COOP_HikeInTheHills
	{
		template = "MPE1_HikeInTheHills.Takistan"; // omit the .pbo suffix
		difficulty = "regular"; // difficulty: recruit, regular, veteran or mercenary (see CfgDifficulties in the main game config)
	};
	class COOP_LaserShow
	{
		template = "MPE1_LaserShow.Takistan";
		difficulty = "regular";
	};
	class COOP_Littlebird
	{
		template = "MPE1_Littlebird.Takistan";
		difficulty = "regular";
	};
	class COOP_OneShotOneKill
	{
		template = "MPE1_OneShotOneKill.Takistan";
		difficulty = "regular";
	};
	class COOP_SteelPanthers
	{
		template = "MPE_SteelPanthers.Takistan";
		difficulty = "regular";
	};
	class CTI_MountainWarfare
	{
		template = "MPE_MountainWarfare.Takistan";
		difficulty = "regular";
	};
	class CTI_MountainWarfare3Sided
	{
		template = "MPE_MountainWarfare3Sided.Takistan";
		difficulty = "regular";
	};
	class CTI_UrbanWarfare
	{
		template = "MP_UrbanWarfare.Zargabad";
		difficulty = "regular";
	};
	class SCont_SectorControl
	{
		template = "MPE_SectorControl.Zargabad";
		difficulty = "veteran";
	};
	class DM_Dogfighters
	{
		template = "MPE1_Dogfighters.Takistan";
		difficulty = "veteran";
	};
	class Team_HuntersHunted
	{
		template = "MPE1_HuntersHunted.Takistan";
		difficulty = "veteran";
	};
};

Arma 3 - mission whitelisting

The following example shows only Zeus and Karts missions allowed e.g. via voting and mission select.

missionWhitelist[] = {
"MP_COOP_m04.Stratis",
"MP_COOP_m05.Altis",
"MP_COOP_m06.Altis",
"MP_COOP_m07.Altis",
"MP_ZGM_m11.Altis",
"MP_ZGM_m11_EAST.Altis",
"MP_ZGM_m11_GUER.Altis",
"MP_ZGM_m11_WEST.Altis",
"MP_ZGM_m12.Stratis",
"MP_ZGM_m12_EAST.Stratis",
"MP_ZGM_m12_GUER.Stratis",
"MP_ZGM_m12_WEST.Stratis",
"MP_ZSC_m10.Altis",
"MP_ZGM_m13.VR",
"MP_ZGM_m13_EAST.VR",
"MP_ZGM_m13_GUER.VR",
"MP_ZGM_m13_WEST.VR",
"MP_ZR_8_Karts01.Altis",
"MP_ZR_8_Karts02.Stratis",
"MP_bootcamp_01.VR",
"MP_Bootcamp_01.Altis",
};

Arma 2: Operation Arrowhead - multiple mission parameters configuration

Starting rev.72235 (22.7.2010) the Operation Arrowhead should be able not only to use multiple mission parameters, but also configure their defaults in server.cfg config file.

Below is a short example of how it was tested when implemented. Feel free to rewrite this part of article, as I only want to stop speculations how these parameters are to be configured. This should be considered as a documentation just after implementation.

// description.ext file: definition of parameters with their defaults. 
// These default values can be overwritten in the server.cfg, as shown in the following list
titleParam1 = "Secretary dress";
valuesParam1[] = {0, 1, 2, 3};
defValueParam1 = 0;
textsParam1[] = {"Bikini", "Miniskirt", "Tunic", "Jeans"};
 
titleParam2 = "Secretary age";
valuesParam2[] = {18, 20, 26, 30, 35, 80};
defValueParam2 = 26;
textsParam2[] = {"18", "20", "26", "30", "35", "Baba Jaga"};
 
class Params 
{
	class Name
	{
		title = "Secretary name";
		values[] = {0, 1, 2, 3};
		texts[] = {"Iveta", "Mila", "Misa", "Bara"};
		default = 3;
	};
	class WorkPlace
	{
		title = "Secretary place";
		values[] = {0, 1};
		texts[] = {"Prague","Mnisek"};
		default = 1;
	};
	class Friend
	{
		title = "Her friend"
		values[] = {0, 1};
		texts[] = {"None","Bebul"};
		default = 1;
	};
};

Inside server.cfg one can define the param1 and param2 values along with new, named parameters inside class Params, using each parameter class name to assign the corresponding parameter the value.

The paramsArray cannot be used inside server.cfg config file (or you can use it, but the engine has never read it :) ).
class Missions
{
	class CanBeAnything // name for the mission, can be anything
	{
		template = "parametersTest.Desert_E";	// omit the .pbo suffix
		difficulty = "regular";			// difficulty: recruit, regular, veteran & mercenary as specified in *.Arma2profile
		param1 = 2;				// dress
		param2 = 26;				// age
		class Params
		{
			Name = 2;
			WorkPlace = 0;
			Friend = 1;
		};
	};
};

Dedicated client in Headless Client mode

Parameter Description
localClient[]={127.0.0.1}; to indicate clients with unlimited bandwidth and nearly no latency (https://dev-heaven.net/issues/62500), Available since Arma 2:OA build 99184 , including Arma 3
headlessClients[]={"xxx.xxx.xxx.xxx", ...}; The server doesn't allow arbitrary connections from headless clients if you do not define the headless clients IPs.
Multiple Connections and Addresses are allowed in the case of more than one Headless Client.

More details (https://community.bistudio.com/wiki/Arma_3_Headless_Client) in-depth description how setup server and mission scripting for HC usage

Arma 2: Operation Arrowhead & Arma 3 - STEAM ports configuration

note: STEAM ports in Arma 3 build 1.22.125469 or newer are hardcoded as now linked to game-port of the server instance (+1 query +2 report to master)

Parameter Description
steamPort = <number>; default 2303, defines port for communication with STEAM services, needs to be unique for each dedicated server within one OS instance / network interface
steamQueryPort = <number>; default 2304, defines port for server's STEAM query, needs to be unique for each dedicated server within one OS instance / network interface

Additional details

For hosting server behind NAT or firewall, please ensure gameport and STEAMports are forwarded and open!
Set the ICMP "echo reply" as allowed so the server is able return ping delay properly.
It's recommended to enable the NAT traversal (so called "Edge traversal" in Windows Firewall) for arma3server.exe, arma3.exe to better support clients/servers behind NAT.

See Also