-------------------------------------------------------------
Swinging Grappling Hook QuakeC Mod v1.0a	1/30/97
Compiled with Quake v1.06 source code
-------------------------------------------------------------


This version of the grappling hook uses true swinging physics
never seen before. It allows chain climbing and sliding. All 
this with undisturbed use of weapons during hook use.


Description
-----------
Grappling hook is a rotating iron shaft with claws, thrown by
a chain and used for grasping, drawing and holding. Can be
used for getting out of tight spots, getting to unreachable
places and even grabbing your enemy, inflicting great pain.
Grappling hook does not use any ammunition.


Files included
--------------
* hook.cfg - key bindings for Hook patch
* pak0.pak - packed file with all the modified resources
  hook.qc - source for the grappling hook
  readme.txt - this file

* the only files needed to run the patch


Installation
------------
In your Quake directory parallel to the id1 directory make
a new directory called "hook". In this directory, put 
pak0.pak and hook.cfg files supplied. Modify your keyboard 
preferences in hook.cfg with a text editor. From within the
quake directory start Quake with this command line:

quake -game hook


Usage
-----
The default keys for using the hook are:

    SHIFT = for launching or releasing the hook (if held down
            while launching, player gets pulled until release)  
        R = for pulling or climbing the chain
        W = for sliding down or giving slack to the chain
 Jump key = for hopping off the chain and releasing the hook

Note that these are just the keys that happen to fit well 
with my key configuration. You could change any of the default
keys, except the jump key, to ones of your choice by modifying
the hook.cfg with a text editor. The jump key can be changed
through the normal Quake interface. 


The most frequently asked question
----------------------------------
Q: The grappling hook works fine in single player mode but why
   doesn't it work when I play on the Internet?

A: Quake is one of the first games that runs on a true client
   server concept. The server runs the progs.dat(the compiled 
   QuakeC code) not the client. This means that only the server
   can be patched with a QuakeC modification. In a single player
   situation, you local machine runs both the server and the
   client, so the patch is being used. With Q95 you are playing
   over the Internet on somebody else's server. In this 
   situation your computer is only running the client and you
   can only play with the patches that the particular server
   you connected to has installed. Some patches may require
   the client to download some resources such as maps, sounds,
   models, skins, etc. but the client never runs the actual 
   QuakeC code. So, the only way to play the hook patch(or any
   other patch for that mater) over the Internet is to connect
   to a server that has it or urge the operator of that server
   to use the hook QuakeC mod. This design prevents people from
   having unfair advantages on net games and empowers the
   server operator with deciding the rules of the game.


My list of future enhancements
------------------------------
- When player gets hit with 100 damage units(rocket or grenade)
  he should get knocked of the grappler.
- Add a little friction to the swing.
- Change player running frames for when he is hanging of the 
  chain to something more appropriate.
- Add the possibility to grab power-ups and weapons with the hook.
- When an object gets hit with the hook, add some impact
  velocity to it.	
- Fix the rest of the remaining bugs.


Known bugs
----------
- Sometimes player gets stuck to the ground even though he is 
  climbing the chain. If you move the direction keys a bit, you
  will become unstuck.
- Sometimes player will get repetitive pain noises if exiting 
  a level while pulling or climbing with the hook extended.
 

Credits
-------
QuakeC code and chain model by me: Perecli Manole AKA Bort
Hook model and sounds taken from the Morning star patch by: 
Mike (Last name unknown)


If you need help or have any comments or suggestions
regarding this mod, my address is: Perecli@ix.netcom.com
