  BoffMods Version 1.0 by Boffo (cadmium@interlog.com)
========================================================

This is a Quake script I've compiled over time since
I began playing.  Parts of it I've pulled from people's
web pages (credit is given at the end of this file),
and I've added a number of my own modifications.

I play with a 3 button mouse, this script is basically
designed for one, I've also added keyboard keys for
the stuff the mouse does just in case your mouse screws
up, or if you use keyboard.  If you have a 2 button
mouse, there's a grapple key that'll replace the middle
mouse button.

========================================================
Files Included in this ZIP
========================================================
AUTOEXEC.CFG - Autoexec file
BOFFMODS.CFG - Main chunk of modifications
BOFFKEYS.CFG - Key assignments
README.TXT   - The file you're reading now

========================================================
Key Features
========================================================
Works for 2 button mouse, 3 button mouse, and keyboard
Circle Strafe
Autofire Grappling Hook
Quick Rocketjump
Primary & Secondary Weapon System
Support for important Threewave CTF 3.5 keys
Support for Hipnotic's Quake Add-on
Anti-StoogeBOT Key

========================================================
Setup Instructions
========================================================

                     * WARNING *
This can seriously mess up your config if you run it in
your QUAKE\ID1 dir.  Unless you like my config more,
you should either unzip it to a separate dir and run
"quake -game Boffo" (substitute Boffo for the dir you
put it in), or make a backup of your autoexec.cfg and
config.cfg before you try these out.

========================================================
Keys
========================================================
Movement:

        w - Forward
        s - Back
        a - Strafe Left
        d - Strafe Right
      r s - Moveup, Movedown - I'm aware that these
            keys don't seem to be needed if you point
            the mouse in the direction you want to go
            and press foward, but you move much faster
            with these, since you're only going in one
            direction as opposed to diagonally.
      q e - Circle Strafe left and right (taken from
            Bounty Hunter's config)
    SPACE - Jump
     LEFT - Turn left
    RIGHT - Turn right
       UP - Look up
     DOWN - Look down

Attack Related:

   MOUSE1 - (left button) fire primary weapon
   MOUSE2 - (right button) fire secondary weapon
   MOUSE3 - (center button) fire grappling hook (let
            go of button to release grappling hook)
        v - Rocket Jump - It's not exactly an attack,
            but I like to use it if someone gets too
            close to me in a modem game.  Not only do
            They get hit by splash damage, but I'm
            high enough in the air to hit them with
            a couple more rockets without hurting
            myself
     CTRL - Fire primary weapon
      INS - Fire secondary weapon
      ALT - Fire grappling hook (works the same as
            the mouse3 button)
        1 - Select axe
        2 - Select shotgun
        3 - Select super shotgun
        4 - Select nailgun
        5 - Select supernailgun
        6 - Select grenade launcher
        t - Select rocket launcher
        g - Select lightning gun
        7 - Select laser (for Hipnotic Patch)
        8 - Select Mjolnir (for Hipnotic Patch)

CTF Keys:

        z - Throw current weapon
        x - Throw a backpack with ammo in it
        c - Throw rune (not in Threewave CTF, but I
            play on a number of servers that allow
            it)
        b - Flag status
        ; - messagemode2 - Use this to talk to 
            teammates.  It's far away from everything
            else on the keyboard because if you've
            got time to talk, you've got time to
            move your hand around on the keyboard.

Misc Keys:

    SHIFT - Enables "Secondary Weapon Select" - Hold
            this down and press one of the weapon
            keys to assign it to your secondary fire
            button
      TAB - Show scores
   ESCAPE - Bring up quake menu
      + - - Increase/Decrease screen size
        ` - Toggle the console
      F10 - Quit
      F11 - Zoom In/Out
      F12 - Screenshot
        p - Talk.  Normal message mode.  Again, it's
            pretty far from everything else, so make
            sure you're in a safe place before you
            use it.
        n - Anti-StoogeBOT key (If their StoogeBOT
            is in it's unmodified form, it'll leave
            the server)

Quick Message Keys:

  Ridicule Keys
  -------------
        y - "You eat your whoopass with a fork or
             spoon?"
        u - "You like your whoopass shaken or
             stirred?"
        i - "Sorry, I don't eat whoopass.  Gives me
             diarrhea."
        o - "YOU'VE BEEN BOFF'ED"

  CTF Teamwork Keys
  -----------------
        h - "INCOMING!!!"
        j - "NEED HELP AT BASE!  QUICK!"
        k - "GOT FLAG, IS BASE CLEAR?"
        l - "BASE SECURE"

========================================================
Tips / Comments
========================================================
Secondary Weapon System:

The secondary weapon system is one of the most amazing
features of this script.  Although it may be annoying
at first to learn how to use, you'll find it to be a
very handy tool when you become proficient at using it
properly.

It is a good idea to assign a weapon that you're about 
to pick up to your primary/secondary fire button.

Have you ever had an attack completely messed up
because you've picked up a weapon along the way and
Quake automatically switched you to it?  It won't
happen any more.  In order to use the weapon you pick
up, you have to assign it to primary or secondary
fire first.  Otherwise, you can't use it.

Autofire Grapple:

This is what got Boffmods started.  I was sick of
switching to grapple all the time, and it was
screwing me up quite a bit.  The autofire grapple
originally was a toggle on/off thing, but there were
some problems with attack staying on when you switched
to another weapon.  You now have to hold down the
grapple button for as long as you want to stay
grappled.  If you're using mouse, this is no problem,
but doing so with keyboard might be a hassle.

Circle Strafe:

This is a handy tool.  When used with forward, you'll
circle around your target, while staying aimed at it
the whole time.  You can also use it to do "paranoid
corners", do this by pressing circle strafe just
before you round the corner.

Rocket Jump:

I apoligize for not having a lagged version of this
in this release.  It's useful in modem games, but
unless you're on a T1, you won't be able to use this
at all.

========================================================
Credits / Copyrights / Permissions
========================================================
Quake is a registered TM and Copyright  of id Software.
It kicks ass.

Scourge of Armagon is a registered TM and Copyright  of
Hipnotic Interactive Inc.  It also kicks ass.

========================================================
Legal Crap
========================================================
I am not responsible for anything that happens to your
computer when using this script.  If you mess up your
config files, tough.  I warned you up at the top of
this file.  If you didn't read this file, that's too
bad.  It's called README.  You should learn to follow
directions.

========================================================
Special Thanks
========================================================
Clan Squall
Iceman - for bearing with me with the bugs of earlier
         versions of this script
Q Tick - for inspiring my secondary weapon system
Bounty Hunter - You might have noticed that some of the
                keys are similar to Bounty Hunter's
                CFG (you can find it on the Xenocide
                Flag Academy).  This is because when I
                first started using the mouse, I
                downloaded his script.  Boffmods are
                modifications/improvements to the basic
                key layout in his script.  The circle
                strafe is from his script.
Dalias - the rocketjump modification is his, I'll take
         credit for it when I invent a lagged version
Blue - I got Dalias's rocketjump mod from his site

========================================================
Final Note
========================================================
I hope you enjoy using my script.  A fair chunk of work
went into it, and I'm making it public because it's got
some really nice features that no other scripts have
(at least I haven't found any that have them...)

Send all comments/suggestions/improvements to
cadmium@interlog.com