Zombie:Reloaded User Manual

Targets plugin version 3.0.0 Beta 2, (not released)
Written by Richard Helgeby

Manual last modified: 2009.10.10

Index

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.

The objectives is to change the game into humans versus zombies. Humans try to survive by camping, barricading and hiding. Zombies try to zombify humans by using their knife.

At a random time after the round starts, one or more random humans are turned into zombies. Zombies have certain advantages as running faster and more health points. Humans have huge amounts 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.

Concept

Zombie: Reloaded requires that the following stuff is installed on the server:

Extract the content of the zip file into "cstrike/" on the server.

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.

In 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 is optional or not.

Example syntax of a command:

zr_class_modify <classname|"zombies"|"humans"|"admins"> <attribute> <value> [is_multiplier]

Some paths may look like:

cfg/sourcemod/zombiereloaded/<mapname>.cfg

How to read syntaxes like this is explained below.

Optional parameters is not required and usually have a default value or action. They are marked with brackets.

Example:

zr_somecommand [number]

Usage examples:

zr_somecommand
zr_somecommand 10

Required parameters must be specified for the command to function. Usually if no parameters are written the command replies with some info about the syntax.

Less than (<) and greather than (>) symbols marks required parameters.

Examples:

zr_somecommand <number>
zr_infect <target>

Usage examples:

zr_somecommand 100
zr_infect "unnamed"

Some commands have parameters that support multiple pre defined options. Usually it's specifying a name, a index or a predefined value. Each option is separated by a "|" symbol. Only one of the options listed is used in a command.

Example:

zr_do_something <index|name|"all">

Usage examples:

zr_do_something 1
zr_do_something "all"
zr_do_something "unnamed"

Since parameters are separated by spaces, text (strings) should be quoted. It's a good habit to do this on all string parameters to avoid parsing mistakes.

Example:

zr_infect "unnamed" "player"
zr_do_something "example text. test."

Example of bad usage:

zr_do_something example text. test.

The last example actually have 3 parameters while it should be only one. This may cause unexpected 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.

Type:	File:
Main conf.	cfg/sourcemod/zombiereloaded/zombiereloaded.cfg
Map conf.	cfg/sourcemod/zombiereloaded/<mapname>.cfg
Post map conf.	cfg/sourcemod/zombiereloaded/<mapname>.post.cfg
Hitgroup conf.	addons/sourcemod/configs/zr/hitgroups.txt
Class conf.	addons/sourcemod/configs/zr/playerclasses.txt
Weapon conf.	addons/sourcemod/configs/zr/weapons.txt
Download list	addons/sourcemod/configs/zr/downloads.txt
Model list	addons/sourcemod/configs/zr/models.txt

The post map configuration file is executed after all features of ZR is done loading. Commands that modify loaded data must be put in post configuration files. How to configure each file is explained in their own sections.

The log system used in Zombie:Reloaded is pretty powerful and customizable. It's based on logging flags and a module filter.

Flag:	Bit No.:	Value:	Description:
LOG_CORE_EVENTS	1	1	Log events from the plugin core like config validation and other messages.
LOG_GAME_EVENTS	2	2	Log admin commands, console commands, and game related events from modules like, suicide attempts and weapon restrictions.
LOG_PLAYER_COMMANDS	3	4	Log events that are triggered by players, like chat triggers, teleporting and class changes.
LOG_DEBUG	4	8	Log debug messages, if any. Usually only developers need to enable this log flag.
LOG_DEBUG_DETAIL	5	16	Log additional debug messages with more details. May cause spam depending on module filter settings. Usually only developers need to enable this log flag.

To combine several logging flags use the sum of their values. A combination could be "3", which is these log flags:

LOG_CORE_EVENTS + LOG_GAME_EVENTS
1 + 2

Most server setups donesn't need different flag settings. Default is fine.

To decode the value you must convert it from decimals to binary, and count from right to left what bits that are 1. Look up the bit number (not value) in the table above.

As an example on using the number 11 it's 1011 in binary. Counting from right we see that the following bit numbers are on: 1, 2, and 4. That is the flags:

LOG_CORE_EVENTS + LOG_GAME_EVENTS + LOG_DEBUG
1 + 2 + 8

Most operating systems or distributions have a calculator that can convert between binary and decimal numbers with scientific mode enabled. An online unit converter like below can also be used.

Short name:	Description:
account	Money manager
antistick	Anti-Stick feature
config	Configuration file manager
cvars	Console variables
damage	Damage manager
downloads	File download manager
hitgroups	Hit group feature
infect	Infection manager
models	Model list file manager
playerclasses	Class manager
veffects	Visual effect manager
seffects	Sound effect manager
tools	Helper functions (offsets)
volfeatures	Volumetric features
weapons	Weapon manager
weaponrestrict	Weapon restriction manager
zspawn	Spawn command manager
ztele	Teleport manager

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 configuration files and can also have standard console commands like setting map time. These files are optional.

The main purpose of these files is to make it possible to change settings for Zombie:Reloaded on certain maps. That could be scaling knockback, restricting certain weapons, changing class 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.

Type:	Executed:	Path:
Pre	Before modules	cfg/sourcemod/zombiereloaded/<mapname>.cfg
Post	After modules	cfg/sourcemod/zombiereloaded/<mapname>.post.cfg

If not explicit specified in the module documentation, use pre configuration.

Note: Work in progress. Some flags explained in this section doesn't exist yet.

The model configuration file is a list of models used on the server. Each line contains the path including the model name, but not the file extension.

The models listed in this file are also precached when the server starts. Custom models used, but not listed in this file will cause a "model not precached" error on the server, so remember to list them in this file.

In addition certain flags can be added to mark the model as special, such as only for admins/donators, hidden from random selection or only for mother zombies.

Each line is separated into two fields with ";". The last field is optional and if no flag is specified it's treated as a regular public model.

Model line syntax:

<model path>[; flag]

Available flags:

adminonly	Can only be used by admins.
donator	Can only be used by donators.
hidden	Is not included in random selections.
motherzombie	Can only be used on mother zombies.

Example usages:

models/player/zh/zh_charple001
models/player/zh/zh_corpse002; adminonly
models/player/zh/zh_zombie003; hidden
models/player/ics/hellknight_red/t_guerilla; motherzombie

Put the list of models in:

addons/sourcemod/configs/zr/models.txt

Custom models, materials and overlays must be listed in the download list so clients will download them. The paths must be relative to the "cstrike" folder.

List files to be downloaded in:

addons/sourcemod/configs/zr/downloads.txt

The class system makes it possible to have different zombies and humans with customized skills. It cannot be turned off, but class selection options can be disabled. If there is only one class in each team, the class selections menus are automatically disabled.

The class configurations are stored in Valve's key/value format, and the file that's loaded should be specified in the "zr_classes_file" console variable. It's possible to change this variable with per-map configuration files to have different sets of classes on one or more maps.

Default path is:

configs/zr/playerclasses.txt

Note: The path is relative to the "sourcemod" folder.

The file contains a short description of all attributes. Details are explained below.

There are three class types; zombies, humans and admin-mode. Default classes are selected on the player depending on console variables and the class file.

Admin-mode classes are currently incomplete and will be validated, but ignored in the game. This is a special mode in the game, but not the same as admin-only classes. To get admin-only classes set the admin-only flag in the "flags" attribute.

The list below explains all available class attributes in detail:

Attribute:	Value type:	Limits/Requirements:
enabled	text	"yes" or "no"
Enables or disables the class. Disabled classes won't show up in the class selection menus. Also, if some attributes failed to validate the class will be disabled.
team	number	0 - 2
Specifies the class type (team ID). Class types are filtered in the class selection menus, so only zombies can use zombie class types, and only humans can use human class types. These are the allowed team IDs: 0 Zombie classes 1 Human classes 2 Admin-mode classes The admin-mode class type sets the player in spectacting like mode, but allow admins to walk around. They can't take or give damage, and they won't affect the game rules in any way. Admin-mode is incomplete and classes of this type is ignored in the game. See the "flags" attribute for admin-only classes.
team_default	text	"yes" or "no"
Marks the class as the default class for its specified team. This class will be automatically selected on new players when they join the server, depending on what's specified as default in the main configuration file (zr_classes_default_*). If multiple classes in the same team is marked as default the first class marked as default will be used.
flags	number	0 - 3
Special class flags that are stored in a bit field (explained in Log Flags (3.3.1)). Available flags: 1 Admins only Marks the class to be used by admins only. Classes with this option on will not be visible for regular players in the class menu. 2 Mother zombie. Marks the class as a mother zombie class. These classes will be used on mother zombies. Note that zr_classes_default_mother_zombie setting must be set to "motherzombies" for this flag to take effect. These flags can be used in a combination (1 + 2), so it could be a mother zombie class for admins only.
group	text	Name of a valid SourceMod group
Rescrict class to members of this SourceMod group. Useful for making VIP-only classes. Leave blank to allow everyone to use this class.
name	text	Unique, not empty, max 64 charact.
A unique name for the class that is displayed in the class selection menus. Cannot be empty. If multiple classes have the same name, the first one found is used. This name is also refered to by cvars that set default classes.
description	text	Max 256 characters, not empty
The description of the class, used in class selection menus. Cannot be empty.
model_path	text	Max 256 characters, not empty
The model file to use on the player, path is relative to the "cstrike" folder. There are a few special values supported by this attribute: default Use default CS models. The one players select when selecting team. random Selects a random model for the current team. nochange Don't change model. To be used in combination with other plugins that change model on players.
alpha_spawn	number	0 - 255
The initial transparency value on the player, where 255 is fully visible and 0 is invisible.
alpha_damaged	number	0 - 255
Transparency on the player when a certain amount of damage is done. 255 is fully visible and 0 is invisible.
alpha_damage	number	0 - 20000
How much damage that needs to be done before the players alpha changes from "aplha_spawn" to "aplha_damaged".
overlay_path	text	Max 256 characters
Optional. Overlay texture to be displayed at the player. It can be controlled by the night vision key ("n" by default). The path is relative to "cstrike/materials". Leave blank to disable.
nvgs	text	"yes" or "no"
Gives night vision to the player.
fov	number	15 - 165
The field of view on the player. Note that the weapon hud disappear if FOV is anything else than 90.
has_napalm	text	"yes" or "no"
Human classes only. Specifies whether the human can trow napalm grenades or not.
napalm_time	decimal	0.0 - 600.0
Zombie classes only. Specifies how long in seconds zombies will burn when hit by napalm grenades. 0.0 or a negative value will disable this feature on the current class. This attribute has no effect on human classes.
immunity_mode	number	0 - 2
Note: Incomplete feature! The immunity mode. This feature is currently incomplete and values are ignored.
immunity_amount	decimal	(incomplete)
Note: Incomplete feature! The value for the specified immunity mode. This feature is currently incomplete and values are ignored.
health	number	0 - 20000
Initial health points on the player.
health_regen_interval	decimal	0.0 - 900.0
The health regeneration interval, in seconds. Use 0.0 to disable regeneration.
health_regen_amount	number	0 - 10000
How many health points to give per interval. Regeneration stops when the players health is above the initial health.
health_infect_gain	number	0 - 20000
Zombie classes only. How many health points to give the zombie each time it infect a human.
kill_bonus	number	0 - 16
Zombie classes only. How many extra points to give the killer of this zombie. If this is 0, the default value of 1 point will be given.
speed	decimal	10.0 - 2000.0
The player's running speed.
knockback	decimal	-30.0 - 30.0
Zombie classes only. Force to apply on the zombie when shot at. The zombie is pushed in the same direction as the bullet.
jump_height	decimal	0.0 - 5.0
Jump height multiplier. Extra upward boost when jumping. If 1.0 or 0.0 no boost will be applied.
jump_distance	decimal	0.0 - 5.0
Jump distance multiplier. Extra forward boost when jumping. If 1.0 or 0.0 no boost will be applied.

At least one zombie class and one human class with no special flags set is required. Otherwise the plugin will fail to load.

Requirements:

There are several console variables to set default class settings for players. Place these console variables in the main configuration file:

cfg/sourcemod/zombiereloaded/zombiereloaded.cfg

And/or in a map config file:

cfg/sourcemod/zombiereloaded/<map name>[.post].cfg

Example map config files:

cfg/sourcemod/zombiereloaded/zm_panic.cfg
cfg/sourcemod/zombiereloaded/zm_panic.post.cfg

Class console variables:

Console variable:	Default:
zr_config_path_playerclasses	"configs/zr/playerclasses.txt"
Specifies what class configuration file to load. Several class templates can be used with map configurations. Path is relative to "sourcemod". If used in map configuration files this console variable must be placed in pre map configuration files. Post configuration files won't have any effect because the class module is done loading.
zr_classes_spawn	0
Re-display class menu every spawn. Options: 0 or 1
zr_classes_random	0
Assign random classes to all players each round. This setting overrides zr_classes_save. Options: 0 or 1
zr_classes_change_timelimit	20
The time limit to change human classes with instant change after spawning. So humans don't have to set class before spawning. Time is in seconds.
zr_classes_save	1
Save players' class selections in server cookies. Class selections are restored next time players connect. This setting overrides zr_classes_default_*, but on first-time connecting players the default classes are assigned. This setting also override zr_classes_*_select. If players have saved class indexes in cookies they will be restored. Options: 0 or 1
zr_classes_default_zombie	"random"
Default zombie class selected for all players when they connect. Options: <class name> Specify a class name to use as default zombie. "default" Use the default class in the class configuration. "random" Select a random zombie class from the class configuration.
zr_classes_default_mother_zombie	"motherzombies"
Default mother zombie class to be set on mother zombies. If no mother zombie class exist it will use the class selected by the player. Options: <class name> Specify a class name to use as default mother zombie. "random" Select a random regular zombie class. "motherzombies" Select a random zombie class with mother zombie flag. "disabled" No change. Use the zombie class selected by the player.
zr_classes_default_human	"random"
Default human class selected for all players when they connect. Options: <class name> Specify a class name to use as default human. "default" Use the default class in the class configuration. "random" Select a random human class from the class configuration.
zr_classes_default_admin	"random"
Note: This feature is incomplete! Default admin-mode class selected for all players when they connect, if found. This feature is incomplete and ignored. Options: <class name> Specify a class name to use as default admin-mode class. "default" Use the default class in the class configuration. "random" Select a random admin-mode class from the class configuration.
zr_classes_zombie_select	1
Allow players to select zombie classes. Disable this option to force certain classes on players depending on what zr_classes_default_zombie is set to. Options: 0 or 1
zr_classes_human_select	1
Allow players to select human classes. Disable this option to force certain classes on players depending on what zr_classes_default_human is set to. Options: 0 or 1
zr_classes_admin_select	1
Note:This feature is incomplete! Allow admins to select admin classes. Disable this option to force certain classes on admins depending on what zr_classes_default_admin is set to, - and if admin mode is enabled on the player. Options: 0 or 1

Classes can be modified after they're loaded. This is useful in map configs to do stuff like scaling knockback to tune map balance.

All attributes can be modified, and some can also be scaled with a multiplier. The value in the original class cache is multiplied with the specified value and written back to the modified cache.

When multiplying, the value is always based on the original value, not multiplying the earlier multiplied value. This also makes it easy to restore the original value.

Console commands:

Syntax:
zr_class_modify <class|team> <attribute> <value> [is_multiplier]
Modify settings on one or more classes. Parameters: class|team The class to modify. Can be any valid class name, or one of the following team names: "all", "humans", "zombies" or "admins". attribute The name of the class attribute to modify. value Value to set, or multiplier if a multiplier. is_multiplier Optional. Specifies wether the original value should be multiplied by the specified value. Default is false.

Making a balanced zombie map is difficult, and all maps have different balance. The knock back and other settings may work fine on one map, but not on other maps. This is where multipliers are useful.

With class attribute multipliers, numeric class attributes can be scaled and configured with map configuration files. There's a set of multipliers for both humans and zombies.

Warning: Currently these multipliers aren't validated, so using too high or negative values may cause unexpected behaviour, or even crash the plugin.

Attribute multipliers are set using this console command:

Syntax:
zr_class_set_multiplier <team> <attribute> <value>
Sets the multiplier on a class attribute. Parameters: team What multiplier set to use. Options: "zombies" or "humans" attribute A numeric class attribute. See Class Attributes (3.7.2) for details on attributes. Valid attribute multipliers: "napalm_time" (zombies only) "health" "health_regen_interval" "health_regen_amount" "health_infect_gain" (zombies only) "speed" "knockback" (zombies only) "jump_height" "jump_distance" value Value to set, or multiplier if a multiplier.

Multipliers can also be adjusted in the zombie admin menu, but the changes aren't saved. The menu is useful for finding the correct value, and then use it in a map configuration file.

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.

Syntax:
zr_class_reload <target>
Refreshes the player cache and reloads class attributes on one or more players. Parameters: target Target player(s) to refresh cache on. A name or a SourceMod target specifier.

For debug purposes class attributes also can be dumped.

Syntax:
zr_class_dump <cachetype> <index|targetname>
Dumps class data at a specified index in the specified cache. Parameters: cachetype Cache to read from. Cache types: "original" Unmodified raw class data. "modified" Modified class data with multipliers. "player" Player cache, with multipliers. index|targetname Class index, or name of player if "player" cache type is used.

Dumping multipliers is another command for debug purposes. It will dump the current state of multipliers.

Syntax:
zr_class_dump_multipliers <team>
Dumps class attribute multipliers for the specified team. Parameters: team The multiplier set to dump. Valid options are: "humans" or "zombies"

The weapon module can be used to restict weapons or scale knockback.

Weapon attributes are stored by default in:

addons/sourcemod/configs/zr/weapons.txt

Custom file may be specified in the console variable "zr_config_path_weapons". If used in per map configuration files it must be in a pre configuration file.

These are the allowed attributes:

Attribute:	Type:	Limits/Requirements:
weapontype	text	Separate items by ", "
A list of weapon groups and the weapon type. Pre-defined options: All Pistol Shotgun SMG Rifle Sniper Machine Gun Melee Projectile Equipment
weaponslot	number	0 - 3
The slot index the weapon resides in. Don't change this! Options: 0 Primary weapon slot 1 Secondary weapon slot 2 Knife slot 3 Equipment slot
restrictdefault	text	"yes" or "no"
The default restricted status of the weapon on map start. Options: "yes" Enable "no" Disable
toggleable	text	"yes" or "no"
Enable weapon to have restrictions toggled mid-game. Options: "yes" Enable "no" Disable
ammotype	text	-
Ammo entity that belongs to weapons. Don't change this! Options: ammo_50ae deagle ammo_762mm scout, ak47, g3sg1, aug ammo_556mm_box m249 ammo_556mm galil, sg552, famas, m4a1, sg550 ammo_338mag awp ammo_9mm mp5navy, tmp, glock, elite ammo_buckshot m3, xm1014 ammo_45acp ump45, mac10, usp ammo_357sig P228 ammo_57mm p90, fiveseven
ammoprice	number	-
Price of ammo for this weapon.
knockback	decimal	-
The knock back multiplier for the weapon. 1.0 is no change, "0.5" give half knock back, and 2.0 gives double knock back.
zmarketprice	number	-
The price of the weapon in ZMarket. Default in configuration file is CS:S buymenu price.
zmarketpurchasemax	number	-
The max number of purchases allowed per spawn for the weapon.

The file structure is Valve's key/value format where the root section is named "weapons" and a sub section for each weapon using short names from the list below.

Weapon name:	Type:	Full name:
Glock	Pistol	Glock 18 Select Fire (9X19mm Sidearm)
USP	Pistol	.45 USP (K&M .45 Tactical)
P228	Pistol	228 Compact
Deagle	Pistol	Desert Eagle .50C (Night Hawk .50C)
Elite	Pistol	.40 Dual Elites
Fiveseven	Pistol	ES Five-Seven
M3	Shotgun	Benelli M3 (Leone 12 Gauge Super)
XM1014	Shotgun	Benelli XM1014 (Leone YG1265 Auto Shotgun)
Mac10	SMG	Ingram MAC-10
TMP	SMG	Steyr TMP (Schmidt Machine Pistol)
MP5Navy	SMG	HK MP5 Navy (KM Sub-Machine Gun)
UMP45	SMG	K&M UMP45
P90	SMG	FN P90 (ES C90)
Galil	Rifle	IMI Galil (IDF Defender)
Famas	Rifle	Giat FAMAS (Clarion 5.56)
AK47	Rifle	AK-47 (CV-47)
M4A1	Rifle	M4A1 Carbine (Maverick M4A1 Carbine)
SG552	Rifle	SIG SG552 (Krieg 552 Commando)
AUG	Rifle	Steyr AUG (Bullpup)
M249	Machine gun	FN M249 (ES M249 Para)
Scout	Sniper	Steyr Scout (Schmidt Scout)
SG550	Sniper	SIG SG550 (Krieg 550 Commando)
G3SG1	Sniper	G3/SG-1 (D3/AU-1)
AWP	Sniper	Arctic Warfare Magnum (Magnum Sniper Rifle)
hegrenade	Grenade	High explosive grenade
flashbang	Grenade	Flash bang
smokegrenade	Grenade	Smoke grenade
NVGs	Equipment	Night vision goggles

Available commands for managing weapon restrictions. These can be used in the main configuration file, or on a per-map basis with map configuration files.

Syntax:
zr_restrict <weapon|weapon type> [weapon|weapontype] ...
Restricts one or more weapons or weapon types (group). Parameters: weapon The weapon name. weapon type The weapon type group.
zr_unrestrict <weapon|weapon type> [weapon|weapontype] ...
Unrestricts one or more weapons or weapon types (group). Parameters: weapon The weapon name. weapon type The weapon type group.
zmarket
Displays the ZMarket weapon menu.