KeyGrip 1.0.6 README
By David 'crt' Wright
Assistance and Original Concept by Chris 'Drastic_Man' Sykes
___________________

     I    Info and Disclaimer

     II   INSTALLATION INSTRUCTIONS *IMPORTANT*
     
     III  Starting and running KeyGrip

     IV   Misc Important info

     V    Web site and contact information

     VI   Version Info
______________________________________
Please read this Entire File BEFORE running KeyGrip
Failure to do so may result in incorrect program operation.
It is also a good idea to read the keygrip.pdf file so you will
understand how to USE the program.
The documentation (keygrip.pdf) is now in Adobe Acrobat format
to enhance readability. You need the Adobe Acrobat viewer if you
do not already have it. The free viewer is available from:
http://www.adobe.com/prodindex/acrobat/readstep.html

The following is from the GNU Public license, and is a general
disclaimer for KeyGrip. This does not mean that KeyGrip is
distributed under GPL. See keygrip.pdf for commercial
use/distribution info.
          BECAUSE THE PROGRAM IS LICENSED FREE OF
     CHARGE, THERE IS NO WARRANTY  FOR THE
     PROGRAM, TO THE EXTENT PERMITTED BY
     APPLICABLE LAW.  EXCEPT WHEN  OTHERWISE
     STATED IN WRITING THE COPYRIGHT HOLDERS
     AND/OR OTHER PARTIES  PROVIDE THE PROGRAM
     "AS IS" WITHOUT WARRANTY OF ANY KIND,
     EITHER EXPRESSED  OR IMPLIED, INCLUDING, BUT
     NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
     MERCHANTABILITY AND FITNESS FOR A
     PARTICULAR PURPOSE.  THE ENTIRE RISK AS  TO
     THE QUALITY AND PERFORMANCE OF THE
     PROGRAM IS WITH YOU.  SHOULD THE  PROGRAM
     PROVE DEFECTIVE, YOU ASSUME THE COST OF
     ALL NECESSARY SERVICING,  REPAIR OR
     CORRECTION.
Thanks to id for Quake, Uwe Girlich for LMPC, Eric Stern for his
Film at 11 source, Basty and the PlanetQuake crew for their
support, Lonnie Foster for the KeyGrip icon, and Steve Fukuda for
being the MVP beta tester.
                   

II.     INSTALLATION INSTRUCTIONS *IMPORTANT*
_____________________________________________
Please follow these directions exactly.
Do not just extract all the files into a directory and run.

1.  Make a directory for the files, and extract the ZIP to it.
    (e.g. c:\games\quake\keygrip)

2.  Keep
        keygrip.exe
        nviewlib.dll
        *.txt
        *.pdf
    in that directory

3.  Move all the files in the 'move2id1' directory:
        keygrip.dem
        example.dem
        qlmm.dem
        kgdemo.cfg
    to your id1 directory
(e.g. c:\games\quake\id1)
***You MUST overwrite the keygrip.dem that was included in the
0.7 beta with this one. Failure to do so will result in improper
operation.***

III.    Starting and running KeyGrip
_____________________________________________

1.  KeyGrip 1.0 runs much faster and is much more efficient with
memory than the 0.7 beta. However, for best performance, you
may want to shut down other running applications (Netscape,
MSIE, and MS Outlook are huge memory hogs). Also, if buttons
start showing up without glyphs (icons/pictures) on them, you are
running out of resources. Try quitting and restarting KeyGrip.

2.  KeyGrip 1.0 is resolution independent, and should work fine as
low as 640x480. However, for best performance, at least 1024x768
is recommended. 16-bit (or higher) Color is required for proper
image display. Large fonts should work OK, but are not
recommended. If status bars are being cut off, or things look out of
place, try small fonts.

3.  Run keygrip.exe

4.  You will need to configure the WinQuake directory in the
dialog box. For a description of the many other options, see
keygrip.pdf.

5.  After you have done this, you should be left with the program
open, a bunch of grayed out icons (and some enabled) and a big
open workspace. I recommend resizing the main window so that it
covers the top half or so of your screen. Running maximized is not
recommended.


IV. Misc Important Info
_____________________________________________

Based on feedback from the first KeyGrip 1.0 private beta, here are
some tips and problems we ran into:
If you are getting a GPF in your display driver, try getting an
updated driver. If that doesn't work, get DirectX5 drivers.

You should not run KeyGrip fullscreen. If you run it half-screen,
you can put WinQuake in the bottom left corner, and still have
room for the Block Tree and other dialogs on the bottom right
corner of the screen.

Currently KeyGrip has a 32,500 block limit. While this should be
enough for most projects, you may need to split larger demos up
using Film at 11 first.

If you are getting an "Index out of Range" error, try turning sound
editing off while working with that demo.

If KeyGrip starts Quake, and just sits there, you probably need to
install the keygrip.dem as described above.
You can now use the "Stop Updating" button to have KeyGrip stop
waiting for WinQuake to start.

Will KeyGrip work with normal quake/GL Quake?
No, Regular quake runs slower, and has more trouble running in a
window than WinQuake. GLQuake does not run windowed on
most systems, generates screenshots slowly, and in an incompatible
format.

V. Website and contact information
_____________________________________________

KeyGrip is generously hosted by PlanetQuake
(www.planetquake.com). The official homepage is:
http://www.planetquake.com/keygrip

The Author is David 'crt' Wright and may be contacted at:
wrightd@stanford.edu

For demo related questions, you may wish to speak with Chris
'Drastic_Man' Sykes:
dmp@dc.jones.com

Please report any bugs to crt at the above address. Features that are
not currently functional (such as File-New) are not considered bugs
and should not be reported. Please check the KeyGrip page for bug
reports/fixes before sending anything in. Be as descriptive as
possible, and include any relevant screenshots/demos with your
bug report.


crt is also the programmer of Rocket Arena for Quake
http://www.planetquake.com/servers/arena

VI. Version Info
_____________________________________________
Changes since version 1.0.5:
* Intellimouse wheel support
* Improved treeview, you can now just move off a message
parameter to update the message info, don't have to move off the
enitre message. Treeview also 6X faster
* Option to use PCX or JPEG screenshots (see preferences)
* Misc bug fixes
* Fully functional demo server (see keygrip.pdf)
Please note that I am not going to provide a lot of support for this
right now. For serious demo editors, it is a very useful tool, let me
know if you are having problems. For others, it is a very FUN toy,
but I don't have time to support everything. Read the docs, read the
instructions, it should work.
* Tested under NT, everything seemed ok, except the demo server.
WinQuake takes up like 100% processor in foreground, can't
figure out how to stop it (was able to in Win95). So playing demos
tends to be laggy w/ Quake in the foreground. Good with KG in the
foreground. 95 seems to work fine either way.