Zombie:Reloaded User Manual
Targets plugin version 3.0.0 Beta 2, (not released)
@@ -217,7 +219,7 @@ plugin is compatible with all existing Zombie Mod maps.
Concept
-
-
c0ldfyr3
+c0ldfyr3
The developer of Zombie Mod (www.zombiemod.com).
Developers and testers
-
-
Greyscale
+Greyscale
Author of Zombie:Reloaded. The one who started remaking Zombie Mod for the SourceMod platform.
Related server: "#1 Pro's Playground - 24/7 Zombie Mod [ Rank / Reload / Napalm ]" (74.201.57.54:27015) - USA, Washington
-
- -
-
Richard Helgeby
+ + -
+
Richard Helgeby
Zombie:Reloaded developer. Started working on the plugin from version 2.5.1. Fixed bugs and made new features.
Related server: (same as Cpt. Moore)
-
- -
-
Cpt. Moore
+ + -
+
Cpt. Moore
Helped debuging issues and made some new features. Used the server for testing.
Related server: "Zombie World Domination by SwissQuake" (85.195.74.201:13010) - Switzerland, Basel
@@ -267,7 +269,7 @@ plugin is compatible with all existing Zombie Mod maps. SourceMod - A scripting platform:
-
@@ -298,10 +300,10 @@ If the plugin doesn't work at all or there are errors logged, see T
is optional or not.
Example syntax of a command:
-
+zr_class_modify <classname|"zombies"|"humans"|"admins"> <attribute> <value> [is_multiplier]
zr_class_modify <classname|"zombies"|"humans"|"admins"> <attribute> <value> [is_multiplier]
Some paths may look like:
-
+cfg/sourcemod/zombiereloaded/<mapname>.cfg
cfg/sourcemod/zombiereloaded/<mapname>.cfg
How to read syntaxes like this is explained below.
@@ -311,11 +313,11 @@ is optional or not. with brackets.Example:
-
+zr_somecommand [number]
zr_somecommand [number]
Usage examples:
-
+zr_somecommand
- zr_somecommand 10zr_somecommand
+ zr_somecommand 102. Required Parameters
@@ -326,12 +328,12 @@ 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>zr_somecommand <number>
+ zr_infect <target>Usage examples:
-
+zr_somecommand 100
- zr_infect "unnamed"zr_somecommand 100
+ zr_infect "unnamed"3. Multiple Options In The Same Parameter
@@ -340,12 +342,12 @@ 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">
zr_do_something <index|name|"all">
Usage examples:
-zr_do_something 1
+
+ zr_do_something "unnamed"zr_do_something 1
zr_do_something "all"
- zr_do_something "unnamed"4. Text As Parameters
@@ -353,11 +355,11 @@ separated by a "|" symbol. Only one of the options listed is used in a command.< do this on all string parameters to avoid parsing mistakes.Example:
-
+zr_infect "unnamed" "player"
- zr_do_something "example text. test."zr_infect "unnamed" "player"
+ zr_do_something "example text. test."Example of bad usage:
-
+zr_do_something example text. test.
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.
@@ -367,6 +369,7 @@ 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.
+
Default Configuration Files Type: File: @@ -431,9 +434,8 @@ zr_log_add_module is too late.There are console variables for different log settings and exceptions. Place them in the main configuration file.
-Console variables:
-
-+
Log Console variables Console variable: Default: @@ -516,9 +518,8 @@ configuration file.Console commands:
-+
Log Console commands Syntax: 1. Log Flags
+
Log Flags Flag: Bit No.: @@ -611,8 +613,8 @@ configuration file.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 + 2LOG_CORE_EVENTS + LOG_GAME_EVENTS
+ 1 + 2Most server setups donesn't need different flag settings. Default is fine.
@@ -622,8 +624,8 @@ 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 + 8LOG_CORE_EVENTS + LOG_GAME_EVENTS + LOG_DEBUG
+ 1 + 2 + 8Most operating systems or distributions have a calculator that can convert between binary and decimal numbers with scientific mode enabled. An online @@ -636,6 +638,7 @@ unit converter like below can also be used.
2. List Of Modules
+
List Of Modules Short name: Description: @@ -733,6 +736,7 @@ modules like classes. Post map configuration files are executed after the module stuff have to be placed in this one to be effective, like changing class attributes.+
Map Configuration File Types Type: Executed: @@ -755,7 +759,7 @@ stuff have to be placed in this one to be effective, like changing class attribu3.5 Model Configuration
-Note: Work in progress. Some flags explained in this section doesn't exist yet.
+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.
@@ -771,11 +775,10 @@ admins/donators, hidden from random selection or only for mother zombies. specified it's treated as a regular public model.Model line syntax:
-
- -<model path>[; flag]
Available flags:
+<model path>[; flag]
+
Model Flags adminonly Can only be used by admins. @@ -796,14 +799,14 @@ specified it's treated as a regular public model.Example usages:
-models/player/zh/zh_charple001
+
+ models/player/ics/hellknight_red/t_guerilla; motherzombiemodels/player/zh/zh_charple001
models/player/zh/zh_corpse002; adminonly
models/player/zh/zh_zombie003; hidden
- models/player/ics/hellknight_red/t_guerilla; motherzombiePut the list of models in:
-
+addons/sourcemod/configs/zr/models.txt
addons/sourcemod/configs/zr/models.txt
3.6 Download List
@@ -813,7 +816,7 @@ download them. The paths must be relative to the "cstrike" folder.List files to be downloaded in:
-
+addons/sourcemod/configs/zr/downloads.txt
addons/sourcemod/configs/zr/downloads.txt
3.7 Class Configuration
@@ -828,9 +831,9 @@ variable with per-map configuration files to have different sets of classes on oDefault path is:
-
+configs/zr/playerclasses.txt
-configs/zr/playerclasses.txt
Note: The path is relative to the "sourcemod" folder.
+Note: The path is relative to the "sourcemod" folder.
The file contains a short description of all attributes. Details are explained below.
@@ -848,6 +851,7 @@ the admin-only flag in the flags attribute.The list below explains all available class attributes in detail:
+
Class Attributes Attribute: Value type: @@ -883,7 +887,7 @@ the admin-only flag in the flags attribute.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 + 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.
@@ -1076,7 +1080,7 @@ the admin-only flag in the flags attribute.- Human classes only. Specifies whether the human can trow napalm grenades or +
Human classes only. Specifies whether the human can trow napalm grenades or not.
- @@ -1101,7 +1105,7 @@ the admin-only flag in the flags attribute.Zombie classes only. Specifies how long in seconds zombies will burn when hit by +
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.
- Note: Incomplete feature!
+Note: Incomplete feature!
The immunity mode. This feature is currently incomplete and values are ignored.
- @@ -1160,7 +1164,7 @@ the admin-only flag in the flags attribute.Note: Incomplete feature!
+Note: Incomplete feature!
The value for the specified immunity mode. This feature is currently incomplete and values are ignored.
- Zombie classes only. How many health points to give the zombie each time it +
Zombie classes only. How many health points to give the zombie each time it infect a human.
- Zombie classes only. How many extra points to give the killer of this zombie. +
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.
- Zombie classes only. Force to apply on the zombie when shot at. The zombie is +
Zombie classes only. Force to apply on the zombie when shot at. The zombie is pushed in the same direction as the bullet.
At least one zombie class and one human class with no special flags set is required. Otherwise the plugin will fail to load.
-Requirements:
+Requirements:
- At least one human class (teamid 1). @@ -1249,9 +1253,8 @@ have invalid values. index and the error flags (bit field) in the log message tells what attributes that failed to validate. -
- generic
- head
- chest @@ -2249,6 +2256,7 @@ This is useful for fine tuning game balance.
Attribute flags:
-+
Attribute Flags Attribute: Bit: @@ -1411,20 +1414,19 @@ didn't validate.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
cfg/sourcemod/zombiereloaded/zombiereloaded.cfg
And/or in a map config file:
-
+cfg/sourcemod/zombiereloaded/<map name>[.post].cfg
cfg/sourcemod/zombiereloaded/<map name>[.post].cfg
Example map config files:
-
- -cfg/sourcemod/zombiereloaded/zm_panic.cfg
- cfg/sourcemod/zombiereloaded/zm_panic.post.cfgClass console variables:
+cfg/sourcemod/zombiereloaded/zm_panic.cfg
+ cfg/sourcemod/zombiereloaded/zm_panic.post.cfg+
Class Console Variables Console variable: Default: @@ -1565,7 +1567,7 @@ Place these console variables in the main configuration file:- Note: This feature is incomplete!
+Note: This feature is incomplete!
Default admin-mode class selected for all players when they connect, if found. This feature is incomplete and ignored.
Do not confuse this with admin-only classes. Admin-mode is a special spawn mode for @@ -1614,7 +1616,7 @@ Place these console variables in the main configuration file:
- Note:This feature is incomplete!
+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.
@@ -1635,12 +1637,11 @@ original class cache is multiplied with the specified value and written back toWhen 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.
-Note:These commands must be used in a post map config files, +
Note:These commands must be used in a post map config files, otherwise they won't have any effect because class data isn't loaded yet.
-Console commands:
-+
Modifying Class Command Syntax: 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 +
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:
+
Attribute Multiplier Command Syntax: +
Reload Attributes Command Syntax: For debug purposes class attributes also can be dumped.
+
Dump Attributes Command Syntax: +
Dump Multipliers Command Syntax: Weapon attributes are stored by default in:
-
+addons/sourcemod/configs/zr/weapons.txt
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.
@@ -1844,6 +1849,7 @@ map configuration files it must be in a pre configuration file.These are the allowed attributes:
+
Weapon Attributes Attribute: Type: @@ -2001,6 +2007,7 @@ sub section for each weapon using short names from the list below.2. Weapon List
+
Weapon List Weapon name: Type: @@ -2155,6 +2162,7 @@ sub section for each weapon using short names from the list below. file, or on a per-map basis with map configuration files.+
Weapon Commands Syntax: The default file is:
-
- -addons/sourcemod/configs/zr/hitgroups.txt
Console commands:
+addons/sourcemod/configs/zr/hitgroups.txt
+
Hit Group Commands Syntax: hitgrup name Name of the hit group to adjust. Options: - -
+
1. Hit Group Attributes
+
Hit Group Attributes Attribute: Type: @@ -2320,6 +2328,7 @@ tune game balance.These are the console variables for the infection module:
-+
Infection Console Variables Console variable: Default: @@ -2515,9 +2524,8 @@ tune game balance.Console commands:
-+
Infect Commands Syntax: 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:
-+
Damage Control Console Variables Console variable: Default: @@ -2653,8 +2660,8 @@ group damage. See Hit Group Configuration (3.9) on how to con3.12 Overlay Settings
-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.
+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.
@@ -2664,9 +2671,8 @@ team.Overlays are also used as a class attribute, like the zombie vision effect.
-These are the overlay console variables:
-