Initial improvements on configuration files. More needs to be changed.

cstrike/cfg/sourcemod/zombiereloaded/zombiereloaded.cfg

@@ -1,22 +1,36 @@
+// ============================================================================
 //
+//                              Zombie:Reloaded
+//                             Main configuration
 //
-// Zombie:Reloaded Settings
+//            Check section 3.0 in the manual for detailed info.
-//
 //
+// ============================================================================
 
-// The length of the round, in minutes, after this time is up, if there are any humans left, humans win
+// ------------------------------------
-mp_roundtime 5
+//
+// Standard Counter-Strike Settings
+//
+// ------------------------------------
 
-// Allows players to move items with their 'use' key
+// The length of the round, in minutes. If there are any humans left after this
-sv_turbophysics 0
+// time is up, humans win.
+// -
+// Default: "5"
+mp_roundtime "5"
 
-// Multiplier for how easy props are moved (1 default)
+// Allows players to move items with their "use" key. Disabled by default
+// because players sometimes get stuck.
+// -
+// Default: "0"
+sv_turbophysics "0"
+
+// Multiplier for how easy props are moved.
+// -
+// Default: "3"
 phys_pushscale 3
 
-//
 // Ammo settings
-//
-
 ammo_50AE_max 500       // deagle
 ammo_762mm_max 300      // scout, ak47, g3sg1, aug
 ammo_556mm_box_max 300  // m249
@@ -28,9 +42,12 @@ ammo_45acp_max 500 // ump45, mac10, usp
 ammo_357sig_max 500     // P228
 ammo_57mm_max 500       // p90, fiveseven
 
+
+// ------------------------------------
 //
 // Weapon Restrictions
 //
+// ------------------------------------
 
 zr_restrict "flashbang"
 zr_restrict "smokegrenade"
@@ -38,77 +55,106 @@ zr_restrict "m249"
 zr_restrict "snipers"
 zr_restrict "nvgs"
 
+
+// ------------------------------------
 //
 // General
 //
+// ------------------------------------
 
-// Enable zombie gameplay (0: Disable)
+// Enable zombie gameplay
+// -
+// Default: "1"
 zr_enable "1"
 
 // Logging flags. See manual for details.
+// -
+// Default: "323"
 zr_log "323"
 
-// This will allow the player_team event to be fired on first team join, enable when using mani model menu (0: Disable)
+// This will allow the player_team event to be fired on first team join. Enable
+// if using mani admin model menu.
+// -
+// Default: "0"
 zr_allow_player_team "0"
 
-// Stops players from suiciding
+// Give players cash on spawn.
-zr_suicide "1"
+// -
-
+// Default: "1"
-// Log suicide attempts to admin chat.
-zr_suicide_echo "1"
-
-// Respawn as zombie if a zombie was killed by the world.
-zr_suicide_world_damage "1"
-
-// Players that join late will be protected for this long, in seconds (0: Disable)
-zr_protect "10"
-
-// Enable the mod to set the players cash to zr_cashamount (0: Disabled)
 zr_cashfill "1"
 
-// How much money players will have when they spawn when zr_cashfill is 1
+// How much money players will have when they spawn, if cash fill is turned on.
-zr_cashamount "12000"
+// -
+// Default: "16000"
+zr_cashamount "16000"
 
-// Default value for darkening maps,  most dislike this feature (0: Disable)
+// Block suicide attempts on humans.
-zr_dark "0"
+// -
+// Default: "1"
+zr_suicide_human "1"
 
-// The darkness of the map,  a being the darkest,  z being extremely bright when zr_dark is 1 (n: Default)
+// Block suicide attempts on zombies.
-zr_dark_level "a"
+// -
+// Default: "1"
+zr_suicide_zombie "1"
 
-// The sky the map will have when zr_dark is 1
+// Log suicide attempts to admin chat. (Deprecated. Use the log system.)
-zr_dark_sky "sky_borealis01"
+// -
+// Default: "0"
+zr_suicide_echo "0"
 
-// How often a zombie emits a sound,  in seconds (0: Disable)
+// Respawn zombies as zombies if they were killed by world damage, like doors,
-zr_emitsounds "50"
+// elevators and lasers.
+// -
+// Default: "1"
+zr_suicide_world_damage "1"
 
-// Frequency, in seconds, to display overlay on the client's screen (Never go below 0.1, 0.2 seems safe)
+// Spawn protection time on players that join late.
-zr_overlay_redisplay "0.2"
+// -
+// Default: "15"
+zr_protect "15"
 
-// Allow users to disable ZVision with their nightvision key (0: Disable)
-zr_zvision_allow_disable "1"
 
+// ------------------------------------
 //
-// Zombie
+// Zombie Gameplay
 //
+// ------------------------------------
 
-// Maximum time a player is picked to be zombie after the round starts,  in seconds
+// Maximum time, in seconds, a player is picked to be zombie after the round
+// starts.
+// -
+// Default: "50"
 zr_spawn_max "50"
 
-// Minimum time a player is picked to be zombie after the round starts,  in seconds
+// Minimum time, in seconds, a player is picked to be zombie after the round
+// starts.
+// -
+// Default: "30"
 zr_spawn_min "30"
 
-// For every 'x' number of humans,  there will be 1 zombie (0: Always only 1 mother zombie)
+// Mother zombie ratio. For every "n" number of humans, there will be one
-zr_mother_zombie_ratio "5"
+// zombie. (0: Always only 1 mother zombie)
+// -
+// Default: "8"
+zr_mother_zombie_ratio "8"
 
-// First zombie(s) will be teleported back to spawn when infected (0: Disable)
+// The first zombie(s) will be teleported back to spawn on first infection.
+// -
+// Default: "0"
 zr_mother_zombie_respawn "0"
 
-// Allow player to be randomly chosen twice in a row to be a mother zombie (0: Disable)
+// Allow player to be randomly chosen twice in a row to be a mother zombie.
+// -
+// Default: "0"
 zr_consecutive_infect "0"
 
+
+// ------------------------------------
 //
-// Zombie Info (deprecated, will be removed soon)
+// Zombie Info (deprecated)
 //
+// ------------------------------------
 
 // The default health of a zombie
 zr_zombie_health "5000"
@@ -158,127 +204,239 @@ zr_zombie_infect_health "100"
 // Overlay to be shown on all zombies' screen on infection (Leave empty to disable)
 zr_zombie_zvision "overlays/zr/zvision"
 
+
+// ------------------------------------
 //
 // Infection Effects
 //
+// ------------------------------------
 
-// An energy splash is emitted when player is infected ( 0: Disable)
+// An energy splash is emitted when player is infected.
+// -
+// Default: "1"
 zr_infect_esplash "1"
 
-// A fireball is created when a player is infected ( 0: Disable)
+// A fireball is created when a player is infected.
+// -
+// Default: "1"
 zr_infect_fireball "1"
 
-// Sound played from from player on infection (Leave blank to disable)
+// Sound played from from player on infection. Leave blank to disable.
+// -
+// Default: "npc/fast_zombie/fz_scream1.wav"
 zr_infect_sound "npc/fast_zombie/fz_scream1.wav"
 
-// A puff of smoke is created when a player is infected (0: Disable)
+// A puff of smoke is created when a player is infected.
+// -
+// Default: "1"
 zr_infect_smoke "1"
 
-// Sparks are emitted when a player is infected (0: Disable)
+// Sparks are emitted when a player is infected.
+// -
+// Default: "1"
 zr_infect_sparks "1"
 
-//Player's screen is shaken on infection (0: Disable)
+//Player's screen is shaken on infection.
+// -
+// Default: "1"
 zr_infect_shake "1"
 
-// Amplitude of the shake, when zr_infect_shake is 1
+// Amplitude of the shake, when shake is enabled.
+// -
+// Default: "15.0"
 zr_infect_shake_amp "15.0"
 
-// Frequency of the shake, when zr_infect_shake is 1
+// Frequency of the shake, when shake is enabled.
+// -
+// Default: "1.0"
 zr_infect_shake_frequency "1.0"
 
-// Duration of the shake, when zr_infect_shake is 1
+// Duration of the shake, when shake is enabled.
+// -
+// Default: "5.0"
 zr_infect_shake_duration "5.0"
 
+
+// ------------------------------------
 //
 // Classes
 //
+// ------------------------------------
 
-// Enable zombie classes
+// Enable zombie classes. (Deprecated)
 zr_classes "1"
 
 // A random class is assigned to each player every round (0: Disable)
+// -
+// Default: "0"
 zr_classes_random "0"
 
 // Classmenu is re-displayed every spawn (0: Disable)
+// -
+// Default: "0"
 zr_classes_spawn "0"
 
-// The default class for zombies. If empty or incorrectly spelled it will fall back to the first class.
+// The default class for zombies. (Deprecated)
 zr_classes_default "classic"
 
-// Save class selection when changing maps. This one will override the default class. Default: 0
-zr_classes_save "0"
 
+// ------------------------------------
 //
 // Ambience
 //
+// ------------------------------------
 
 // Enable creepy ambience to be played throughout the game (0: Disable)
+// -
+// Default: "1"
 zr_ambience "1"
 
-// Path to ambient sound file that will be played throughout the game, when zr_ambience is 1
+// Path to ambient sound file that will be played throughout the game, when
+// ambience is enabled.
+// -
+// Default: "ambient/zr/zr_ambience.mp3"
 zr_ambience_file "ambient/zr/zr_ambience.mp3"
 
-// The length, in seconds, of the ambient sound file
+// The length, in seconds, of the ambience sound file.
+// -
+// Default: "60.0"
 zr_ambience_length "60.0"
 
-// Volume of ambient sounds when zr_ambience is 1 (0.0: Unhearable,  1.0: Max volume)
+// Volume of ambience sound when ambience is enabled. (0.0: Unhearable,
-zr_ambience_volume "0.6"
+// 1.0: Max volume)
+// -
+// Default: "0.8"
+zr_ambience_volume "0.8"
 
+// Make maps dark. (0: Disable)
+// -
+// Default: "0"
+zr_dark "0"
+
+// The darkness of the map, a being the darkest, z being extremely bright.
+// -
+// Default: "n"
+zr_dark_level "n"
+
+// The sky the map will have when darkness is enabled.
+// -
+// Default: "sky_borealis01"
+zr_dark_sky "sky_borealis01"
+
+// How often a zombie emits a sound, in seconds. (0: Disable)
+// -
+// Default: "50"
+zr_emitsounds "50"
+
+
+// ------------------------------------
 //
 // Overlays
 //
+// ------------------------------------
 
 // Will show overlays that tell who the winner of the round was (0: Disable)
+// -
+// Default: "1"
 zr_overlays "1"
 
-// The overlay shown to tell everyone that humans won when zr_overlays is 1
+// Overlay for humans win event.
+// -
+// Default: "overlays/zr/humans_win"
 zr_overlays_human "overlays/zr/humans_win"
 
-// The overlay shown to tell everyone that zombies won when zr_overlays is 1
+// Overlay for zombies win event.
+// -
+// Default: "overlays/zr/zombies_win"
 zr_overlays_zombie "overlays/zr/zombies_win"
 
+// Frequency, in seconds, to re-display overlay on the client's screen.
+// -
+// Default: "3"
+zr_overlay_redisplay "3"
+
+// Allow players to disable overlays with their nightvision key (0: Disable)
+// -
+// Default: "1"
+zr_zvision_allow_disable "1"
+
+
+// ------------------------------------
 //
 // Respawn
 //
+// ------------------------------------
 
-// When player is killed,  player will respawn
+// Respawn players when they die.
-zr_respawn "0"
+// -
+// Default: "1"
+zr_respawn "1"
 
-// How long to wait after death to respawn,  in seconds
+// How long to wait after death to respawn, in seconds.
+// -
+// Default: "1"
 zr_respawn_delay "1"
 
-// Which team to respawn player as (Choices: zombie, human)
+// Which team to respawn player as. (Choices: zombie, human)
+// -
+// Default: "human"
 zr_respawn_team "human"
 
+
+// ------------------------------------
 //
 // Commands
 //
+// ------------------------------------
 
-// Must be in buyzone to access !zmarket, if Market is installed (0: Can be used anywhere)
+// Must be in buyzone to access !zmarket, if Market is installed.
+// -
+// Default: "1"
 zr_zmarket_buyzone "1"
 
-// Allow players to spawn if they just joined the game (0: Disable)
+// Allow players to spawn if they just joined the game. (0: Disable)
+// -
+// Default: "1"
 zr_zspawn "1"
 
-// Allow players that are stuck together to get unstuck (0: Disable)
+// Startup delay for the deleporter. (0: Disable)
-zr_zstuck "1"
+// -
-
+// Default: "20"
-// Startup delay for the deleporter (0: Disable)
 zr_tele_startup_delay "20"
 
-// Cooldown delay before a teleport can be done again (0: Disable)
+// Cooldown delay before a teleport can be done again. (0: Disable)
+// -
+// Default: "15"
 zr_tele_cooldown "15"
 
-// Teleport delays for humans and zombies (0: Disable)
+// Teleport delays for humans. (0: Disable)
+// -
+// Default: "10"
 zr_tele_human_delay "10"
+
+// Teleport delays for zombies. (0: Disable)
+// -
+// Default: "0"
 zr_tele_zombie_delay "0"
 
-// Teleport limits for humans and zombies per round (0: Not allowed to teleport, -1: Unlimited)
+// Teleport limits for humans per round. (0: Not allowed to teleport,
+// -1: Unlimited)
+// -
+// Default: "3"
 zr_tele_human_limit "3"
+
+// Teleport limits for zombies per round. (0: Not allowed to teleport,
+// -1: Unlimited)
+// -
+// Default: "8"
 zr_tele_zombie_limit "8"
 
-// Allows clients to enable/disable zombie health display (1: On,  0: Off)
+// Allows clients to disable zombie health display.
+// -
+// Default: "1"
 zr_zhp "1"
 
-// The default value of zombie health display to new clients (1: On,  0: Off)
+// The default value of zombie health display to new clients.
+// -
+// Default: "1"
 zr_zhp_default "1"