Targets plugin version 3.0.0 Beta 2, (not released)
Written by Richard Helgeby
Manual last modified: 2009.10.10
+Manual last modified: 2009.10.14
Zombie:Reloaded remake of Zombie Mod with a lot of new features and improvements. It's made for -a Counter-Strike: Source server and runs on a powerful scripting platform called SourceMod.
+Zombie:Reloaded a alternative to Zombie Mod with a lot of new features and improvements. It's +open source and made for Counter-Strike: Source and runs on a powerful scripting platform called +SourceMod.
The objectives is to change the game into humans versus zombies. Humans try to survive by @@ -196,6 +197,10 @@ Zombies have certain advantages as running faster and more health points. Humans of ammo (or unlimited), and their bullets knock back zombies. A lot more attributes can be adjusted for both zombies and humans in different classes.
+This plugin is often confused by Zombie Mod, which is actually ovbious since +Zombie:Reloaded is a SourceMod alternative to Zombie Mod and the gameplay is exactly the same. This +plugin is compatible with all existing Zombie Mod maps.
+Zombie: Reloaded requires that the following stuff is installed on the server:
Metamod:Source - A simplified API for server plugins. It makes it easier for developers @@ -259,13 +264,11 @@ for both zombies and humans in different classes.
Extract the content of the zip file into "cstrike/" on the server.
+Extract the content of "cstrike" in the zip file into "cstrike" on the server. The folder and +file structure is already set up correctly and ready to be extracted.
-This plugin is often confused by Zombie Mod, which is actually ovbious since -Zombie:Reloaded is a SourceMod alternative to Zombie Mod.
- -The plugin should work with default configuration. Start the server and join a team. Once the round starts there sould be some messages at the chat with "[ZR]". Or type "!zmenu" in the chat to bring up the zombie menu to confirm that the plugin is running.
@@ -276,7 +279,7 @@ If the plugin doesn't work at all or there are error logs, see TrouIn this manual commands or paths may be written in a certain style that tells how to use it.
Note that the style itself is not written, but it's used as an indicator to tell if a parameter @@ -348,7 +351,7 @@ do this on all string parameters to avoid parsing mistakes.
results and is an example of why strings should be quoted. -These are the default configuration files. The paths are relative to the "cstrike" folder.
@@ -395,7 +398,7 @@ that modify loaded data must be put in post configuration files. How to configur explained in their own sections. -@@ -361,31 +364,31 @@ results and is an example of why strings should be quoted.
cfg/sourcemod/zombiereloaded/zombiereloaded.cfg - Map conf. +Map config. cfg/sourcemod/zombiereloaded/<mapname>.cfg - Post map conf. +Post map conf. cfg/sourcemod/zombiereloaded/<mapname>.post.cfg - Hitgroup conf. +Hitgroup conf. addons/sourcemod/configs/zr/hitgroups.txt - Class conf. +Class conf. addons/sourcemod/configs/zr/playerclasses.txt - Weapon conf. +Weapon conf. addons/sourcemod/configs/zr/weapons.txt - Download list +Download list addons/sourcemod/configs/zr/downloads.txt - Model list +Model list addons/sourcemod/configs/zr/models.txt
The log system used in Zombie:Reloaded is pretty powerful and customizable. It's based on logging flags and a module filter.
@@ -701,7 +704,7 @@ unit converter like below can also be used. -Configuration files for each map is supported. They're executed after the main configuration files are executed, and are ideal for customizing map settings. These files are just regular @@ -716,7 +719,7 @@ attributes or changing ambience sound.
There are two kinds of map configs; pre and post. Pre map configuration files are executed before the modules are loaded. They're useful for changing configuration sets for certain modules like classes. Post map configuration files are executed after the modules are loaded. Certain stuff -have to be placed in this one to take effect, like changing class attributes.
+have to be placed in this one to be effective, like changing class attributes.These flags can be used in a combination (1 + 2), so it could be a mother zombie @@ -1720,8 +1723,8 @@ menu is useful for finding the correct value, and then use it in a map configura
While testing or adjusting class attributes they must be reloaded before they will take effect. -This only applies to players who already is the same class.
+While testing or adjusting class attributes they must be reloaded before they will be effective. +This only applies to players who already are the same class.
-
@@ -1810,7 +1813,7 @@ multipliers.
The weapon module can be used to restict weapons or scale knockback.
@@ -2178,6 +2181,1004 @@ file, or on a per-map basis with map configuration files. +Hit group configuration makes it possible to disable damage or adjust knock back per hit group. +This is useful for fine tuning game balance.
+ +The hit group configuration file is a file in Valve's key/value format with the root key +"hitgroups" and a sub key for each hit group.
+ +The default file is:
+ ++ +addons/sourcemod/configs/zr/hitgroups.txt
Console commands:
+ ++ ++
+ + +Syntax: ++ +zr_hitgroup <hitgroup name> [value] ++ ++ +Toggles or sets if a zombie's hitgroup can be damaged.
+Parameters:
++
++ +hitgrup name +Name of the hit group to adjust. Options: + ++
+- generic
+- head
+- chest
+- stomach
+- leftarm
+- rightarm
+- leftleg
+- rightleg
+- gear
++ value Optional. Enable hit group damage. Default action is to toggle + setting. Options: 0 or 1
+ ++
+ + +Attribute: +Type: +Limits/Requirements: ++ +index +number +- ++ + ++ +The hit group index.
+Options:
++
++ 0 Generic + 1 Head + 2 Chest + 3 Stomach + 4 Left Arm + 5 Right Arm + 6 Left Leg + 7 Right Leg + 8 Gear + +damage +text +"yes" or "no" ++ + ++ +Allows damage to be done on the specified hit group for zombies.
+Options:
++
++ yes Allow damage + no Ignore damage + +knockback +decimal +- ++ ++ +The knock back multiplier for the hitgroup. 1.0 for no change.
+
The infection module handles all infection events and does random infection on mother zombies. +It's the core part of the plugin that creates this human vs. zombies game.
+ +Number of mother zombies is based on a ratio setting, so on server with many players more mother +zombies will be spawned than on a server with few players. Server admins can adjust this ratio to +tune game balance.
+ +In addition several infection effects can be enabled or disabled.
+ +These are the console variables for the infection module:
+ ++ ++
+ + +Console variable: +Default: ++ +zr_infect_mzombie_ratio +5 ++ + ++ +Mother zombie ratio. Every random N-th player is infected. In this case it's 5 where + every fifth player will be infected. If it's set to 0 there will be only 1 mother zombie + every time.
+Options:
+
+ 0 or a positive number up to max server slots+ +zr_infect_mzombie_respawn +0 ++ + ++ +Teleport mother zombies to spawn place when infected.
+Options:
+
+ 0 or 1+ +zr_infect_spawntime_min +30.0 ++ + ++ +Minimum time when mother zombies spawn. Time is in seconds.
++ +zr_infect_spawntime_max +50.0 ++ + ++ +Maximum time when mother zombies spawn. Time is in seconds.
++ +zr_infect_consecutive_block +1 ++ + ++ +Blocks players from being mother zombie twice in a row.
+Options:
+
+ 0 or 1+ +zr_infect_weapons_drop +1 ++ + ++ +Force players to drop weapons and grenades when infected. So other players can use them.
+Options:
+
+ 0 or 1+ +zr_infect_sound +npc/fast_zombie/fz_scream1.wav ++ + ++ +Sound played when infected. The file path is relative to the "sound" folder. Leave + blank ("") to disable infection sound.
++ +zr_infect_explosion +1 ++ + ++ +Enable explosion effects. If disabled, this setting will also disable the following + CVARs:
++
+- zr_infect_fireball
+- zr_infect_smoke
+- zr_infect_smoke
+Options:
+
+ 0 or 1+ +zr_infect_fireball +1 ++ + ++ +Spawn a fire ball effect around the player on infection.
+Options:
+
+ 0 or 1+ +zr_infect_smoke +1 ++ + ++ +Spawn a smoke cloud effect around the player on infection.
+Options:
+
+ 0 or 1+ +zr_infect_sparks +1 ++ + ++ +Emit sparks from the the player on infection.
+Options:
+
+ 0 or 1+ +zr_infect_esplash +1 ++ + ++ +Emit an energy splash effect from the player on infection.
+Options:
+
+ 0 or 1+ +zr_infect_shake +1 ++ + ++ +Shake the player's view on infection.
+Options:
+
+ 0 or 1+ +zr_infect_shake_amp +15.0 ++ + ++ +Shake amplitude, how strong the shake is. Amplitude is in units.
++ +zr_infect_shake_frequency +1.0 ++ + ++ +Shake frequency, how fast the shake is. Frequency is in hertz (cycles per second).
++ +zr_infect_shake_duration +5.0 ++ ++ +Duration of shake, how long the shake lasts. Time is in seconds.
+
Console commands:
+ ++ + ++
+ + +Syntax: ++ +zr_infect <target> [respawn] ++ + ++ +Infects one or more players.
+Parameters:
++
++ target A SourceMod target string with one or more players. + respawn Teleport players to spawn. + +zr_human <target> [respawn] ++ ++ +Turn one or more zombies into humans.
+Parameters:
++
++ target A SourceMod target string with one or more players. + respawn Teleport players to spawn.
With damage control it's possible to block suicide attempts, fall damage, blast damage and hit +group damage. See Hit Group Configuration (3.9) on how to configure hit groups.
+ +Damage control console variables:
+ ++ + ++
+ + +Console variable: +Default: ++ +zr_damage_hitgroups +1 ++ + ++ +Enables hit group damage control. See Hit Group Configuration (3.9) on how to configure + hit groups.
+Options:
+
+ 0 or 1+ +zr_damage_block_ff +1 ++ + ++ +Block friendly fire between zombies.
+Options:
+
+ 0 or 1+ +zr_damage_block_blast +1 ++ + ++ +Block blast damage inflicted on self or teammates.
+Options:
+
+ 0 or 1+ +zr_damage_suicide_zombie +0 ++ + ++ +Block suicide attempts by regular zombies.
+Options:
+
+ 0 or 1+ +zr_damage_suicide_mzombie +1 ++ + ++ +Block suicide attempts by mother zombies.
+Options:
+
+ 0 or 1+ +zr_damage_suicide_human +0 ++ + ++ +Block suicide attempts by humans.
+Options:
+
+ 0 or 1+ +zr_damage_suicide_cmds +"kill, spectate, jointeam" ++ ++ +List of console commands that are treated as suicide attempts. Separated by ", ". + These commands are often bound to a key on the client, like "m" is bound to "jointeam".
+
Overlays are pictures displayed on players' screen on certain events. However, these overlays +require DirectX 9 or higher to work. Players with lower DirectX version won't see these overlays.
+ +Since these overlays doesn't last forever, they must be redisplayed at a certain interval. A +refresh once per second seems to be enough.
+ +When the round ends, overlays for either humans or zombies are displayed, depending on the winning +team.
+ +Overlays are also used as a class attribute, like the zombie vision effect.
+ +These are the overlay console variables:
+ ++ + ++
+ + +Console variable: +Default: ++ +zr_overlays_update_time +1.0 ++ + ++ +How often overlays are refreshed. Time is in seconds.
++ +zr_roundend_overlay +1 ++ + ++ +Show overlays for the winning team when the round ends.
+Options:
+
+ 0 or 1+ +zr_roundend_overlays_human +overlays/zr/humans_win ++ + ++ +Overlay to be displayed when humans win. Path is relative to the "materials" folder.
++ +zr_roundend_overlays_zombie +overlays/zr/zombies_win ++ ++ +Overlay to be displayed when zombies win. Path is relative to the "materials" folder.
+
Players' cash can be modified and reset on every spawn if enabled.
+ ++ + ++
+ + +Console variable: +Default: ++ +zr_account_cashfill +1 ++ + ++ +Resets player's cash every spawn. Cash amount is specified in + zr_account_cashfill_value.
+Options:
+
+ 0 or 1+ +zr_account_cashfill_value +12000 ++ + ++ +How much cash to give each spawn, if enabled.
+Options:
+
+ 0 or 1+ +zr_account_cashdmg +0 ++ ++ +Attacker receives amount of cash equivalent to the damage that was inflicted. If this + one is enabled, the zr_account_cashfill and zr_account_cashfill_value console variables + is ignored.
+Options:
+
+ 0 or 1
With visual effects it makes it possible to give a creepy ambience. It's possible to change light +style in maps and set dissolve effects on players' bodies when they die.
+ +It supposed to have support for adding fog, but because of technical limits in SourceMod it's not +fully functional yet. For developers who wonder why, it's because there must be a env_fog_controller +entity in the map. That entity isn't networked so SourceMod can't create that entity type (Logical Entity Support is a work +in progress by the SourceMod team).
+ +Currently, fog can only be modified if the map already has a env_fog_controller entity.
+ +Console variables for visual effects:
+ ++ + ++
+ + +Console variable: +Default: ++ +zr_veffects_lightstyle +0 ++ + ++ +Change light style (brightness) in the map.
+Options:
+
+ 0 or 1+ +zr_veffects_lightstyle_value +b ++ + ++ +Light brightness value. The brightness is represented by characters from "a" to "z" + where "a" is dark, "n" is normal, and "z" is bright.
+Options:
+
+ a (dark) to z (bright)+ +zr_veffects_sky +0 ++ + ++ +Change skybox of the map.
+Options:
+
+ 0 or 1+ +zr_veffects_sky_path +sky_borealis01up.vmt ++ + ++ +The skybox to use, if enabled. Path is relative to "materials/skybox".
++ +zr_veffects_sun_disable +0 ++ + ++ +Remove the sun entity on the map. Disables sun rendering on the map.
+Options:
+
+ 0 or 1+ +zr_veffects_fog +0 ++ + ++ +Note: Incomplete. May or may not work.
+Enable fog on the map.
+Options:
+
+ 0 or 1+ +zr_veffects_fog_override +0 ++ + ++ +Note: Incomplete. May or may not work.
+Override existing fog on the map. If fog exists already on the map, replace it with + the new modified fog.
+Options:
+
+ 0 or 1+ +zr_veffects_fog_pcolor +"255 255 255" ++ + ++ +Note: Incomplete. May or may not work.
+Sets the primary fog color. Three values from 0 to 255 separated by a space, + representing amount of red, green and blue.
+Examples
++
++ 255 255 0 Yellow + 255 0 255 Purpule + 96 96 96 Dark grey + +zr_veffects_fog_scolor +"255 255 255" ++ + ++ +Note: Incomplete. May or may not work.
+Sets the secondary fog color. Three values from 0 to 255 separated by a space, + representing amount of red, green and blue.
+Examples
++
++ 255 255 0 Yellow + 255 0 255 Purpule + 96 96 96 Dark grey + +zr_veffects_fog_density +0.8 ++ + ++ +Note: Incomplete. May or may not work.
+Density (thickness) of the fog. The value is in percent, 0.0 to 1.0.
+Options:
+
+ 0.0 to 1.0+ +zr_veffects_fog_startdist +0 ++ + ++ +Note: Incomplete. May or may not work.
+Distance from player to start rendering foremost fog. Distance is in game units (1 + unit is ~1 inch). For reference, default player models are ~75 units tall.
++ +zr_veffects_fog_enddist +400 ++ + ++ +Distance from player to stop rendering fog. Distance is in game units (1 unit is ~1 + inch). For reference, default player models are ~75 units tall.
++ +zr_veffects_fog_farz +2000 ++ + ++ +Distance to stop render everything, for optimizing purposes. This should be equal to + or bigger than fog end distance. There's no reason to render stuff that can't be seen + anyways.
++ +zr_veffects_ragdoll_remove +1 ++ + ++ +Remove players' bodies when dying.
+Options:
+
+ 0 or 1+ +zr_veffects_ragdoll_dissolve +-1 ++ + ++ +Dissolve effect to use when removing bodies.
+Options:
++
++ -2 No effect + -1 Random effect + 0 Energy dissolve + 1 Heavy electrical dissolve + 2 Light electrical dissolve + 3 Core dissolve + +zr_veffects_ragdoll_delay +0.5 ++ + ++ +Time to wait before removing dead bodies. Time is in seconds.
++ +zr_napalm_ignite +1 ++ ++ +Ignite grenades that players throws. Humans need the class attribute "has_napalm" + set for this setting to be effective.
+Options:
+
+ 0 or 1
The sound effects make zombies groan, in addition to the ambience sound file that can be +played.
+ +Currently it doesn't support any other custom files than the ambience file. Other sounds are +pre-configured. Instead it's possible to specify how often the sounds should be played, if enabled.
+ +The lenght of the ambience file must be specified because SourceMod currently can't detect lenght +of MP3 files.
+ +Sound effect console variables:
+ ++ + ++
+ + +Console variable: +Default: ++ +zr_seffects_moan +30.0 ++ + ++ +Time between emission of a moan sound from a zombie. Time is in secons.
++ +zr_seffects_groan +5 ++ + ++ +The probability that a groan sound will be emitted from a zombie when shot. Probability + is in percent.
+Options:
+
+ 0 to 100+ +zr_seffects_death +1 ++ + ++ +Emit a death sound when a zombie dies.
+Options:
+
+ 0 or 1+ +zr_ambientsounds +1 ++ + ++ +Enable ambient sound (background sound) to all players during gameplay.
+Options:
+
+ 0 or 1+ +zr_ambientsounds_file +ambient/zr/zr_ambience.mp3 ++ + ++ +The ambient sound file to play as ambienece. Path is relative to the "sound" folder, + and MP3 files are supported. This sound is also looped so only use sounds that can be + looped. Otherwise it might sound wierd when it restarts.
++ +zr_ambientsounds_length +60.0 ++ + ++ +Length of the ambient sound. Length is in seconds. If the specified length is shorter + than the real sound length, the sound will play again before the previous sound + finished playing.
++ +zr_ambientsounds_volume +0.8 ++ ++ +Volume of ambient sound file. Volume is in percent.
+Options:
+
+ 0.0 to 1.0
Respawning makes players spawn into the game again after death. It keeps the game active and is +less annoying for people who don't like to wait too much.
+ +If the mother zombie haven't spawned yet, players are always spawned as humans.
+ +Respawn console variables:
+ ++ diff --git a/docs/zr_manual.txt b/docs/zr_manual.txt index a294c5d..8407b09 100644 --- a/docs/zr_manual.txt +++ b/docs/zr_manual.txt @@ -1281,7 +1281,7 @@ main configuration file, or on a per-map basis with map configuration files. 3.9 HIT GROUP CONFIGURATION ------------------------------ -A hit group configuration makes it possible to disable damage or adjust knock +Hit group configuration makes it possible to disable damage or adjust knock back per hit group. This is useful for fine tuning game balance. The hit group configuration file is a file in Valve's key/value format with @@ -1402,7 +1402,7 @@ These are the console variables for the infection module: zr_infect_sound "npc/fast_zombie/fz_scream1.wav" --------------------------------------------------------------------------- - Sound played when infected. The file path is relative to the "sounds" + Sound played when infected. The file path is relative to the "sound" folder. Leave blank ("") to disable infection sound. zr_infect_explosion 1 diff --git a/src/zr/cvars.inc b/src/zr/cvars.inc index 964e4c6..65df2fd 100644 --- a/src/zr/cvars.inc +++ b/src/zr/cvars.inc @@ -372,11 +372,11 @@ CvarsCreate() g_hCvarsList[CVAR_VEFFECTS_LIGHTSTYLE_VALUE] = CreateConVar("zr_veffects_lightstyle_value", "b", "Lightstyle value. ['a' = Darkest | 'z' = Brightest | Dependency: zr_veffects_lightstyle]"); // Sky - g_hCvarsList[CVAR_VEFFECTS_SKY] = CreateConVar("zr_veffects_sky", "1", "Change map skybox."); + g_hCvarsList[CVAR_VEFFECTS_SKY] = CreateConVar("zr_veffects_sky", "0", "Change map skybox."); g_hCvarsList[CVAR_VEFFECTS_SKY_PATH] = CreateConVar("zr_veffects_sky_path", "sky_borealis01up.vmt", "Skybox file, relative to \"materials/skybox\" folder, to change map skybox to. [Dependency: zr_veffects_sky]"); // Sun - g_hCvarsList[CVAR_VEFFECTS_SUN_DISABLE] = CreateConVar("zr_veffects_sun_disable", "1", "Disable sun rendering on map."); + g_hCvarsList[CVAR_VEFFECTS_SUN_DISABLE] = CreateConVar("zr_veffects_sun_disable", "0", "Disable sun rendering on map."); // Fog g_hCvarsList[CVAR_VEFFECTS_FOG] = CreateConVar("zr_veffects_fog", "0", "(UNSUPPORTED) Enable fog rendering on the map.");+
+ + +Console variable: +Default: ++ +zr_respawn +1 ++ + ++ +Enable respawning.
+Options:
+
+ 0.0 to 1.0+ +zr_respawn_delay +1.0 ++ + ++ +Time after death to respawn. Time is in seconds.
++ +zr_respawn_team_zombie +1 ++ + ++ +Respawn as zombie. If the mother zombie haven't spawned yet, players are always spawned + as humans.
+Options:
+
+ 0.0 to 1.0+ +zr_respawn_team_zombie_world +1 ++ + ++ +Respawn as zombie if the player was killed by world damage. If the mother zombie + haven't spawned yet, players are always spawned as humans.
+Options:
+
+ 0.0 to 1.0+ ++ + + ++ + +Options:
+
+ 0.0 to 1.0