Q3_LogGen - Quake 3 LogGenerator HTML
*************************************

Prog: Q3 Log Generator HTML (stat-prog for Quake 3)
home: http://www.cs.tu-berlin.de/~hanspete/Quake3
auth: Jacobs, Hans-Peter <hanspete@cs.tu-berlin.de>
date: 21th jan 2000


Contents
********
  1. What is it good for ?
  2. Disclaimer
  3. Getting Q3 LogGen
  4. Files in the distribution
  5. Running the program
  6. Saving disk-space
  7. Contacting the author



************************
1. What is it good for ?
************************
This is my try to add some statistics to Quake 3 (Full/Demo), UT came with
NgStat, and I really love this tool.
Without this feature its just half the fun :)

Unfortunately Quake 3 logs games just if you play as the server, or if
you play against bots (in MultiPlayer-Mode).
You will not be able to review your result in Quake's Single-Player
mode.
The magic file for finding the logs is called "games.log" and is
located in your "baseq3" / "demoq3" - directory.
Q3_LogGen takes this file and creates some HTML-files from the log of
the games you played. These output-files will be located in the
"Html_log"-directory, starting with a "index.html"-file.


*************
2. Disclaimer
*************
Q3 LogGen is free, you can do with the stuff whatever you want.
I wrote it for all the people who make the web what it is right now,
it has not been written for profit-junkies !

Thanx go to id for the game and especially to all the people constantly
improving Quake 3 with additional Maps, Skins, Models and Utils....
Thanx also to the people with the big servers :-)

+++++++++++ Use the program at your own risk !! +++++++++++
Its okay to  : hate, love, burn, delete, improve or ignore it
Its okay to  : send it your friends, use the code, print it out ...
ITS NOT OKAY : To sell it !!
ITS NOT OKAY : To distribute it for money without asking me !!
ITS NOT OKAY : to leave your [girl/boy]friend for it


********************
3. Getting Q3 LogGen
********************
You can download the Win-distribution at fileplanet
(www.fileplanet.com), but since they are a little bit to busy, there
are just old releases.
Direct download:
http://www.cs.tu-berlin.de/~hanspete/Quake3
Thats the hme of Q3LogGen, there you will find:
      Win   - the latest packages
      Linux - releases (works also for Unix ??!)
      Src   - packages
      and additional templates...


****************************
4. Files in the distribution
****************************
There are always the following files in the package:
      B@U%GS   - contains informations about bugs/reporting
      FAQ
      HOWTO    - for the advanced users :-)
      INSTALL  - detailed description how to install the whole thing
      README   - this.file()
      TODO     - my current TODO-list (mostly for myself)
      VERSION  - contains all (important ?) changes since the first
                 version
      Html_log - the default output-directory, contains a
                 "pix"-directory
      Templates- contains two standard-templates
If you got a Linux or Win-src - package you will also find a "src" directory.


*********************
5. Running the pogram
*********************
If you are running q3loggen for the first time, try a simply running
it by "q3_loggen" or "q3_loggen.exe".
You will see all valid command-line switches.

To get a first impression, run it with a "games.log" - file.
For example :
Win9x : "q3_loggen.exe c:\Games\Quake3\baseq3\games.log"
Linux : "q3_loggen /home/pub/quake3/baseq3/games.log"

After running (hopefully successful) go into the "Html_log" -
directory and take a look at the index.html (with Netscape, Lynx, or
any other good WWW-Browsers).

There is nothing you can do wrong, the program does not removes or
modifies the "games.log". May be later I will change this, because
the parsing-process is not very fast, but for now, everything stays
where it should.

If you want to set a new output-directory (default Html_log), make use
of the "-o <path>" - option.
If you want to try some other templates, try the "-t <path>" - option.


********************
6. Saving disk-space
********************
q3_loggen never erases a once generated HTML-file. If a file with
the same name is written to the disc, an older file may be overwritten
or truncated, but if you use a complete different log a lot of older
files will stay unused in the output-dir.
If you want to clean up the mess in the "Html_log" - directory you can
delete there all files, *** except the pix-dir therein ***.


************************
7. Contacting the author
************************
I am happy about every mail you send me.
Since my english is bad I am not afraid about flames, I simply would
not get the point :-)

Some people sent my code -> 1000 thanx to these people, but .. please,
you dont need to make such an effort ... 

If you ever want to change the layout (Templates) -> please report any
results, I would like to put this things on the Q3LogGen-homepage.



	   So play and have fun !!!!!
	   Hans-Peter Jacobs