www.zombiehorde.com - ZHPLUGIN README

WWW.ZOMBIEHORDE.COM
-[zhplugin]- v0.2.4, cjd
13/9/05

                - Changelog
                - Introduction to the plugin
                - Background
                - Requirements
                - Recommended
                - Update
                - Installation
                - Cvars/Commands
                - License
                - Acknowledgements

[changelog]

0.2.4

* recompiled models with correct bonemerge qc directives

* fixed problem with default zombie models not being set

* added auto download so .res files are no longer needed

* a few more optimisations

* many bugfixes

0.2.3 (internal build)

* bloodvision hell

0.2.2

* new client var query (see below)

* new hint for zombie players

* zombie character choice menu

* zombie health maximum is now 9999

* zh_buymenu no longer shows for dead players

0.2.1 (leaked beta)

* more internal code rewriting

* many more optimisations - far less cpu intensive

0.1.8 (internal build)

* health no longer uses direct memory modification

0.1.7 (leaked beta)

* major internal code rewrite

* fixed crash bugs!

* some speed optimisations

0.1.5

* recompiled models for latest version of CS:S as at 13/7/05

* added new zombie 'corpse' - with some special abilities

* added one extra human player model

* fixed timers to be server rate independent

* fixed bug where zombie player could use guns

* added zombie regeneration - see vars below

* changed zh_zomhealth to be the max level, not the increment

* fixed zh enable/disable and checked other vars as described below

* reduced head hitbox size

* fixed admin menus disappearing

0.1.4

* unreleased patch to temporarily repair model animations

0.1.3a

* Woke up from my stupor and realised I had left out the .res files :P

0.1.3

* First Public Release

- Back to the top

[intro]

Thanks for trying out zhplugin - the Zombie Horde CS:S server plugin. This plugin performs the following functions:

* replaces Terrorist models with HL2 zombie model.

* ensures that players on T team (zombies) can only use knife.

* implements a headshot only style type of zombie super power.

* plays a few subtle zombie sounds.

* provides CT's with a model selection menu upon spawn.

* provides Zombie's with a model selection menu upon spawn.

Please report any problems on the Plugin forum at www.zombiehorde.com.

                - Back to the top

[background]

Zombie Horde is a server side modification for Counter-Strike Source. It is a game of kill or be killed, occassional bomb work and appalling cruelty to hosties.

The game may be played on normal or custom maps, and there are no requirements for users to pre-install any files. The server plugin that implements the modification is called zhplugin and may be run on either Windows or Linux Source Dedicated Servers. In the suggested configuration, the game is run as a 32 player server with 18 bots playing as zombies, which happen to be the Terrorist (T) team. Since most maps have 20 spawn points, this allows for two real players to join the zombie team and 'lead' the horde, using radio commands as provided by the womderful Turtle Rock Studios. The bots are configured to use knife only and the server plugin forces all real zombie players to use knife only as well. As they spawn, all of the zombie (T) team members are given a nice health boost (the default is a boost to 400hp). The zombies may then only be hurt with direct headshots, in true zombie style. The zombies also look like zombies and emit various grunts and groans when being hit or killed. When a player joins the human team (the Counter Terrorists or CT's) he or she is presented with a model select menu. This allows people to choose their appearance on the server. The will be many more models to choose from in the future. Zombie Horde is a very fun game to play, and the objective is to keep it that way whilst adding more features and immersing the players in a darker and darker world. The philosophy of this version of Zombie Horde is that it is a server-side modification that will bend CS:S as far as it can server side, whilst creating a unique and fun online multiplayer experience. The intended audience of this modification are those players who may have grown a little tired after 5 years of playing vanilla CS and want that nice twist. A nice side effect of this game is that it also provides great headshot practice :)

                - Back to the top

[requirements]

* Working Source Dedicated Server installation - Counter Strike Source ONLY.

* Basic knowledge of server administration.

* You MUST allow clients to download files from either your game server or your content host!! Open your server.cfg file and ensure that the following is set correctly:

              sv_allowdownload 1

If you don't do this, everyone will see large red flashing error signs instead of zombies!!!

                - Back to the top

[recommended]

* Mani Admin Plugin (http://www.mani-admin-plugin.com/) is highly recommended!

* If using the '18 bot' cfg settings below, remove 16 player maps from your mapcycle.txt - i.e. cs_compound

* Run the server as 32 player with 18 bots and 14 player slots. Allow up to two players to play as zombie. add/replace the following in your server.cfg

exec zhplugin.cfg // exec the default cfg file for zh phys_pushscale 10 // make it more difficult for players to block doorways bot_chatter minimal // make bots stfu bot_defer_to_human 1 // make bots less likely to plant bomb bot_difficulty 3 // zombies should be hard bot_join_after_player 0 // bots need to join before players so there is the correct # bot_prefix "-[zombie]- " bot_quota 18 // for 32 player server, for 16 player server make this 10, for 20 make it 12 - this is a good working ratio bot_quota_mode normal // fix bot number bot_auto_vacate 0 // bots are permanent - they wont leave bot_auto_follow 1 // we like mindless zombies bot_allow_rogues 0 // we like mindless zombies bot_eco_limit 0 bot_all_weapons // all the stuff below just works - there are other ways of doing this, but this should be fine bot_allow_grenades 0 bot_allow_machine_guns 0 bot_allow_pistols 0 bot_allow_rifles 0 bot_allow_shotguns 0 bot_allow_snipers 0 bot_allow_sub_machine_guns 0 bot_join_team T bot_join_team T bot_join_team T bot_join_team T bot_join_team T bot_join_team T bot_join_team T bot_join_team T bot_join_team T bot_join_team T bot_join_team T bot_join_team T bot_join_team T bot_join_team T bot_join_team T bot_join_team T bot_join_team T bot_join_team T

* A fully armed CT team will result in total zombie annihilation every round...this gets boring quickly. Use mani admin plugin and restrict the following weapons:

awp // Magnum Sniper Rifle (alternatively, do not restrict but set ma_restrict awp 1) g3sg1 // D3/AU1 sg550 // Krieg 550 Commando galil // IDF Defender scout // sg552 // Krieg 552 m4a1 // Maverick M4A1 Carbine usp // KM .45 Tactical p228 // 228 Compact xm1014 // Leone YG1265 Auto Shotgun mac10 // Ingram MAC-10 tmp // Schmidt Machine Pistol (alternatively, do not restrict but set ma_restrict tmp 1) ump45 // KM UMP45 m249 // M249 flashbang // Flashbang hegrenade // HE Grenade smokegrenade // Smoke Grenade vesthelm // Kevlar+Helmet

                - Back to the top

[update]

There are a few changes in this release (0.2.4), so you will at the very least need to install the new model files and the server .dll or .so files.
NOTE!!!! You should remove any zombiehorde .res files from your map directory as they are no longer needed. Leaving these files in will cause new players to download unnecessary and outdated content!

                - Back to the top

[installation]

1. Copy the cstrike directory over your source dedicated server cstrike directory. This will put everything where it needs to go.

2. Edit your server.cfg as per recommendations above.

3. You MUST set sv_allowdownload 1 in server.cfg

4. Set any cvars you wish to change in zhplugin.cfg file.

5. Run the server!

                - Back to the top

[cvars/commands]

-cvar- -min/max- -default- -function- ------------------------------------------------------------------------------------------------------------------- zh 0/1 1 enable/disable zhplugin. zh_radiohint 0/1 1 if true, hints to zombie players about radio zh_zomhealth 1/9999 500 amount to increment zombie health to. zh_zomhs 0/1 1 if true makes headshots the only way of hurting zombies. zh_zomknifeonly 0/1 1 if true makes zombies unable to use anything but the knife. zh_modelswap 0/1 1 enable/disable the model selection menus and zombie skins. zh_regen 0/1 1 enable/disable health regeneration for zombies. zh_regen_hp 0/9999 5 amount to regenerate zombie health every 1 second. zh_debug 0/1 0 make zhplugin noisy. -command- -function- ------------------------------------------------------------------------------------------------------------------- zh_version print zh version to console. zh_log write zh version to log file. zh_buymenu bindable client command for a zh specific buy menu as per weapon restrictions above. zh_buyarmor bindable client command getting armor. totally redundant. -client command- -function- ------------------------------------------------------------------------------------------------------------------- zh_dumpvars print all zh server vars to client console.

                - Back to the top

[license]

Hate this stuff, but here goes....
This software is provided as is for free. You may redistribute this plugin, so long as this text file accompanies it.
You may not take credit for this plugin nor may you take money for it in any way.
This software has been tested extensively on Windows XP and Linux FC3, and only with CS:S.
You may try operating zhplugin with other OS's, plugins/mods, but be surprised if it doesn't crash or do _weird_ things :P
Please post bugs/problems on the forums at www.zombiehorde.com. The correct forum is the Plugins/zhplugin forum.
Posts in any other section will be deleted without explanation.
I take no responsibility for the consequences of your use of this software - no warranty of any kind is implied or assumed.

                - Back to the top

[acknowledgements]

�, zhadmin, .robot or deegz - whatever
Initial Concept, Project Leader, Programmer, Server Hosting

kaizan
Concept, Tester, Website Hosting, Server Administrator

Sempai.Hanz
Concept, Server Administrator, Art

Rav3n
Tester, Server Administrator, HTML, Graphics

beefy
Tester, Server Administrator

ics
Tester

Hef
Tester, Server Administrator

Kane
Tester, Server Administrator, Beer Consumption

Trooper
Tester, Server Administrator, IRC Op

Special Thanks: www.emotech.com.au, mosca.br, kylratix, sekkusu, mattie, mani, smallsumo, martin l, aj

                - Back to the top