server.cfg Optionen

Server configuration


When running a dedicated server, you will usually want to create a Server.cfg file. In this file you can adjust many server parameters, and you can provide a mission list for automatic mission selection. An example can be found in Appendix B. The following entries are recognized in the configuration file:


password = <session_password>;	Password required to connect to server.
Default: No password required.
passwordAdmin = <admin_password>;	Password required to administrate the server.
Default: No password required.
motd[]=
{
	"<1st MOTD line>",
	"<2nd MOTD line>",
	….
	"<Last MOTD line>"
};	Message of the day (MOTD). This message may consist of several lines. Each player is shown this text when  connected to the server.


Default: No MOTD.
motdInterval=<interval_in_sec>;	Interval in which subsequent lines of MOTD appear. Default: 5 seconds.
voteThreshold=<threshold>;	More than voteThreshold playes must agree when voting for some action. Default: 0.5 (more than half required). 
reportingIP="<id_address">;	IP address of the master server to which this server is reporting its state. Use "" to disable reporting. Default: "master.gamespy.com".
voteMissionPlayers=<number>;	How many players must connect to the server for mission selection voting to start automatically.
Default: 1
class Missions
{
	class Mission01
	{
		template = <mission_name>; 
		cadetMode = <cadet_mode>;
		param1 = <value>;
		param2 = <value>;
	};
	class Mission02
	{ … see above … };
	….
	class Mission<N>
	{ … see above … };


};	Mission list






First mission name
Cadet mode (1) or Veteran (0)
Values of mission-specific parameters. You will find more information about their meaning in the description.ext of the corresponding mission.








When the end of the list is reached, the first mission is used again.






Note: The configuration file uses C++ like syntax. Each entry must be terminated with semicolon. You can also use C++ comments (starting with a double slash: //).


Performance tuning


There are also some parameters that can be used to fine-tune network performance. You can add following entries to Flashpoint.cfg (the main Flashpoint configuration file):




MaxMsgSend=<limit>;	Maximum number of messages that can be sent in one simulation cycle. Increasing this value can decrease lag on high upload bandwidth servers. 
Default: 128
MaxSizeGuaranteed=<limit>;	Maximum size of guaranteed packet in bytes (without headers). Small messages are packed to larger frames.
Guaranteed messages are used for non-repetitive events like shooting.
Default: 512 
MaxSizeNonguaranteed =<limit>;	Maximum size of non-guaranteed packet in bytes (without headers). Non-guaranteed messages are used for repetitive updates like soldier or vehicle position.
Increasing this value may improve bandwidth requirement, but it may increase lag.
Default: 256
MinBandwidth =<bottom_limit>;	Bandwidth the server is guaranteed to have (in bps). This value helps server to estimate bandwidth available. Increasing it to too optimistic values can increase lag and CPU load, as too many messages will be sent but discarded.
Default: 131072
MaxBandwidth=<top_limit>	Bandwidth the server is guaranteed to never have. This value helps server to estimate bandwidth available. 


The greatest level of optimization can be achieved by setting the MaxMsgSend and MinBandwidth parameters. For a server with 1024kbps we recommend the following values:


MaxMsgSend = 256;
MinBandwidth = 768000;


You can use the admin command #monitor to monitor server resource usage. The server never runs at more than 50 fps. When running slower, it always uses all available CPU processing power to maintain the smoothest possible gameplay. When running at less than 15 fps, you can consider the server overloaded – the mission currently played is probably too complex for given server. If you see the server is not using bandwidth that it could use, you can try increasing values MaxMsgSend and MinBandwidth.
 
Banning


To ban a user you have to know their unique online ID (called Player  ID). This can be checked in the players overview screen ('P' key) during the game, or with the #userlist command. To ban a user you have to add their Player ID to file ban.txt residing in the main OFP directory. If there is no such file there, create a new one. The format of ban.txt is a plain ASCII text list of decimal Player IDs delimited with space, tabulator or end-of-line characters.
 
Appendix A: List of administrator commands


The following commands have special meaning when issued on global chat channel:


#login <password>	Login as server administrator
#logout	Logout, but stay connected as a normal user
#init	Reload server config file loaded by –config option.
#kick <player_name>	Kick given player
#kick <player_number>	Kick player with given number
#restart	Restart mission
#reassign	Go back to side selection screen
#mission <mission_name>	Select mission with known name
#missions	Select mission
#shutdown	Shutdown server
#userlist	Display list of all users
#monitor <interval_in_sec>	Start server monitoring. Server CPU load and bandwidth usage is displayed in the global chat channel.
The default interval is 10 seconds. To stop monitoring type monitor 0.


Appendix B: Example of server.cfg file.


passwordAdmin = "xyzxyz"; // password to protect admin access
motd[]=
{
	"Welcome to OFP server.",
	"Hosted by Flashpoint Webworlds.",
}; // Welcome message
motdInterval=1;
voteThreshold=0.33; // when one third agrees, this is enough to confirm a vote
reportingIP=""; // private server - no reporting
voteMissionPlayers=3; // start voting when 3 players connect