~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Quake 2 Configuration Script
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
File: Documentation

Created: 1998-02-01
Last Modified: 1998-11-06

Author: JakFrost
Email: jakfrost(at)planetquake(dot)com
Web Site: http://www.planetquake.com/console/

Copyright 1998 JakFrost; All Rights Reserved

======================================================================
Index
======================================================================

1. Introduction
    1.1. Abstract
    1.2. Controls
    1.3. More Information
    1.4. Supported Mods
2. Installation
3. Script Design
4. Credits
5. Downloads
6. Legal
    6.1. Copyright
    6.2. License
    6.3. Trademarks and Servicemarks
    6.4. Warranty Disclaimer

======================================================================
1. Introduction
======================================================================

----------------------------------------------------------------------
1.1. Abstract
----------------------------------------------------------------------

This is a Quake 2 configuration script which defines how the keyboard
and mouse setup.  My script is a collection of bindings, aliases, and
settings which configure the mouse and keyboard for Quake 2.  My
script is designed to give you the best performance and the highest
frag counts out of Quake 2 by enabling you to have the ultimate
control over your character's movement.  My script is very comfortable
and easy to use and if you want to be the best player that you can be
you must use this script. It also has support for bindings and aliases
for many of the Quake 2 mods that exist so you don't have to bother
with making any more bindings.  This is going to be the last script
and key configuration that you will ever try in your life and you will
realize how good it really is.  Many people have converted and
improved their game, shouldn't you?

----------------------------------------------------------------------
1.2. Controls
----------------------------------------------------------------------

Now a little about the setup.  I play using the Microsoft Natural
Keyboard and a Logitech Trackball Marble.  However, this script will
work just fine with any keyboard and any mouse.  All of those people
who use a regular 101 key keyboard and a Microsoft Mouse will feel
right at home with this script also.  I have my left hand on the
left-side home position 'ASDF' on the keyboard, and my right hand on
the trackball.  This is the most comfortable hand placement since your
body retains a straight posture and the left hand remains in the
correct position on the keyboard.  After you play with this setup you
will realize that this is the optimum key setup because you don't
strain your wrists and your back will always be straight.  Your
doctor, your chiropractor, your HMO, and you will thank yourself for
using this setup when old age comes and little aches and pains become
a major problem.

With this configuration script I have total control of all important
aspects of the game.  The setup is designed in a very ergonomic way so
that all the necessary buttons are available at my finger tips.  I am
able to access everything that I need in the game with the movement of
my fingers on the left hand, because of this all the stress associated
with the movement of the wrist is eliminated.  Also since all the
functions are at my finger tips I don't have to look away from the
monitor to perform a function, which is necessary when you want to
play your best instead of having to look away from the action every
other second just to eat a rocket because you didn't quite see that
guy coming while you were fumbling and looking for that key you bound.

Basically, my left-hand handles movement of the character, weapon
selection, and item use.  My right-hand handles character orientation
or looking in other words, and weapon firing. This setup if quite
convenient and very comfortable and after you spend a night using this
setup you will realize how good it really is.

----------------------------------------------------------------------
1.3. More Information
----------------------------------------------------------------------

I recommend that you familiarize yourself with the
'baseq2/bindings.txt' file which contains a listing of all the
settings, aliases, and key bindings for all of the different mods
scripts.  If you have a printer you might want to print that file out.
Also, if you are curious about the history of evolution of this script
you should check out the 'baseq2/history.txt' file.

If you want to learn more about how the Quake 2 console works and what
you can do with it you should visit some web sites on the topic.  You
should check out The Console at 'http://www.planetquake.com/console/'
if you want to learn all of those console commands or want to read a
tutorial on how the console works.  I also highly recommend The Bind
at 'http://www.captured.com/thebind/' which has some great information
about aliases and scripts.

----------------------------------------------------------------------
1.4. Supported Mods
----------------------------------------------------------------------

Below is the list of the mods which are supported by this script.  All
of the necessary bindings and aliases have been already made for all
of these mods so you don't have to bother binding your own keys
anymore.

Action Quake 2 - http://action.telefragged.com/
Assassins - http://www.planetquake.com/assassins/
Battleground - http://ogl.cfoster.com/battle/
Catch The Chicken - http://www.planetquake.com/chicken/
Expert - http://www.planetquake.com/expert/
Freeze Tag - http://www.planetquake.com/freeze/
JailBreak - http://www.planetquake.com/rxn/jail/
Lithium 2 - http://www.planetquake.com/lithium/
Loki's Minions CTF - http://www.planetquake.com/lmctf/
Powerball - http://www.planetquake.com/powerball/
Rocket Arena 2 - http://www.planetquake.com/servers/arena/
Superheros 2 - http://www.planetquake.com/modsquad/super2/
Threewave CTF - http://www.captured.com/threewave/
ThunderWalker CTF - http://www.captured.com/tw/

======================================================================
2. Installation
======================================================================

The installation for this script is quite simple.  All you have to do
is unzip the archive in which the script files came from into the
'quake2/' directory while extracting the directory structure stored in
the archive.  If you use the 'pkunzip.exe' program you will have to
use the '-d' parameter.  If you use WinZip then you will have check
the box that says "Use Folder Names".  All of the necessary files will
be placed in their rightful places and on the next startup of Quake 2
you will be able to use the script.

These scripts have been designed to be very simple, easy to use, and
easy to install.  If you uncompress the archive correctly you will not
have to do anything special to make these scripts work, everything
will be handled automatically.

There is one thing though.  If you are a person who uses the inverted
mouse mode of aiming you will have to make a couple of small changes
to one of the aliases in this script.  You will have to edit the
Sniper Zoom alias which is stored in the 'baseq2/master.cfg' file. You
will have to change the 'm_pitch 0.06' and 'm_yaw 0.06' lines to read
'm_pitch -0.06' and 'm_yaw -0.06'.  You will have to do the same to
the line below, just make the numbers negative instead of positive.

======================================================================
3. Script Design
======================================================================

I feel that I must say a couple things about the design of these
scripts.  Basically the core of this script is stored in the
'master.cfg' file which is located in 'baseq2/' directory and which is
executed every time that Quake 2 starts.  Then, there are smaller
module 'autoexec.cfg' files which are stored in the appropriate
directories for their mods and which are loaded only when a server is
joined which uses that mod.  For example, when you join a Rocket Arena
2 server, the first thing that happens is that Quake 2 executes in the
'baseq2/master.cfg' file which sets up all of the basic bindings.
Then, the the file 'arena/autoexec.cfg' is executed by the mod which
contains the necessary bindings for that mod.  That file doesn't
contain all of bindings and aliases, it only holds the bindings which
are necessary for Rocket Arena 2 mod and which load on top of the
master bindings which were executed previously.  This way the
individual scripts for each mod remain very small and simple with only
the necessary bindings for that mod.

This very simple modular design allows me to create many different
scripts for many different mods but still keep the whole script design
very simple.  The modules load themselves when they are needed and
they load on top of the basic module.  The best part is that with this
design, the modules load themselves automatically whenever a server is
joined which is running a specific mod.  This feature is great since
it allows the player just to jump on a server and start fragging.  He
doesn't have to stand there while he tries to configure his settings.
It's all done automatically for him, talk about user friendly scripts.

======================================================================
4. Credits
======================================================================

I would like to mention one person who deserves a lot of credit and
who has given me a great idea for this script.  That person is
Indian18 who also runs a console oriented web site called The Bind at
'http://www.captured.com/thebind/'.  That site is the premiere source
for aliases and scripts for Quake 2 and mods.  If you want to spruce
up this script with more aliases I would recommend that you visit that
site and check out all the great content.

Also, I would like to mention that Indian18 came up with the brilliant
idea of the having the slave 'autoexec.cfg' files execute the
'master.cfg' file in turn solving a problem with the way GameSpy
forces the execution of scripts.  This was a revolutionary way of
dealing with a problem by reversing the order of execution and this
solution removed the need to alter any settings in GameSpy to execute
the scripts thus simplifying the installation of these scripts even
further.

======================================================================
5. Downloads
======================================================================

This script can be downloaded for the locations listed below.  The
filename for this script will always be 'jf_q2cfg.zip'.

http://www.planetquake.com/console/
ftp://ftp.cdrom.com/pub/quake2/console/

======================================================================
6. Legal
======================================================================

----------------------------------------------------------------------
6.1. Copyright
----------------------------------------------------------------------

This work is copyrighted pseudonymously by the author under all
applicable laws.  The author reserves all rights to this work.  The
copyright statement for this work is "Copyright 1998 JakFrost; All
Rights Reserved".

----------------------------------------------------------------------
6.2. License
----------------------------------------------------------------------

I hereby grant the right to distribute and modify this work according
to the Free Software Foundation's GNU General Public License Version
2, which can be accessed from http://www.gnu.org/copyleft/gpl.html; or
write to the Free Software Foundation, Inc., 59 Temple Place, Suite
330, Boston, MA 02111-1307, USA.  If you received this work in archive
format you should have this license in a file called 'copying.txt'.
Please preserve all authorship and contact information when
distributing or modifying this work.  All derivative works or works
containing parts of this work must be released under the same license
or a later version of it.

----------------------------------------------------------------------
6.3. Trademarks and Servicemarks
----------------------------------------------------------------------

All trademarks and servicemarks used in this work are acknowledged and
are the property of their rightful owners.  Quake 2 is trademark of id
Software.

----------------------------------------------------------------------
6.4. Warranty Disclaimer
----------------------------------------------------------------------

THIS WORK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY; WITHOUT EVEN THE
IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE.  THE AUTHOR IS NOT LIABLE FOR ANY RESULTS ARRISING FROM THE
USE OF THIS WORK.  ALL RISKS AND RESULTS THEREOF FALL ON THE USER.

See the Free Software Foundation's GNU General Public License Version
2 for details.

**********************************************************************
End Of File
**********************************************************************
