Readme v1.8

  		     ATROPHY PRESENTS

                        ========
                         HITMEN
                        ========


Version  : 1.5d Final
Date     : September 30th 2000
Author   : Jason "Rat instinct" Lucas.
Email    : RatInstinct@hotmail.com
WWW page : www.planetkingpin.com/atrophy

Main Acknowledgement to Mike "Artful Dodger" Fox for the original idea of NIQ for Quake2.
Many thanks. Also a very big thank you goes to Monkey Harris for giving me the power to
compile this mod for Linux.

1) THE GAME
   --------

1.1) What is Hitmen all about?

Every weapon in the game has vanished! Well it ain't as bad that as weapons are given out
by the server but at least this will put the whole game on a level playing field for the
first time ever.

1.2) The rules.

Kill everyone. Nuff said.

1.3) Whats in it for me?

No weapons or health in the game just armour.
Spawning with 2 seconds of invincibility to stop spawn campers.
Fully configurable server via .ini config file.
Cancel out the use of your most hated weapon.
See your atackers health when you die.
Standard pistol damage increased, so 2 shots and yer dead.
Crowbar added to have fun when you feel like a change. This can be selected manually.
Usual position out of players info.

1.4) Installing and running.

Just unzip all the files into your Kingpin directory and they will be placed in the correct locations (Kingpin/hitmen).

1.5) Extra commands available.

There's 2 new commands in this release of Hitmen, the first is to recall the message of the
day for whatever reason. Just enter bind n "showmotd" to display it if you want. The second
command has more use and this is to display the server config on screen, for this enter
bind m "showcfg" and behold you will see the server settings on screen. The latest command
added is "showstats", this lets you see how well your doing compared to the leader.

1.6) Using the grappling hook.

this will probably take some getting used to but the rewards can be excellent. Once the
hook.cfg file has been exec'd or the commands added to your normal autoexec.cfg then there
will be three keys that can be used. The first is to extend and grab something, this is the
shift key by default but there's nothing to stop you using anything else. Press and hold the
key and the hook will launch and not stop until it hits a wall, once it has the longer you
hold the key down the more it will pull you in. After letting the shift key go you will
hang from the wall until you press the shift key again. While you are hanging around
pressing 'e' and 'w' will make you ascend and descend the rope. Now go and have some fun.

2) CONFIGURING A SERVER
   --------------------

There a quite a few configurable options for Hitmen so pay attention and you'll get the
most from this mod.

Option     Value   Description
======     =====   ===========
randweap      1    Setting to '1' this will change the weapons in a random sequence.
                   If this is set to '0' then the weapons will cycle in there normal
                   sequence.

soundwarn     1    Setting this to '1' will sound a warning every second for the last
                   3 seconds just so you know when your weapons going to switch.

healthsnd     1    Everytime your health increases we have a sound effect unless
                   you turn this one off.

killforhealth 0    By default our health is increased every second but if we want to 
                   make it more interesting we can kill for our health. 5 every second
                   or 25 per kill.

showhealth    1    If you want to know just how close you came to killing your attacker
                   then turn this on and prepare to be sickened.

hookavail     1    If you want to be able to swing from the rafters just set this to 1
                   and make sure you exec the hook.cfg file.

stdlog        0    This release if Hitmen(1.2) now supports the GSLOG originally written
                   for Quake2 so you can log your games and review them with Gibstats.

oneshot       1    Allows you to choose if the pistol is a one shot kill weapon or normal.
		   If set to 0 then the damage is the standard, several shots.

weapontime    50   The number of seconds before the weapon changes can be anything from
                   30 - 300 but 50 is a good starting point.

weapons       127  If you don't want people to use a HMG then changing this will give
                   you that result. See the ini file for the values.

motdtime      4    Allows you to set the duration the MOTD is shown for. 1-8 seconds

stattime      8    Allows you to set the duration the stats and config screens show for.
                   4-20 seconds.

fraglimit     30   Moved from the server.cfg into here for reason see below.

timelimit     15   Moved from the server.cfg into here for reason see below.


Major change to the .ini file is that you can now change the settings for different maps. This
enables you to be more varied in what weapons etc can be chosen, for instance there could be
a map which grenade launchers are not a good idea for but the next map is great for them. Well
now you can choose whats used and what isn't. All the values above can be changed to whatever
you want. To use this just create a file with the name of the map and the .ini extension after
it such as kpdm1.ini, sickrre.ini, kpq2dm5c.ini etc. If you get a new map and don't create an
ini file for it then the previous settings will be used.


CONFIGURING THE HOOK
====================

See the separate hook_cfg.txt file, only needed for clients.

3) RELEASE HISTORY

04/01/00 - Initial release, v0.9b.

18/01/00 - V1.0 Bug fixed in weapon timer on map change. Added improved MOTD that I always
		wanted to put but there was always problems but the competition mod source
		helped track the bug down cheers lads. Added display server config to screen.

30/01/00 - V1.1b Added the grappling hook. Changed the pistol to the magnum. Increased the
                 rate at which the flamethrower fuel was added.

25/03/00 - V1.2 Removed old debug message. Added GSLOGGING so stats can be tracked with
                Gibstats. Added extra Hook command so people can't spend all day swinging from
                walls/sky.

29/03/00 - V1.3 Added showstats command to see how well your doing compared to the leader.
                Also added configurable time for the MOTD, stats and config screens.

10/04/00 - V1.3b Minor fixes. Showstats command enhanced to cycle through everyones stats
                 each time its pressed. Next release hopefully will feature the resume option
                 from the Comp Mod.

14/05/00 - V1.4 Well it took sometime to do but I've finally added the resume feature from the
		Comp Mod.

17/09/00 - V1.4f Increased clip for the pistol to 15 and added the pistol silencer which is
                 long overdue.

20/09/00 - v1.5  Oops forgot to set the pistol damage to one shot when I changed it, now back.
                 Also added option of selecting whether or not the damage is 1 shot your dead
		 or normal mode. Also added level specific configuration.

24/09/00 - v1.5  After some serious testing by [BC]Truz fixed a few bugs with the level ini
                 loading option and its spot on now. Also added the Speed hack fix and auto
                 kicking of these naughty people.

30/09/00 - v1.5d More fixes after [BC]Truz yet again had a good testing session. Also added
		 automatic kick/ban when people tried using the speed hack. New to v1.5d is
                 the logging of people trying to spawn items in the game which recently came
                 to light. Hopefully no more updates, yeah right.



4)  DISTRIBUTION NOTES
    ------------------

4.1) Disclaimer, copyright and permissions
     -------------------------------------

Kingpin: Life of Crime (c)1999 Xatrix Entertainment, Inc. (Cheers lads)

Hitmen is Copyright where applicable by Jason "Rat Instinct" Lucas.

No written permission is needed for distributing this Mod on any media known or unknown to
me, but a mention of myself would be nice.

4) ACKNOWLEDGEMENTS
   ----------------

Thanks to PlanetKingpin, Poisonville and Wireplay for mentioning this mod in their news.
Thanks to Pigwhistler for testing when possible on his LAN. Also thank you to [BC]Cap-n-yo-ass
for all their feedback and suggestions of which there were many :-). A big thanks to
everyone who plays this mod and makes it all worth while.

If I've missed you from this mention please let me know ASAP.

		Cheers.


