Title    : htmllog - Quake console -> HTML Stats converter.
Filename : htmllog-2.7.zip or htmllog-2.7.tar.gz
Version  : 2.7
Date     : 24/08/97
Author   : Mark Toller (a.k.a Pyro) <mst95r@ecs.soton.ac.uk>
           http://diana.ecs.soton.ac.uk/~mst95r/
OS       : DOS or Linux

Whats new
=========

A few bug fixes :) 

linux ver should now correctly identify maps from dos log files.
a few speed improvements.

What is it?
===========

htmllog is yet another Quake console log parser, to get all those stats about
who fragged who the most! htmllog produces a set of html files showing the 
overall stats for a match, and stats for each individual player. 

htmllog can produce stats for team games as well, it will ask for the team 
each player belongs to, and adds a table showing the team scores in the main
page for each map.

htmllog can display the players names as they appear in Quake by creating gif
images using the quake font - nice for those names that use special characters
that do not translate to text well.

htmllog creates an index file 'index.html' will contains a list of 
all the map names from the log file.  Clicking on a map name will take you to 
the overall stats page for that map, containing a table with the players names,
rank, frags, deaths, accidents, and efficiency. Below this is another table 
showing the number of kills per weapon, and who got the most kills with a 
particular weapon.

Clicking on any players name takes you to a page containing more detailed stats 
on that player, including who they killed, with what weapon, the number and 
type of accidents they had (falling in lava, drowing, killing themselves with 
rockets, etc) and the number of times they killed their own teammates! 

A problem I found with other log parsers was that the new death sequences that 
are produced, such as TeamFortresses

"Player succumbs to sniper fire from Pyro"
"No Pyro, throw the grenade, not the pin!"

will not be detected as these messages are hard-coded into the parser, and 
so the frag count will be incorrect :(

htmllog uses a file (death.dat) to store all the death sequences that 
you wish to detect, and so can be used on any console log file.
There are three types of death :

DEATHS   - someone killed someone else.
ACCIDENT - someone killed themselves.
TEAM     - someone killed a member of their own team, backstabber!
CTF      - CTF lines, such as Pyro defended the flag carrier.
TIMER    - Support for games with time info - I'm trying to create graphs of
           the frags/time...

(CTF and TIMER support are not complete yet)

The format of the death.dat file is as follows :

<TYPE>=[-]<HOW>
String 1
String 2
     .
     .
     .

where TYPE is the death type (DEATHS, ACCIDENT, TEAM, CTF, TIMER), and
HOW is the weapon used or type of death e.g. ROCKET, SHOTGUN, DROWNED, 
BACKSTABBER, etc. For new lines where the first player kills the second,
i.e. 'Pyro rips Dibbler a new one', place a minus sign after the equales sign.

e.g. 

DEATHS=-Quad Rocket
NAME rips NAME a new one
                               
DEATHS=L. Gun
NAME accepts NAME's discharge
NAME accepts NAME's shaft
                                
ACCIDENT=rode his own rockets
NAME becomes bored with life
NAME checks if his weapon is loaded     


If you're adding a new ACCIDENT type, then be aware that the string that
follows 'ACCIDENT=' is what will appear in the HTML file.... 

Have a look at 'death.dat' to see about the other types. 

Options.
========
-m produce stats for all the maps in a log file, rather than one per map.

-w This allows you to specify which directories the html files and giffiles
   are to be placed in. If the images directory does not start with a '/' or 
   '\' (depending on the dos or linux version) then it is assumed to be 
   a relative dir from the html directory.
   Default if now ./html for the html files and ./html/giffiles for the 
   images.

-n takes a number - any player with less than this number of frags + deaths +
   accidents will not be displayed in the stats pages.

-i will make htmllog ask questions about overwriting files, and odd player 
   names etc.
 
-t Teamplay - produces team stats, you have to tell it whose on what
   team though!  You Can choose to order by rank or by frags (as in Quake) 
   with -o [frags|rank].

-u Takes a number - any maps with less than this number of players will be 
   ignored.
   
-n Takes a number - any player with less than this number of frags + deaths
   + accidents will not be shown on the main pages.

-p Turns off the creation of individual player stats, i.e. only produce the
   main frags/deaths weapon stats page and index page.

-x Use text for the players names - this is useful for pages being access by
   ppl with slow connections, but doesn't look as nice.

-l List all the maps in a log file, with the number of players in each map.

-h Help.

All this for just 49.99 - only joking, it's freeware but if you use it, drop me
a line and let me know. Also if you have any ideas/improvements email
me (mst95r@ecs.soton.ac.uk).
                                                   
Credits
=======

Well, ID Software for such a mind blowing game - roll on QUAKE II!

Many thanks to Torsten Hagedorn (http://fettesau.halifax.rwth-aachen.de/), 
who wrote the code to create the gif files, and gave me some new ideas, and 
also to Jeroen Wollaars <jeroenw@worldaccess.nl> for mailing me with many bug 
reports and ideas.

And of course, the usual disclaimer - if by some fluke occurrence this
program causes any damage to your computer, it ain't my fault! It's free,
use it at your own risk... The only risk I know of is hurt pride when
you see how badly you got fragged, but that doesn't happen to me very often ;)

I guess also that the image letters from Quake are property of ID Software.

I'm not releasing the source code, because, well, frankly it's a messy
hack of a program! Enjoy.