cujo10.txt

ÉÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ»
º  Title    : CUJO  º
ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ

Filename : CUJO10.ZIP
Version  : 1.00

Date     : 96/9/04

Author(s): Jonathan E. Wright

Email    : nelno@interpath.com

Credits  : Micheal Polucha (TM Bot),
           Tim Polucha (TM Bot), and
           Nathaniel Gorham (DM Bot)

	   ID Software for designign Quake with Quake C!


ÉÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ»
º  Type of Mod  º
ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ

Quake C  : yes
Sound    : no
MDL      : no


ÉÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ»
º  Format of Quake C  º
ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ

unified diff  : no
context diff  : no
.qc files     : yes
progs.dat     : yes

See the included file PROGS.SRC for a list of which files have been
modified and which were added.


ÉÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ»
º  Description of the Modification  º
ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ

This mod creates a personal attack dog which will follow the
player and attack his enemies, even drawing fire in the process.

The dog will not attack zombies, since it cannot gib them.

This bot is based on original dog code and some code from
DM Bot 1.0.  The dog does not have any manual control functions
like those bots do.  He's all auto or he's dead.


ÉÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ»
º  How to use Modification  º
ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ

Impulse 100  Activates and Deactivates the dog

Impulse 104  Teleport the dog to your location.

Impulse 105  Turns on Cujo's collar lamp.  Great for dark places.

Bind these impulses to keys to make commanding Cujo easy.  For example, to
make the Q key activate and deactivate Cujo put this line in your
config.cfg file (or type it in the Quake console):

BIND Q "IMPULSE 100"

Now, every time you press Q Cujo will be toggled between his active and
inactive state.  You can bind the other two impulses in a similar manner.


ÉÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ»
º  How to Install the Modification  º
ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ


Unzip CUJO10.ZIP into a temporary directory and run INSTALL.BAT
with the full path of your Quake directory.  For example, if Quake
is located in C:\GAMES\QUAKE then you would type:

INSTALL C:\GAMES\QUAKE

This will install the necessary files in a directory called CUJO
which is inside of your Quake directory, and also create a batch
file in the Quake directory called CUJO.BAT which will run the
modified version of Quake.

If you are interested in seeing how this was done, you can manually
unzip the file SOURCE.ZIP which was contained inside CUJO10.ZIP
and look at the modified source.  If you would like to make your
own Quake C mods, get QCC.ZIP and read the instructions contained
within it.  Also, find one of the many web pages with info about
Quake modifications to learn more.


ÉÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ»
º  Technical Details  º
ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ

Features:

þ Cujo can draw enemy fire, lessening the amount of damage the player takes.

þ Seeks out monsters or other players and attacks them.

þ Will continue to attack as long as an enemy target is visible.

þ Will not attack teammates under Teamplay rules.

þ Cujo can follow the player through portals.

þ Cujo will not activate trigger fields (such as light triggers and traps)

þ Cujo is trained *not* to attack zombies, allowing you to toss a grenade
  in there without blowing up your dog in the process.  (But he will
  sometimes lick their gibs when your done - hey, dogs will be dogs!)

þ Cujo is a special, genetically enhanced breed of Rottweiler with 8 times
  the endurance of other dogs his size.  He can cause up to twice as much
  damage per attack as his piddly cousins, too.  And to top it all off,
  Cujo is wearing a special suit of armor designed specifically with him
  in mind.  Cujo is one *bad* dog.

þ Cujo cannot be injured by your shotgun blasts, axe, or thunderbolts, but
  you can hurt him with nailguns and rockets, so keep this in mind when
  firing at an enemy your faithful companion is already tearing to pieces.

þ Cujo is equipped with a special device based on slipgate technology.
  Should he become separated from you, you can teleport him to your own
  location instantly.  Cujo is even smart enough to activate this device
  on his own when the distance becomes very great.

þ Cujo does not need to be fed.  He takes care of this himself.

þ Cujo just loves to tackle big Shamblers while you put the nails to 'em!

þ This is not Sea Quest, so no amount of technology will allow you to talk
  to an animal.  He jsut growls and barks like animals do.


Bugs:

þ Cujo does not jump or walk past edges unless he is attacking, at which

  point he can fall into water and become lost (I hope to find a way to
  fix this...)

þ Cujo sometimes gets lost.  Okay.  Maybe it happens pretty often.

þ Cujo is not deactivated after a level change, I don't think, but I think
  the Quake code will dispose of it's entity memory anyway (tell me if I'm
  wrong, please).

þ Sometimes Cujo will continue trying to attack an enemy, even when he
  can't see it.  I put code in there to prevent this, and it seems not
  to happen very often, so I'm wondering if it is a problem with the
  visible () function.  I haven't really checked into it, since it is
  rare, and teleporting him to you will fix the problem, as will finding
  and killing the enemy he's after.

þ Please email about any other bugs!


ÉÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ»
º  Future Enhancements  º
ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ

I'm not satisfied with the ai following routines as they are, but I have
to learn more about what functions are available to Quake C for determining
world status such as platform edges and so on before I can do more on this.

I think it would be great to add Cujo as a power up.  This should have been
part of the game.  It would even work well in DeathMatch, as Cujo would
be an expendable weapon which worked in addition to the one you were already
using.  No time limit for this powerup, he stays around as until he's
killed.  At some point I hope to make Cujo a powerup which could be placed
on levels.  This would mean disabling some player control such as activating
and deactivating the dog when the player hasn't found the powerup.  If
you're interested in doing this, let me know!


ÉÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ»
º  Copyright and Distribution Permissions  º
ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ

Authors MAY use these modifications as a basis for other
publically available work.  Please send me any modifications
you make!

You may distribute this Quake modification in any electronic
format as long as this description file remains intact and unmodified
and is retained along with all of the files in the archive.