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

  1. Introduction
    1. About The Plugin
    2. Game Objectives
    3. Credits
  2. Installation
    1. Requirements
    2. Plugin Installation
    3. Test Run
  3. Configuration
    1. Understanding syntax
      1. Optional Parameters
      2. Required Parameters
      3. Multiple Options In The Same Parameter
      4. Text As Parameters
    2. Configuration Files
    3. Logging
      1. Log Flags
      2. List Of Modules
    4. Custom Map Configuration Files
      1. Types
    5. Model List
    6. Download List
    7. Class Configuration
      1. Class Types
      2. Class Attributes
      3. Class Requirements
      4. Class Console Variables
      5. Modifying Class Attributes
      6. Attribute Multipliers
      7. Reloading Attributes
      8. Dumping Attributes
      9. Dumping Multipliers
    8. Weapon Configuration
      1. Attributes
      2. Weapon List
      3. Console Commands
    9. Hit Group Configuration
    10. Infection Module
    11. Damage Control Settings
    12. Overlay Settings
    13. Money Settings
    14. Visual Effects Configuration
    15. Sound Effects Configuration
    16. Respawn Configuration
    17. Spawn Command Configuration
    18. Spawn Protect Configuration
    19. Teleport Configuration
    20. HP Display Settings
    21. Jump Boost Settings
    22. Anti-Stick Configuration
    23. Volumetric Feature Configuration
      1. volume Attributes
      2. Feature Attributes
      3. Anti-Camp Feature
  4. How To Play
    1. Game Rules
    2. Chat Commands
    3. Using The Menus
    4. Teamwork
    5. Playing As Human
      1. Finding A Place To Hide
      2. Making Barricades
      3. Playing Fair
    6. Playing As Zombie
      1. Chasing Humans
      2. Avoiding Knock back
      3. Taking Advantage Of Class Skills
    7. Physics Stuff
      1. Glitching Trough Walls
      2. Jumping Through Non-Solid Props
      3. Jumping Fast In Small Areas
  5. Troubleshooting
    1. Verifying Requirements
    2. Startup
    3. Error and Warning Messages
    4. Common Problems
  6. Gameplay Guidelines
    1. Briefing - Map Configuration Files
    2. Map Balance
    3. Knock Back Settings
    4. Map Time
    5. Servers With Unlimited Ammo and No Reloading
  7. Reporting Bugs and Improvements

1. Introduction

1.1 About The Plugin

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.

1.2 Game Objectives

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.

1.3 Credits

Concept
Developers and testers
Additional testers and contributors

2. Installation

1. Requirements

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

  1. Metamod:Source - A simplified API for server plugins. It makes it easier for developers to make plugins like SourceMod:

  2. SourceMod - A scripting platform:

  3. ZRTools extension (bundled). Provides some extra functions needed by Zombie:Reloaded. See Plugin Installation (2.2).

2. Plugin Installation

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.

3. Test Run

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.

Next check error logs from SourceMod and look if there are any entries from "zombiereloaded.smx". If the plugin doesn't work at all or there are error logs, see Troubleshooting at section 5.0.

3. Configuration

1. Understanding Syntax

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.

1. Optional Parameters

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

2. Required Parameters

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"

3. Multiple Options In The Same Parameter

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"

4. Text As Parameters

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.

2. Configuration Files

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.

3. Logging

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

The flags tell what kind of events to log. Those flags are stored as a numeric value in a bit field where each bit tell wether to log a certain event or not. See Bit field for technical details.

The module filter is a list of modules to enable log events from. This filter gives extra control of what stuff to log. Use console commands below in the main configuration file to add or remove modules to the filter.

These commands might not work properly until bug 3828 in SourceMod is fixed. It's a bug where console commands in plugin configuration files are executed late so a command like 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:

Console variable: Default:
zr_log "1"

Enable logging of events in the plugin. Fatal errors or errors are independendt on this setting and always logged.

Options:
0 or 1
zr_log_flags "3"

A bit field that specify what event types to log.

Options:
Number - See Log Flags (3.3.1)
zr_log_module_filter "0"

Enable module filtering. Only log events from listed modules will be logged. Use console commands below to add or remove modules from the filter.

Options:
0 or 1
zr_log_ignore_console "1"

Don't log events triggered by console that are executed by the console itself, like commands in configs. Enable this command to avoid spamming logs with events like weapon restrictions.

Options:
0 or 1
zr_log_print_admins "0"

Print log events to admin chat in addition to the log file.

Options:
0 or 1
zr_log_print_chat "0"

Print log events to public chat in addition to the log file.

Options:
0 or 1

Console commands:

Syntax:
zr_log_add_module <module> [modules...]

Adds one or more modules to the module filter. Use short module names, see List Of Modules (3.3.2).

Parameters:

moduleName of the module to add.
modulesAdditional modules to add.
zr_log_remove_module <module> [modules...]

Removes one or more modules from the module filter. Use short module names, see List Of Modules (3.3.2).

Parameters:

moduleName of the module to remove.
modulesAdditional modules to remove.
zr_log_list

Lists current log flag settings and module filtering settings.

Parameters: