[nexuiz-commits] r6824 - trunk/data

[DONOTREPLY at icculus.org]

Author: greenmarine
Date: 2009-05-31 09:40:00 -0400 (Sun, 31 May 2009)
New Revision: 6824

Modified:
   trunk/data/defaultNexuiz.cfg
Log:
documented a couple of cvars, removed the g_shocknex variable (does that mean someone has to update that cvar count funny script thing again?)

Modified: trunk/data/defaultNexuiz.cfg
===================================================================
--- trunk/data/defaultNexuiz.cfg	2009-05-31 12:12:20 UTC (rev 6823)
+++ trunk/data/defaultNexuiz.cfg	2009-05-31 13:40:00 UTC (rev 6824)
@@ -231,17 +231,17 @@
 // server settings
 hostname "Nexuiz $g_nexuizversion Server"
 set sv_mapchange_delay 5
-set minplayers 0
+set minplayers 0 "number of players playing at the same time (if not enough real players are there the remaining slots are filled with bots)"
 sv_cullentities_trace 1
 r_cullentities_trace 1
 
 // restart server if all players hit "ready"-button
-set sv_ready_restart 0
+set sv_ready_restart 0 "if set to 1 allow a map to be restarted once all players pressed the \"ready\" button'"
 set sv_ready_restart_after_countdown 0	"if set to 1 the players and map items are reset after the countdown ended, otherwise they're reset already at the beginning of the countdown"
 set sv_ready_restart_repeatable 0	"allows the players to restart the game as often as needed"
 
 //nifreks lockonrestart feature, used in team-based game modes, if set to 1 and all players readied up no other player can then join the game anymore, useful to block spectators from joining
-set teamplay_lockonrestart 0
+set teamplay_lockonrestart 0 "it set to 1 in a team-based game, the teams are locked once all players readied up and the game restarted (no new players can join after restart unless using the server-command unlockteams)"
 
 set g_maxplayers 0	"maximum number of players allowed to play at the same time, set to 0 to allow all players to join the game"
 set g_maxplayers_spectator_blocktime 5	"if the players voted for the \"nospectators\" command, this setting defines the number of seconds a observer/spectator has time to join the game before he gets kicked"
@@ -252,12 +252,12 @@
 set g_warmup_allow_timeout 0	"if set to 0 you cannot use the calltimeout command during the warmup-stage but only during the match stage"
 set g_warmup_allguns 0	"if set players start with all guns in warmup mode"
 set g_warmup_start_health 250	"starting values when being in warmup-stage"
-set g_warmup_start_armor 100
-set g_warmup_start_ammo_shells 50
-set g_warmup_start_ammo_nails 150
-set g_warmup_start_ammo_rockets 50
-set g_warmup_start_ammo_cells 50
-set g_warmup_start_ammo_fuel 0
+set g_warmup_start_armor 100 "starting values when being in warmup-stage"
+set g_warmup_start_ammo_shells 50 "starting values when being in warmup-stage"
+set g_warmup_start_ammo_nails 150 "starting values when being in warmup-stage"
+set g_warmup_start_ammo_rockets 50 "starting values when being in warmup-stage"
+set g_warmup_start_ammo_cells 50 "starting values when being in warmup-stage"
+set g_warmup_start_ammo_fuel 0 "starting values when being in warmup-stage"
 
 set g_chat_nospectators 0	"if 0 spec/observer chat is always visible to the player, if 1 it is never visible to players, if 2 it is only visible to players during warmup stage"
 set sv_vote_nospectators 0	"if set only players can call a vote (thus spectators and observers can't call a vote)"
@@ -286,20 +286,20 @@
 seta sv_precacheweapons 0
 seta sv_precacheitems 0
 set sv_spectator_speed_multiplier 1.5
-seta sv_spectate 1
-seta sv_defaultcharacter 0
-seta sv_defaultplayermodel models/player/nexus.zym
-seta sv_defaultplayerskin 0
+seta sv_spectate 1 "if set to 1, new clients are allowed to spectate or observe the game, if set to 0 joining clients spawn as players immediately (no specating)"
+seta sv_defaultcharacter 0 "master switch, if set to 1 the further configuration for replacing all player models, skins and colors is taken from the sv_defaultplayermodel, sv_defaultplayerskin and sv_defaultplayercolors variables"
+seta sv_defaultplayermodel "models/player/nexus.zym" "default model selection, only works if sv_defaultcharacter is set to 1"
+seta sv_defaultplayerskin 0 "each model has 1 or more skins (combination of model and skin = character), set which skin of the model you wish the default character to have, only works if sv_defaultcharacter is set to 1"
 seta sv_defaultplayermodel_red ""	"\"\" means see sv_defaultplayermodel"
 seta sv_defaultplayerskin_red 0
-seta sv_defaultplayermodel_blue ""
+seta sv_defaultplayermodel_blue "" "\"\" means see sv_defaultplayermodel"
 seta sv_defaultplayerskin_blue 0
-seta sv_defaultplayermodel_yellow ""
+seta sv_defaultplayermodel_yellow "" "\"\" means see sv_defaultplayermodel"
 seta sv_defaultplayerskin_yellow 0
-seta sv_defaultplayermodel_pink ""
+seta sv_defaultplayermodel_pink "" "\"\" means see sv_defaultplayermodel"
 seta sv_defaultplayerskin_pink 0
 seta sv_defaultplayercolors ""	"set to 16*shirt+pants to force a color, note: it does NOT depend on defaultcharacter! Set to \"\" to disable"
-set sv_autoscreenshot 0
+set sv_autoscreenshot 0 "if set to 1, the server forces all clients to create a local screenshot once the map ended"
 net_messagetimeout 300
 net_connecttimeout 30
 sv_jumpstep 1 // step up stairs while jumping, makes it easier to reach ledges
@@ -396,48 +396,46 @@
 pausable 0
 set g_antilag 2	"AntiLag (0 = no AntiLag, 1 = verified client side hit scan, 2 = server side hit scan in the past, 3 = unverified client side hit scan)"
 set g_antilag_bullets 1 "Bullets AntiLag (0 = no AntiLag, 1 = server side hit scan in the past) - DO NOT TOUCH (severely changes weapon balance)"
-set g_shootfromeye 0
-set g_shootfromcenter 0
+set g_shootfromeye 0 "shots are fired from your eye/crosshair"
+set g_shootfromcenter 0 "weapon gets moved to the center, shots still come from the barrel of your weapon"
 set g_shootfromfixedorigin "" "if set to a string like 0 y z, the gun is moved to the given y and z coordinates. If set to a string like x y z, the whole shot origin is used"
-set g_pinata 0
-set g_weapon_stay 0
-set g_powerup_superhealth 1
-set g_powerup_strength 1
-set g_powerup_shield 1
-set g_use_ammunition 1
-set g_pickup_items 1
+set g_pinata 0 "if set to 1 you will not only drop your current weapon when you are killed, but you will drop all weapons that you possessed"
+set g_weapon_stay 0 "if set to 1 or 2, weapons stay after they were picked up (1: weapons you don't have yet give you ammo of their type, 2: weapons don't give ammo, but instead players start with one pickup-load of ammo by default)"
+set g_powerup_superhealth 1 "if set to 0 the mega health powerup will not spawn on the map"
+set g_powerup_strength 1 "if set to 0 the strength powerup will not spawn on the map"
+set g_powerup_shield 1 "if set to 0 the shield (invincibility) powerup will not spawn on the map"
+set g_use_ammunition 1 "if set to 0 all weapons you pick up have unlimited ammunition"
+set g_pickup_items 1 "if set to 0 all items (health, armor, ammo, weapons...) are removed from the map"
 set g_minstagib 0	"enable minstagib"
 set g_minstagib_extralives 2	"how many extra lives you will get per powerup"
 set g_minstagib_ammo_start 10	"starting ammo"
 set g_minstagib_ammo_drop 5	"how much ammo you'll get for weapons or cells"
 set g_minstagib_invis_alpha 0.15
-set g_minstagib_speed_jumpheight 1.8
-set g_minstagib_speed_moverate 1.25
-set g_vampire 0
+set g_minstagib_speed_jumpheight 1.8 "jump height multiplier that applies while you carry the invincibility powerup"
+set g_minstagib_speed_moverate 1.25 "speed-multiplier that applies while you carry the invincibility powerup"
+set g_vampire 0 "set to 1 to enable the vampire mode, where the damage done to your opponent gets added to your own health"
 set g_weaponarena "0"	"put in a list of weapons to enable a weapon arena mode, or try \"all\" or \"most\""
-set g_shocknex 0
-set g_laserguided_missile 0
-set g_midair 0
-set g_midair_shieldtime 0.3
-set g_spawnshieldtime 0
-set g_spawnsound 1
-set g_spawnpoints_autodrop 0
-set g_spawnpoints_auto_move_out_of_solid 0
-set g_forced_respawn 0
-set g_fullbrightplayers 0
-set g_fullbrightitems 0
-set g_casings 2
-set g_norecoil 0
-set g_throughfloor 1
-set g_maplist_mostrecent ""
+set g_laserguided_missile 0 "if set to 1 the rockets of the rocket launcher can be steered using a laserpointer"
+set g_midair 0 "if set to 1 you can only apply damage to your opponent while he is airborne"
+set g_midair_shieldtime 0.3 "number of seconds you are still invincible since you lost contact to the ground"
+set g_spawnshieldtime 0 "number of seconds you are invincible after you spawned, this shield is lost after you fire"
+set g_spawnsound 1 "set to 0 if you don't want to hear the spawn sound when a player spawns"
+set g_spawnpoints_autodrop 0 "if set to 1, automatically drop spawn point locations if they were placed too high"
+set g_spawnpoints_auto_move_out_of_solid 0 "if set to 1 you will see a warning if a spawn point was placed inside a solid"
+set g_forced_respawn 0 "if set to 1 and a player died, that player gets automatically respawned once <g_respawn_delay> seconds are over"
+set g_fullbrightplayers 0 "brightens up player models (note that the color, skin or model of the players does not change!)"
+set g_fullbrightitems 0 "brightens up items"
+set g_casings 2 "specifies which casings (0: none, 1: only shotgun casings, 2: shotgun and machine gun casings) are sent to the client"
+set g_norecoil 0 "if set to 1 shooting weapons won't make you crosshair to move upwards (recoil)"
+set g_throughfloor 1 "set to 0 to disable damage through floor"
+set g_maplist_mostrecent "" "contains the name of the maps that were most recently played"
 seta g_maplist_mostrecent_count 3	"number of most recent maps that are blocked from being played again"
 seta g_maplist "accident aggressor aneurysm basement basementctf bleach bloodprison bloodprisonctf bluesky darkzone desertfactory dieselpower dismal downer eggandbacon evilspace farewell final_rage ons-reborn racetrack reslimed ruiner runningman runningman_1on1remix runningmanctf silvercity skyway slimepit soylent starship stormkeep strength toxic warfare"
 seta g_maplist_index 0	"this is used internally for saving position in maplist cycle"
 seta g_maplist_selectrandom 0	"if 1, a random map will be chosen as next map - DEPRECATED in favor of g_maplist_shuffle"
 seta g_maplist_shuffle 1	"new randomization method: like selectrandom, but avoid playing the same maps in short succession. This works by taking out the first element and inserting it into g_maplist with a bias to the end of the list"
-// timeout for kill credit when your damage knocks someone into a death trap
 set g_maplist_check_waypoints 0	"when 1, maps are skipped if there currently are bots, but the map has no waypoints"
-set g_maxpushtime 8.0
+set g_maxpushtime 8.0 "timeout for kill credit when your damage knocks someone into a death trap"
 
 set g_cloaked 0
 set g_player_alpha 1
@@ -469,7 +467,7 @@
 // 50% of the spawns shall be far away from any players
 set g_spawn_furthest 0.5
 // respawn delay
-set g_respawn_delay 2
+set g_respawn_delay 2 "number of seconds you have to wait before you can respawn again"
 set g_respawn_waves 0
 // when variables are set to 0, they take over the global setting...
 // to force disable delay or waves, set them to 0.125