=======================================================================
Q3ServerKit Version 1.0

(pre-compiled version)

Copyright (C) 2000 Free Software Foundation, Inc.
Brian Satterfield <legowhore@legowhore.com>, 2000.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software Foundation,
Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
=======================================================================


A word from our sponsor...
==========================

Hi all...just a few things before you jump in.

This is my second time distributing something on this scale and I would 
appreciate any help in improving the distribution, setup files, code, etc.  
Please feel free to email me at the address in the "Contact, Updates and Info"
section below.

This software is IN DEVELOPMENT and as such is under constant change 
and improvement.  (There are many things I wish to add...see the "To Do" 
section below for details).  I am dedicated to the spirit and completion of 
this project and will respond to any email related to this software.  I want 
this to be useful, cross-platform and easy for the common person to install 
and run.  Should you have any problems email me and I will attempt to help 
you, especially if it is something which can be overcome by an improvement 
to the system or distribution. 
 
(Translation - if the problem is you or your machine I can't help that)



Files Included
==============

this README


Pre-compiled class files
------------------------

This build was compiled on Windows NT with JDK 1.2.
I compiled it with an optimization flag and ran it through an obfuscator 
also...so that it would be as efficient as possible. 

The good: an easily run program if everything in the environment is right.
The bad:  There will be little or no debug information.  
The ugly: No source! :)

If you have problems get the full distro and recompile...
If all else fails contact me...as long as you're not being stupid I'll help.


Miscellaneous images
--------------------

Images used by the app.



System Requirements
===================

All that is required is a running version of the JDK, 1.2.2 or later.
I have extensively tested this on Linux and Solaris...with JDK-1.2 and
JDK-1.2.2.  USE the most recent JDK-1.2.2!!!  Especially for you Linux 
fans (like me :)  There were quite a few bugs in the original
Blackdown port of JDK-1.2.2.  It caused a memory leak and the
application threw out-of-memory errors after a few hours.  It's
completely fixed in the newest release tho...

Go here to get it: http://www.blackdown.org/java-linux.html



To Run the Q3ServerKit
======================


Setup
-----

All you need to do is tell your OS where to find java.

You do this by putting java in the PATH environment variable...

e.g

	UNIX 
	  bash - export PATH="$PATH:/usr/local/java/JDK-1.2.2/bin"
	  csh  - setenv PATH $PATH:/usr/local/java/JDK-1.2.2/bin
	Windows
	  set PATH=%PATH%;c:\java\JDK-1.2.2\bin

Depending on the distro you may need to set the variable JAVA_HOME as well.
To do that issue the same command above but replace PATH with JAVA_HOME and
take off the 'bin' at the end.


Running
-------

At this point the setup should be complete and you are ready to run the 
program.  To do this, make sure you are in the directory where the jar 
file is (this directory dummy :)

Then just run the following command:

java -cp ./q3.jar com.legowhore.q3.Q3ServerKit

or 

c:\ java -cp .\q3.jar com.legowhore.q3.Q3ServerKit



Known Bugs
==========

none 



To Do
=====

add ability to start the dedicated server

add functionality to search for game servers
  	- get the specs for retrieving the master.id file
	- sort by ping/game/players
	- typical gamespy look

add ability to start a game after selecting a server

add config options
	- point to q3 binaries
	- set refresh delay
	- set icon colors/game states

ability to send/receive email :)



Contact, Updates and Info
=========================

I can be contacted by email at legowhore@legowhore.com

To read about new changes or download the most recent version visit 
		
		http://www.legowhore.com



Fini
====

Well...that's it.  

Have fun...lemme know how you like it.

- LegoWhore

========================================================================

