Merge branch 'master' into martin-t/example-config
[xonotic/xonotic.git] / server / server.cfg
index 3167f86..f9620cc 100644 (file)
@@ -1,31 +1,46 @@
-// A setting needs to be surrounded with " if it contains special
-// characters like space, semicolon (seperates commands) or starts
-// with // (begins a comment for the rest of the line or next
-// semicolon).  While just "" means 'no/empty setting'.
+// This is an example config, to actually use it, copy it to ~/.xonotic/data on linux
+// or the equivalent directory on your OS (https://xonotic.org/faq/#config).
+
+// Two slashes start a comment until the end of the line.
+// Surround settings with double quotes (e.g. cvar_name "some value") unless they're a single number or word.
+// Cvar means console variable.
+// Just "" means empty string.
+// Semicolon separates commands (in console or in aliases).
+
+// Search for settings and descriptions using the 'search' command in console
+// or online: https://xonotic.org/tools/cacs/
+
+
 
-// You can search for settings and read their descriptions using
-// the 'search' command in console. A list of cvars and commands in the latest
-// release is also available online here: http://www.xonotic.org/tools/cacs/
 
 /////////////////////////////////////////////////////////////////////
-// Everything has some sensible defaults so you do NOT really need to
-// change anything.  But here are some settings you SHOULD change to
-// make it 'YOUR' server.  IF so remove the // from the line start and
-// change them to your liking.
+// Things you SHOULD change to make the server "yours" (remove the // and change the value):
 
-//sv_public 1  // 0 if the server should not be on the public servers list
-//sv_status_privacy 1  // 1 hides IP addresses from "status" replies shown to clients, 0 shows them. Enables players to identify wellknown punks on your server OR is a threat to anonymity.. depending on your point of view :)
+//sv_public 1  // 0 or -1 (see description) if the server should not be on the public servers list
 //hostname "Xonotic $g_xonoticversion Server"  // this name will appear on the server list (the $g_xonoticversion gets replaced with the current version)
-//sv_motd ""   // this message (unless "") is displayed to players on connect
-//maxplayers 8 // number of players allowed on the server
+//sv_motd ""   // displayed on connect - good place for contact info (IRC, forum nick, etc.) so players can reach you when something is wrong with your server
+
+// This sets the remote console password on the server, you also need to set the cvar to the same value on your client to use the 'rcon' command.
+// Empty means rcon is disabled.
+//rcon_password ""
+
+
+/////////////////////////////////////////////////////////////////////
+// Everything below has some sensible defaults so you don't really need to change anything.
+// It's meant as examples for people who want to customize the server more.
+// The values shown are either defaults or examples (for up to date defaults, see 'search' (or 'apropos') in console.
+
+//maxplayers 8 // number of player slots on the server (including spectators)
+
+//net_address 0.0.0.0  // ONLY change this if you have problems with your server. Specifies the network interface used by the engine.  Set it to one of your internal IPs
 
 //port 26000   // the port used by the server
-//You are RECOMMENDED to change this value to a free port number on your server
-//above 1024. The reason is that some bad ISPs might filter "gaming" ports, and
-//changing the port your server runs on may make your server available to these
-//people. Changing the port breaks nothing, the default simply matches Quake as
-//we use a Quake-derived protocol and didn't do our own IANA port assignment yet
-//(if anyone wants to go through that process, we'd be glad).
+// You are RECOMMENDED to change this value to a free port number on your server
+// above 1024. The reason is that some bad ISPs might filter "gaming" ports, and
+// changing the port your server runs on may make your server available to these
+// people. Changing the port breaks nothing, the default simply matches Quake as
+// we use a Quake-derived protocol and didn't do our own IANA port assignment yet
+// (if anyone wants to go through that process, we'd be glad).
 
 //log_file "server.log"        // server console output will also be copied to this file. This: "${serverconfig}.log" uses variable substitution to make the logfile have the same name as your config file with .log appended which is useful if you run several servers
 //g_start_delay 15     // delay before the game starts to let players join the server first
 //g_lms_lives_override -1      // lives for LMS
 //g_nexball_goallimit -1       // goals for NEXBALL
 
-//g_ctf_ignore_frags 1 // set to 1 to ignore kills except for FC kills
+//g_ctf_ignore_frags 0 // set to 1 to ignore kills except for FC kills
 
 // TEAMS for key hunt (change this to 2, 3, 4 to set a fixed keyhunt style)
 //g_keyhunt_teams_override -1  // teams for KH
 
 // GAME MODE: what type of server do you want to host?
-// possible values: dm (deathmatch), tdm (team deathmatch), dom (domination), ctf (ctf), ft (freeze tag), lms (last man standing), ka (keepaway), inv (invasion), kh (keyhunt), as (assault), ons (onslaught), rc (race), nb (nexball)
-//gametype dm
+// possible values: dm (deathmatch), tdm (team deathmatch), ctf (capture the flag), ca (clan arena), ft (freeze tag), kh (keyhunt), as (assault), dom (domination), lms (last man standing), ka (keepaway), inv (invasion), ons (onslaught), rc (race), cts (complete the stage), nb (nexball)
+//gametype dm  // default gamemode
 
 
 
 // Some settings you MIGHT want to change.  Again IF so remove the //
 // from the line start and change them to your liking.
 
-//net_address 0.0.0.0  // ONLY change this if you have problems with your server. Specifies the network interface used by the engine.  Set it you one of you internal IPs
-
-//rcon_password ""     // you can use rcon if this password is set.  you need to set the same password in your client if you want to issue rcon commands
-//rcon_restricted_password ""  // put here the password for a "restricted" rcon user (see below)
-
-//bot_number 0 // number of bots to add
-//skill 4      // the bots skill level
-//minplayers 0 // add bots if less then that number of players playing. MAKE SURE ITS LESS THEN maxplayers or people will get blocked by bots!
+//skill 8      // the bots skill level
+//minplayers 0 // add bots if less then that number of players playing
 //g_maxplayers 0 // above this player count, only allow spectators
 //bot_prefix [BOT]     // prepend this to all botnames
 //bot_suffix ""        // append this to all botnames
 //sv_vote_gametype_mygametype_name "My Mode"   // Name displayed for the custom gametype "mygametype" (replace "mygametype" with the name you set in sv_vote_gametype_options)
 //sv_vote_gametype_mygametype_type "ft"        // the basetype that the custom gametype is derived from
 //sv_vote_gametype_mygametype_description "This is my custom gametype" // the description for the custom gametype
-//// Custom icons for custom gametypes are supported and have to be located in a server pk3 as gfx/menu/default/gametype_mygametype
+// Custom icons for custom gametypes are supported and have to be located in a server pk3 as gfx/menu/default/gametype_mygametype
 
 //sv_vote_commands "restart fraglimit chmap gotomap nextmap endmatch reducematchtime extendmatchtime allready kick cointoss movetoauto shuffleteams"   // players can vote for those commands or use them if they are masters. You canm also add 'g_grappling_hook' for hook voting, and 'sv_fbskin_green sv_fbskin_red sv_fbskin_orange sv_fbskin_off' for fbskin voting.
 //sv_vote_master_commands "movetored movetoblue movetoyellow movetopink"       // add commands masters can use if logged in or elected. You may want to put 'kickban' here, so masters can keep out punks. It may be good to also put "sv_status_privacy 0" then...
 //rcon_restricted_commands "restart fraglimit chmap gotomap endmatch reducematchtime extendmatchtime allready kick kickban \"sv_cmd bans\" \"sv_cmd unban\" status \"sv_cmd teamstatus\" movetoauto movetored movetoblue movetoyellow movetopink"      // commands for the (stronger) rcon restricted
+//rcon_restricted_password ""  // put here the password for a "restricted" rcon user (see below)
 
 //sv_vote_call 1       // 0 will disable the normal voting
 //sv_vote_master 1     // 0 will disable voting to become master, good if you prefer to use the master password instead
 //sv_autotaunt 1       // 0 to disallow autotaunts
 
 
+
+
 /////////////////////////////////////////////////////////////////////
 // Settings you MIGHT want to change for PRIVACY reasons.
-//
-// The settings here may impact your or your players' privacy and serve to
-// optimize the game for further releases.
-//
-// Change them, or comment them out to turn them off.
+
+//sv_status_privacy 1  // 1 hides IP addresses from "status" replies shown to clients, 0 shows them. Enables players to identify wellknown punks on your server OR is a threat to anonymity.. depending on your point of view :)
 
 // This line sends the following data to our servers:
 // - Date and time
@@ -183,6 +192,8 @@ sv_weaponstats_file http://www.xonotic.org/weaponbalance/
 //g_spawnshieldtime 1  // time for which players are protected after spawn
 
 
+
+
 /////////////////////////////////////////////////////////////////////
 // "Obvious" mutators that are allowed on a "pure" server
 //g_instagib 0 // set to 1 for InstaGib
@@ -190,6 +201,8 @@ sv_weaponstats_file http://www.xonotic.org/weaponbalance/
 //g_powerups -1 // set to 0 to turn off strength/quad and shield/invincible, and set to 1 to turn them on even in game modes that normally have them turned off
 
 
+
+
 /////////////////////////////////////////////////////////////////////
 // Overkill mod settings
 
@@ -197,6 +210,8 @@ sv_weaponstats_file http://www.xonotic.org/weaponbalance/
 // You should also consider enabling 'g_fullbrightplayers 1'.
 
 
+
+
 /////////////////////////////////////////////////////////////////////
 // WARNING: anything below this line makes your server "impure"!