r2216 - branches/nexuiz-2.0/Docs/server trunk/Docs/server

[DONOTREPLY at icculus.org]

Author: esteel
Date: 2007-03-03 07:08:38 -0500 (Sat, 03 Mar 2007)
New Revision: 2216

Modified:
   branches/nexuiz-2.0/Docs/server/server.cfg
   trunk/Docs/server/server.cfg
Log:
made more stuff in server.cfg comments so it will use the defaults unless the admin really wants to use those settings


Modified: branches/nexuiz-2.0/Docs/server/server.cfg
===================================================================
--- branches/nexuiz-2.0/Docs/server/server.cfg	2007-03-03 10:43:46 UTC (rev 2215)
+++ branches/nexuiz-2.0/Docs/server/server.cfg	2007-03-03 12:08:38 UTC (rev 2216)
@@ -1,63 +1,86 @@
-// you need to surround a setting with " if it contains special characters like a space, a semicolon or //
-// "" is NO-SETTING, a semicolon separates commands and // starts a comment so the rest in the line is ignored when loading the file
+// A setting needs to be surrounded  with " if it contains special
+// characters like space, semicolon (seperates commands) or //
+// (starts a comment for the rest of the line).  While just ""
+// means 'no/empty setting".
 
-maxplayers 8 // number of players allowed on the server
-port 26000 // the port used by the server
-sv_public 1 // 0 if the server should not be on the public servers list
-hostname "my server (special things)" // this name will appear on the server list
-sv_motd "don't drink and frag" // this message is displayed to players on connect
-sv_maxrate 10000 // limits client connections to this rate in bytes/seconds
-sys_ticrate 0.05 // how long a server frame is. 0.05 = 20 fps, 0.02 = 50 fps. Lower settings makes things smoother but create more traffic
-g_antilag 0 // 1 to enable a experimental antilag feature
-sv_cheats 0 // 1 will enable fly/god and other cheats
 
-log_file server.log // server console output will also be copied to this file
-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
-sv_curl_defaulturl "http://www.nexuiz.com/contentdownload/getmap.php?file=" //default download URL
+// Everything has some sensible defaults so you do NOT really need to
+// change anything.  But here is a settings you SHOULD change to make
+// it 'YOUR' server.
 
-sv_vote_commands "restart timelimit fraglimit chmap g_grappling_hook sv_defaultplayer_fbskin_green sv_defaultplayer_fbskin_red sv_defaultplayer_fbskin_orange sv_defaultplayer_fbskin_off" // players can vote for those commands or use them if they are masters
-sv_vote_call 1 // 0 will disable the normal voting
-sv_vote_master 1 // 0 will disable voting to become masters
-sv_vote_timeout 300 // how long a vote will run at max
-sv_vote_wait 120 // how long a votecaller has to wait to vote again if his vote did not pass
+hostname "Nexuiz Server" // this name will appear on the server list
 
-sv_ready_restart 0 // 1 to allow players to restart the server when all of them press the ready button
-sv_autoscreenshot 0 // 1 will force a screenshot for all clients when the map ends. Useful for the competitions or the ladder.
 
-sv_defaultcharacter 0 // 1 will force a specific model for all players
-sv_defaultplayermodel models/player/nexus.zym // this model will be used
-sv_defaultplayerskin 0 // this skin number will be forced for all players
-g_fullbrightplayers 0 // 1 to make players fullbright
-g_fullbrightitems 0 // 1 to make items fullbright
+// Some settings you MIGHT want to change.  IF so remove the // from the
+// line start and change them to your liking.  See the end of the file
+// for more g_maplist examples.
 
-g_grappling_hook 0 // 1 to enable the grappling hook
+//g_maplist 'dm_aggressor''dm_aneurysm''dm_basement''dm_bleach''dm_bluesky''dm_bloodprison''dm_darkzone''dm_downer''dm_evilspace''dm_farewell''dm_runningman''dm_runningman_1on1remix''dm_silvercity''dm_skyway''dm_slimepit''dm_soylent''dm_starship''dm_stormkeep''dm_toxic''dm_warfare' // the map cycle for the server
+//g_maplist_shuffle 0 // 1 will choose a random map as next map
 
-g_balance_teams 1 // 0 will show players the team selection menu after joining instead of automaticly putting them on the smaller team
-g_balance_teams_force 0 // 1 to automaticly balance teams even during a game
+//maxplayers 8 // number of players allowed on the server
+//port 26000 // the port used by the server
+//sv_public 1 // 0 if the server should not be on the public servers list
+//sv_motd "" // this message (unless "") is displayed to players on connect
 
-bot_number 0 // number of bots to add
-skill 1 // the bots skill level
-minplayers 0 // add bots if less then that number of players playing
-bot_prefix [BOT] // prepend this to all botnames
-bot_suffix "" // append this to all botnames
+//log_file server.log // server console output will also be copied to this file
+//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
 
-sv_mapchange_delay 5 // how long the pause between maps will be
-g_maplist_shuffle 0 // 1 will choose a random map as next map
 
-// remove the // from the beginning of one g_maplist line to play those maps only
-// arena mode (1on1 tourney)
+// Some more advanced settings.  You probably are not interesting in them.
+
+//sv_ready_restart 0 // 1 to allow players to restart the map when all of them press the ready button
+//sv_autoscreenshot 0 // 1 will force a screenshot for all clients when the map ends. Useful for competitions or the ladder.
+
+//g_antilag 0 // 1 to enable a experimental antilag feature
+
+//sys_ticrate 0.05 // how long a server frame is. 0.05 = 20 fps, 0.02 = 50 fps. Lower settings makes things smoother but create much more traffic
+//sv_maxrate 10000 // limits client connections to this rate in bytes/seconds
+
+//sv_curl_defaulturl "http://www.nexuiz.com/contentdownload/getmap.php?file=" //fallback download URL
+
+//sv_vote_commands "restart timelimit fraglimit chmap g_grappling_hook sv_defaultplayer_fbskin_green sv_defaultplayer_fbskin_red sv_defaultplayer_fbskin_orange sv_defaultplayer_fbskin_off" // players can vote for those commands or use them if they are masters
+//sv_vote_call 1 // 0 will disable the normal voting
+//sv_vote_master 1 // 0 will disable voting to become masters
+
+
+//sv_defaultcharacter 0 // 1 will force a specific model for all players
+//sv_defaultplayermodel models/player/nexus.zym // this model will be used
+//sv_defaultplayerskin 0 // this skin number will be forced for all players
+//g_fullbrightplayers 0 // 1 to make players fullbright
+//g_fullbrightitems 0 // 1 to make items fullbright
+
+//g_grappling_hook 0 // 1 to enable the grappling hook
+
+//g_balance_teams 1 // 0 will show players the team selection menu after joining instead of automaticly putting them on the smaller team
+//g_balance_teams_force 0 // 1 to automaticly balance teams even during a game
+
+//bot_number 0 // number of bots to add
+//skill 1 // the bots skill level
+//minplayers 0 // add bots if less then that number of players playing
+//bot_prefix [BOT] // prepend this to all botnames
+//bot_suffix "" // append this to all botnames
+
+
+// Some more examples for g_maplist
+
+// arena mode (1on1 elimination)
 //g_maplist 'arena_aggressor''arena_aneurysm''arena_basement''arena_basementctf''arena_bleach''arena_darkzone''arena_downer''arena_evilspace''arena_farewell''arena_runningman''arena_runningman_1on1remix''arena_silvercity''arena_skyway''arena_slimepit''arena_soylent''arena_starship''arena_stormkeep''arena_toxic''arena_warfare'
+
 // ctf mode
 //g_maplist 'ctf_basementctf''ctf_dismal''ctf_runningmanctf'
+
 // dm mode (free for all)
 //g_maplist 'dm_aggressor''dm_aneurysm''dm_basement''dm_bleach''dm_bluesky''dm_bloodprison''dm_darkzone''dm_downer''dm_evilspace''dm_farewell''dm_runningman''dm_runningman_1on1remix''dm_silvercity''dm_skyway''dm_slimepit''dm_soylent''dm_starship''dm_stormkeep''dm_toxic''dm_warfare'
+
 // domination mode
 //g_maplist 'dom_aggressor''dom_aneurysm''dom_basement''dom_bleach''dom_darkzone''dom_downer''dom_evilspace''dom_runningman''dom_runningman_1on1remix''dom_silvercity''dom_skyway''dom_slimepit''dom_soylent''dom_starship''dom_stormkeep''dom_toxic'
+
 // lms mode (last man standing)
 //g_maplist 'lms_aggressor''lms_basement''lms_bleach''lms_bluesky''lms_bloodprison''lms_downer''lms_evilspace''lms_farewell''lms_runningman''lms_runningman_1on1remix''lms_skyway''lms_slimepit''lms_soylent''lms_starship''lms_stormkeep''lms_toxic''lms_warfare'
+
 // rune mode
 //g_maplist 'rune_aggressor''rune_aneurysm''rune_basement''rune_bleach''rune_darkzone''rune_downer''rune_evilspace''rune_runningman''rune_runningman_1on1remix''rune_silvercity''rune_skyway''rune_slimepit''rune_soylent''rune_starship''rune_stormkeep''rune_toxic'
+
 // tdm mode (team deatch match)
 //g_maplist 'tdm_aggressor''tdm_aneurysm''tdm_basement''tdm_bleach''tdm_darkzone''tdm_downer''tdm_evilspace''tdm_farewell''tdm_runningman''tdm_runningman_1on1remix''tdm_silvercity''tdm_skyway''tdm_slimepit''tdm_soylent''tdm_starship''tdm_stormkeep''tdm_toxic''tdm_warfare'
-// create your own list here
-//g_maplist 'mode1_mapname1''mode2_mapname2'

Modified: trunk/Docs/server/server.cfg
===================================================================
--- trunk/Docs/server/server.cfg	2007-03-03 10:43:46 UTC (rev 2215)
+++ trunk/Docs/server/server.cfg	2007-03-03 12:08:38 UTC (rev 2216)
@@ -1,63 +1,86 @@
-// you need to surround a setting with " if it contains special characters like a space, a semicolon or //
-// "" is NO-SETTING, a semicolon separates commands and // starts a comment so the rest in the line is ignored when loading the file
+// A setting needs to be surrounded  with " if it contains special
+// characters like space, semicolon (seperates commands) or //
+// (starts a comment for the rest of the line).  While just ""
+// means 'no/empty setting".
 
-maxplayers 8 // number of players allowed on the server
-port 26000 // the port used by the server
-sv_public 1 // 0 if the server should not be on the public servers list
-hostname "my server (special things)" // this name will appear on the server list
-sv_motd "don't drink and frag" // this message is displayed to players on connect
-sv_maxrate 10000 // limits client connections to this rate in bytes/seconds
-sys_ticrate 0.05 // how long a server frame is. 0.05 = 20 fps, 0.02 = 50 fps. Lower settings makes things smoother but create more traffic
-g_antilag 0 // 1 to enable a experimental antilag feature
-sv_cheats 0 // 1 will enable fly/god and other cheats
 
-log_file server.log // server console output will also be copied to this file
-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
-sv_curl_defaulturl "http://www.nexuiz.com/contentdownload/getmap.php?file=" //default download URL
+// Everything has some sensible defaults so you do NOT really need to
+// change anything.  But here is a settings you SHOULD change to make
+// it 'YOUR' server.
 
-sv_vote_commands "restart timelimit fraglimit chmap g_grappling_hook sv_defaultplayer_fbskin_green sv_defaultplayer_fbskin_red sv_defaultplayer_fbskin_orange sv_defaultplayer_fbskin_off" // players can vote for those commands or use them if they are masters
-sv_vote_call 1 // 0 will disable the normal voting
-sv_vote_master 1 // 0 will disable voting to become masters
-sv_vote_timeout 300 // how long a vote will run at max
-sv_vote_wait 120 // how long a votecaller has to wait to vote again if his vote did not pass
+hostname "Nexuiz Server" // this name will appear on the server list
 
-sv_ready_restart 0 // 1 to allow players to restart the server when all of them press the ready button
-sv_autoscreenshot 0 // 1 will force a screenshot for all clients when the map ends. Useful for the competitions or the ladder.
 
-sv_defaultcharacter 0 // 1 will force a specific model for all players
-sv_defaultplayermodel models/player/nexus.zym // this model will be used
-sv_defaultplayerskin 0 // this skin number will be forced for all players
-g_fullbrightplayers 0 // 1 to make players fullbright
-g_fullbrightitems 0 // 1 to make items fullbright
+// Some settings you MIGHT want to change.  IF so remove the // from the
+// line start and change them to your liking.  See the end of the file
+// for more g_maplist examples.
 
-g_grappling_hook 0 // 1 to enable the grappling hook
+//g_maplist 'dm_aggressor''dm_aneurysm''dm_basement''dm_bleach''dm_bluesky''dm_bloodprison''dm_darkzone''dm_downer''dm_evilspace''dm_farewell''dm_runningman''dm_runningman_1on1remix''dm_silvercity''dm_skyway''dm_slimepit''dm_soylent''dm_starship''dm_stormkeep''dm_toxic''dm_warfare' // the map cycle for the server
+//g_maplist_shuffle 0 // 1 will choose a random map as next map
 
-g_balance_teams 1 // 0 will show players the team selection menu after joining instead of automaticly putting them on the smaller team
-g_balance_teams_force 0 // 1 to automaticly balance teams even during a game
+//maxplayers 8 // number of players allowed on the server
+//port 26000 // the port used by the server
+//sv_public 1 // 0 if the server should not be on the public servers list
+//sv_motd "" // this message (unless "") is displayed to players on connect
 
-bot_number 0 // number of bots to add
-skill 1 // the bots skill level
-minplayers 0 // add bots if less then that number of players playing
-bot_prefix [BOT] // prepend this to all botnames
-bot_suffix "" // append this to all botnames
+//log_file server.log // server console output will also be copied to this file
+//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
 
-sv_mapchange_delay 5 // how long the pause between maps will be
-g_maplist_shuffle 0 // 1 will choose a random map as next map
 
-// remove the // from the beginning of one g_maplist line to play those maps only
-// arena mode (1on1 tourney)
+// Some more advanced settings.  You probably are not interesting in them.
+
+//sv_ready_restart 0 // 1 to allow players to restart the map when all of them press the ready button
+//sv_autoscreenshot 0 // 1 will force a screenshot for all clients when the map ends. Useful for competitions or the ladder.
+
+//g_antilag 0 // 1 to enable a experimental antilag feature
+
+//sys_ticrate 0.05 // how long a server frame is. 0.05 = 20 fps, 0.02 = 50 fps. Lower settings makes things smoother but create much more traffic
+//sv_maxrate 10000 // limits client connections to this rate in bytes/seconds
+
+//sv_curl_defaulturl "http://www.nexuiz.com/contentdownload/getmap.php?file=" //fallback download URL
+
+//sv_vote_commands "restart timelimit fraglimit chmap g_grappling_hook sv_defaultplayer_fbskin_green sv_defaultplayer_fbskin_red sv_defaultplayer_fbskin_orange sv_defaultplayer_fbskin_off" // players can vote for those commands or use them if they are masters
+//sv_vote_call 1 // 0 will disable the normal voting
+//sv_vote_master 1 // 0 will disable voting to become masters
+
+
+//sv_defaultcharacter 0 // 1 will force a specific model for all players
+//sv_defaultplayermodel models/player/nexus.zym // this model will be used
+//sv_defaultplayerskin 0 // this skin number will be forced for all players
+//g_fullbrightplayers 0 // 1 to make players fullbright
+//g_fullbrightitems 0 // 1 to make items fullbright
+
+//g_grappling_hook 0 // 1 to enable the grappling hook
+
+//g_balance_teams 1 // 0 will show players the team selection menu after joining instead of automaticly putting them on the smaller team
+//g_balance_teams_force 0 // 1 to automaticly balance teams even during a game
+
+//bot_number 0 // number of bots to add
+//skill 1 // the bots skill level
+//minplayers 0 // add bots if less then that number of players playing
+//bot_prefix [BOT] // prepend this to all botnames
+//bot_suffix "" // append this to all botnames
+
+
+// Some more examples for g_maplist
+
+// arena mode (1on1 elimination)
 //g_maplist 'arena_aggressor''arena_aneurysm''arena_basement''arena_basementctf''arena_bleach''arena_darkzone''arena_downer''arena_evilspace''arena_farewell''arena_runningman''arena_runningman_1on1remix''arena_silvercity''arena_skyway''arena_slimepit''arena_soylent''arena_starship''arena_stormkeep''arena_toxic''arena_warfare'
+
 // ctf mode
 //g_maplist 'ctf_basementctf''ctf_dismal''ctf_runningmanctf'
+
 // dm mode (free for all)
 //g_maplist 'dm_aggressor''dm_aneurysm''dm_basement''dm_bleach''dm_bluesky''dm_bloodprison''dm_darkzone''dm_downer''dm_evilspace''dm_farewell''dm_runningman''dm_runningman_1on1remix''dm_silvercity''dm_skyway''dm_slimepit''dm_soylent''dm_starship''dm_stormkeep''dm_toxic''dm_warfare'
+
 // domination mode
 //g_maplist 'dom_aggressor''dom_aneurysm''dom_basement''dom_bleach''dom_darkzone''dom_downer''dom_evilspace''dom_runningman''dom_runningman_1on1remix''dom_silvercity''dom_skyway''dom_slimepit''dom_soylent''dom_starship''dom_stormkeep''dom_toxic'
+
 // lms mode (last man standing)
 //g_maplist 'lms_aggressor''lms_basement''lms_bleach''lms_bluesky''lms_bloodprison''lms_downer''lms_evilspace''lms_farewell''lms_runningman''lms_runningman_1on1remix''lms_skyway''lms_slimepit''lms_soylent''lms_starship''lms_stormkeep''lms_toxic''lms_warfare'
+
 // rune mode
 //g_maplist 'rune_aggressor''rune_aneurysm''rune_basement''rune_bleach''rune_darkzone''rune_downer''rune_evilspace''rune_runningman''rune_runningman_1on1remix''rune_silvercity''rune_skyway''rune_slimepit''rune_soylent''rune_starship''rune_stormkeep''rune_toxic'
+
 // tdm mode (team deatch match)
 //g_maplist 'tdm_aggressor''tdm_aneurysm''tdm_basement''tdm_bleach''tdm_darkzone''tdm_downer''tdm_evilspace''tdm_farewell''tdm_runningman''tdm_runningman_1on1remix''tdm_silvercity''tdm_skyway''tdm_slimepit''tdm_soylent''tdm_starship''tdm_stormkeep''tdm_toxic''tdm_warfare'
-// create your own list here
-//g_maplist 'mode1_mapname1''mode2_mapname2'