======================================================================
Quake Configuration Scripts
======================================================================
File: Readme
Author: JakFrost
Web Site: http://www.planetquake.com/console/
Date: November 6, 1998
Release: 14
Copyright 1997, 1998 JakFrost; All Rights Reserved
----------------------------------------------------------------------
Introduction
----------------------------------------------------------------------
This is a set of scripts, which allows a player to perform certain
frequently used tasks or commands with a keystroke or two. These
scripts have been designed with speed and ease-of-use in mind and to
get maximum performance from your input devices. Ergonomics and
necessity are the basis for these scripts.
These scripts have been designed by me and only for me. I do not
give support for these scripts, I only release them to show people
what I use to play Quake. These scripts are very complex and very
dependant on your Quake setup so they may not work.
----------------------------------------------------------------------
Foreword
----------------------------------------------------------------------
The reason for the design of these scripts is that I was having
problems maintaining a key configuration when I wanted to play all the
different versions of Quake and the many patches. These scripts have
been designed around my playing style and my input devices which
include a Microsoft Natural Keyboard and a three-button Logitech
TrackMan Marble. I would also like to mention that these scripts have
been made for my use only but I decided to release them to the public.
These scripts use a modular design which is very complicated in
design. Quake wasn't exactly designed to deal with such a complex
script and modular design so a lot of hacks had to be created to make
the two work together.
The key setup is designed for a right-handed person with a three or
two button-trackball or mouse. Everything in these scripts will
depend on that setup. The left hand rests on the left home keys
'asdf' and the right-hand rests on the trackball or mouse. Refer to
the 'keys.txt' file to further detail on the key setup.
These scripts are not very easy to set up. I have taken all necessary
steps to make the setup process as easy as possible but it still
requires a lot of knowledge of Quake. These scripts are not for
everybody because of their complexity and difficulty of installation.
If you do not feel comfortable with Quake and console commands, do not
attempt to install these scripts. This is a warning and it should not
be taked lightly. These scripts are at the extremes of complexity, so
if you do plan on using them and installing them, consider yourself
warned.
----------------------------------------------------------------------
Installation
----------------------------------------------------------------------
1. Backup your 'config.cfg' and 'autoexec.cfg' files in your
'quake\id1\' dir.
Examples:
cd\quake\id1
copy *.cfg *.bak
2. Unzip the archive file with the '-o' and '-d' parameters into the
'quake/' dir.
Examples:
pkunzip -o -d jf_qcfg??.zip c:\quake
3. Find and delete all the 'config.cfg' files in 'quake/id1/' and the
patch directories.
Examples:
dir /s config.cfg
del id1\config.cfg
del ctf\config.cfg
del fortress\config.cfg
4. Copy the provided, empty 'config.cfg' file to all directores under
'quake/' dir.
Examples:
copy id1\config.cfg ctf\config.cfg
copy id1\config.cfg fortress\config.cfg
5. Write-protect all 'config.cfg' files.
Examples:
attrib +r /s config.cfg
6. Find the QSpy 'frontend.cfg' file in the 'quake\id1\' directory and
verify that it is 2-bytes long, and that it is write-protected.
Examples:
dir id1\frontend.cfg
attrib +r id1\frontend.cfg
7. Confirm all the steps above.
----------------------------------------------------------------------
Personal Preferences
----------------------------------------------------------------------
These scripts try to bypass the 'config.cfg' file so a few preferences
have to be setup in the 'preferen.cfg' file. Remember, that anything
you change inside Quake will not be saved, this is why you have to
edit these scripts.
1. Edit the 'name1.cfg' and the 'name2.rc' files to setup the player
name.
2. Edit the 'preferen.cfg' file to setup the rest of the preferences
such as sensitivity, color, etc.
----------------------------------------------------------------------
How to Use the Scripts
----------------------------------------------------------------------
1. Use the provided 'q.bat' file to execute the desired flavor or the
Quake executable file from the command line.
2. Remember to replace references in your programs (i.e. QSpy, QView,
QPlug, etc.) to the quake executable with the 'q.pif' file and the
appropriate parameters.
Replace: qwcl.exe -winmem 16 ...
With: q.pif swqw
If a key setup for a patch such as Threewave CTF is needed use the '/'
key to select the apporpiate patch from the menu. After executing a
patch module you can switch back to the executive module with the '.'
key and back to the patch module with the '/' key. After loading the
modules do not forget to use the 'enter' key for help.
----------------------------------------------------------------------
Send Me Email or Not
----------------------------------------------------------------------
Please do not send me email about problems that you have with these
scripts. Do not send me email asking me about aliases in these
scripts or what certain commands do. Also, do not send me email
asking me to change a thing or two in the scripts just for you. Do
not send me advertisments either. These scripts are provided without
support so I don't answer any problem questions. All types of email
mentioned above will be deleted immedietally.
If you would like to write to me about something which was not
mentioned in the above paragraph you can send me email. If you found
spelling, grammar errors or just general problems in the scripts you
can send me email.
----------------------------------------------------------------------
Where to Get These Scripts
----------------------------------------------------------------------
This set of scripts can be downloaded from here:
http://www.planetquake.com/console/
ftp://ftp.cdrom.com/pub/quake/console
----------------------------------------------------------------------
Credits
----------------------------------------------------------------------
James "bOi" Ariz <boi@accessv.com> for Script Ideas
======================================================================
Legal
======================================================================
----------------------------------------------------------------------
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 1997, 1998 JakFrost;
All Rights Reserved".
----------------------------------------------------------------------
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.
----------------------------------------------------------------------
Trademarks and Servicemarks
----------------------------------------------------------------------
All trademarks and servicemarks used in this work are acknowledged and
are the property of their rightful owners.
----------------------------------------------------------------------
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.
EOF