******************************************************
**                                                  **
** QTray v1.11                                      **
**                                                  **
** by Brian Kelly                                   **
** a.k.a. Fragbert <fragbert@planetquake.com>       **
** http://www.planetquake.com/quakeon               **
**                                                  **
******************************************************
** Quake is a registered trademark of id Software   **
******************************************************
** This program is freeware, and may be freely      **
** distributed to your little heart's content.      **
** Just make sure that you distribute all included  **
** files (including this text file) in their        **
** original, unmodified form.  Thanks!              **
**                                                  **
** However, if you want to put QuakeOn and QTray    **
** on a CD, you MUST ask me first.                  **
******************************************************


=================
TABLE OF CONTENTS
=================

- WHAT IS QTRAY?
- INSTALLING QTRAY
- USING QTRAY
- TIPS AND QUIRKS
- UNINSTALLING QTRAY
- LEGAL MUMBO-JUMBO


==============
WHAT IS QTRAY?
==============

QTray is a small utility that can be used in conjunction with QuakeOn, the
Windows-based front end for Quake.  QTray replaces the system tray
functionality of QuakeOn.  QTray was written in response to the fact that
QuakeOn is a real, full-blooded application that requires a chunk of system
resources to function properly.  For a front end, this is fine, but it makes
it highly undesirable to leave QuakeOn minimized to the system tray for the
moments when you get a whim to play Quake.

QTray performs the same system tray functionality as QuakeOn, but it is
separate, much smaller, and much faster.


================
INSTALLING QTRAY
================

Simply place the "QTray.exe" file in the same directory where you installed
QuakeOn.  If you haven't installed QuakeOn, then QTray won't do you much good,
so don't install it.


===========
USING QTRAY
===========

Run QTray...  It will read your settings created in QuakeOn, and allow you to
launch Quake from the system tray.  Right-clicking the QTray icon will bring up
the QTray menu, and double-clicking the QTray icon will do one of two things
(we'll get to that in a second).

First, let's discuss the QTray menu... from the bottom up...

Exit QTray
----------
Pretty self-explanatory... unload QTray from the system tray.

Refresh Menu
------------
Here's the story:  QuakeOn and QTray share data.  Specifically, they share
information about QuakeSets contained in the QuakeOn.ini file.  If you make
changes in QuakeOn and want to reflect the changes in QTray, you must first
save the changes in QuakeOn.  There are three ways you can force QuakeOn to
save its changes:

1) Click the "Super Refresh" button
2) Start Quake from QuakeOn
3) Exit QuakeOn

Once you do this, QTray will run QuakeSets properly.  However, if you've made
changes to the names of QuakeSets, added or deleted QuakeSets, or changed
your Shortcuts folder (if you have one), then you need to run "Refresh Menu"
within QTray to update the menu.  If you change the icon or tool tip text
within QuakeOn, you must Exit QTray and restart it for the changes to take
effect.

Launch QuakeOn
--------------
Again... pretty self-explanatory.  Starts up QuakeOn so that you can edit
your QuakeSets.

These next two are off the options menu...

"listdemos"/"listmaps" functionality
------------------------------------
To implement the "listmaps" and "listdemos" features, QuakeOn builds the
lists right when you run Quake.  It can do this quickly because it already
has the lists in memory.  However, QTray does not keep track of such things
so it has to explore your directories and pak files at run time, which can
take time that you may not want to spend.  That's why QTray has its own
settings for listmaps and listdemos.  For either feature you can:

1) Disable it:  It won't work
2) Use it:  It will take the time to build the list before you run Quake
3) "Thread" it:  It's not *REALLY* threading the process, but that's
   basically how it appears to the user.  QTray will build the lists AFTER
   it launches Quake.  By the time you can pull up a console in Quake, the
   lists will be all ready for you.

So why not just "thread" these lists all the time?  Because I worry.  Although
this feature hasn't failed in testing, I can forsee problems, since QTray is
actively looking in pak files and bsp files while Quake is loading these same
files!  It's up to you.  If you start having problems, stop threading the
lists...

Double-Click Choices...
-----------------------
This feature provides a little more flexibility about what happens when you
double-click the system tray icon.  If you select "Launch QuakeOn", then
QTray will launch QuakeOn when you double-click the system tray icon.  If you
select "Run Quake", then QTray will run the LAST QUAKESET YOU RAN.  This can
be very useful, especially if you are developing a patch or map and you need
to jump into Quake to test it frequently.

Settings File
-------------
If you create multiple settings files with QuakeOn, this menu will appear and
give you the option to switch files on the fly.

Shortcuts Menu
--------------
The shortcuts menu was added to QuakeOn 0.96 to provide users with a way to
access other programs and shortcuts from the QuakeOn system tray.  QTray
mimics this functionality.  If the shortcuts folder in your QuakeOn directory
is empty or doesn't exist, this menu option will disappear.

QuakeSets
---------
The list of QuakeSets you've defined with QuakeOn.  Click one to launch Quake
with the settings specified in that QuakeSet.


===============
TIPS AND QUIRKS
===============

The QTray icon becomes an upside-down Quake symbol when QTray is busy...

It's possible to have QuakeOn run its system tray icon at the same time as
QTray.  QTray is a separate program... QuakeOn is a complete program that
supports the system tray, but QTray does it more efficiently.  So, unless you
really love Quake and want TWO Quake symbols in your tray, turn off the tray
in QuakeOn (or don't use QTray).

The output from listmaps is more readable from QTray than in QuakeOn.  It will
still be better than QuakeOn even when QuakeOn 1.0 comes out.  Don't ask why
(unless you really, really care).  Yet another reason to use QTray.


==================
UNINSTALLING QTRAY
==================

Delete qtray.exe, qtray.ini, and qtray.txt.  If you want to uninstall QuakeOn,
follow the procedures outlined in the readme.txt file included with QuakeOn.


=================
LEGAL MUMBO-JUMBO
=================

THIS SOFTWARE AND ACCOMPANYING WRITTEN MATERIALS (INCLUDING INSTRUCTIONS 
FOR USE) ARE PROVIDES "AS IS" WITHOUT WARRANTY OF ANY KIND. FURTHER, 
WE DO NOT WARRANT, GUARANTEE, OR MAKE ANY REPRESENTATIONS REGARDING
THE USE, OR THE RESULTS OF USE, OF THE SOFTWARE OR WRITTEN MATERIALS IN TERMS
OF CORRECTNESS, ACCURACY, RELIABILITY, CURRENTNESS, OR OTHERWISE. THE ENTIRE
RISK AS TO THE RESULTS AND PERFORMANCE OF THE SOFTWARE IS ASSUMED BY YOU. IF
THE SOFTWARE OR WRITTEN MATERIALS ARE DEFECTIVE YOU, AND NOT QUAKEON OR ITS
DEALERS, DISTRIBUTORS, AGENTS, OR EMPLOYEES, ASSUME THE ENTIRE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.
  
NEITHER QUAKEON NOR ANYONE ELSE WHO HAS BEEN INVOLVED IN THE CREATION, 
PRODUCTION OR DELIVERY OF THIS PRODUCT SHALL BE LIABLE FOR ANY DIRECT,
INDIRECT, CONSEQUENTIAL OR INCIDENTAL DAMAGES (INCLUDING DAMAGES FOR LOSS OF
BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION, AND
THE LIKE) ARISING OUT OF THE USE OR INABILITY TO USE SUCH PRODUCT EVEN IF
QUAKEON HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
