Title    : htmllog - Quake console -> HTML Stats converter.
Filename : htmllog-1.1.zip or htmllog-1.1.tar.gz
Version  : 1.1
OS       : DOS, Win32 or Linux
Date     : 12/2/97
Author   : Mark Toller (a.k.a Pyro.BB)
E-Mail   : mst95r@ecs.soton.ac.uk
WWW      : http://diana.ecs.soton.ac.uk/~mst95r/

OK, before you turn away and say, "God, I'm not reading all this %$*!"
Take a look at http://diana.ecs.soton.ac.uk/~mst95r/ and follow the link
to the example page to see the results of this parser! 

After looking at DMS by DrBrain, and qlog by Jorgen Lundman, I decided that I
wanted a Quake console log parser that produced a set of HTML files
with overall stats, and per player stats, and that also showed players names 
as they appeared in Quake!

So, I wrote htmllog. This produces a main html file with the map name, 
followed by a table containing the players names, frags, deaths, accidents, 
and a ratio of frags to deaths. All the 'text' in the files (bar the numbers
in the tables) are images, created from the actual letters from the Quake
console - so the players names appear as they do in Quake!

You can then click on a players name, and go to another 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! Also, if you use the -c switch, you
can produce a commentry html file of all the chatting - this can either 
use images for the players names, and text for the messages, or use
entirely images, which looks nicer, but unless its on a LAN, there's just 
too much to download ;) 

Another 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.BB"
"No Pyro.BB, throw the grenade, not the pin!"

will not be detected, 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!

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

<TYPE>=<HOW>
Deathstring 1
Deathstring 2
     .
     .
     .

where TYPE is the death type (DEATHS, ACCIDENT, TEAM), HOW is the weapon used
or type of death e.g. ROCKET, SHOTGUN, DROWNED, BACKSTABBER, etc.
Each Deathstring is a string which relates to this type of death, and follows
one of :

string NAME string
string NAME string NAME
string NAME string NAME string
NAME string 
NAME string NAME 
NAME string NAME string

e.g. 
No NAME, throw the grenade, not the pin!
NAME discharges into the water
NAME rides NAME's rocket
NAME gets spammed by NAME's Mirv grenade

'DEATHS' types need a Deathstring to have two NAME's... 'cos otherwise you
will not know who killed who!

So, if you're playing on a server with a new phrase such as 

"Player gets sliced in half by Pyro.BB's shaft"

then all you need do is find (or add) the line DEATHS=LIGHTNING GUN, 
and add the line "NAME gets sliced in half by NAME's shaft" below
it. Cool!

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
and see what I mean ;)

-------------------------------------------------------------------------

OK, the one problem with the program is that I don't know enough about
gif images, so all the images produced are PNM images... eek! 
You need to get a program that can batch convert these PNM files into GIF 
files.

This can be done on linux with the ImageMagick 'mogrify' program, 
or in DOS with the Image Alchemy package. The batch file (or shell script)
'makegifs' is called if needed with one of these programs (or any others that
can do the job). It assumes that 'mogrify' or 'alchemy' is in the current
directory or on the system path.

ImageMagick can be downloaded from (at least) :-

ftp://sunsite.unc.edu//pub/Linux/X11/xapps/graphics
or
ftp://ftp.funet.fi/pub/Linux/util/graphics/ImageMagick-3.0.tar.gz

Image Alchemy (Demo Version) can be downloaded from :-

ftp://ftp.handmadesw.com/pub/alchemy/
ftp://ftp.uni-halle.de/pub/msdos/graphics/

and many other sites....  If you know of any other programs that can 
also do these batch conversions, please let me know.  And if anyone would
like to write some gif concatanation functions in C, that would be very
nice ;)

I tried, but really haven't the time. That RealLife(tm) thing...

-------------------------------------------------------------------------

GREETINGS

To all the members of the Buckshot Brigade, Corpus Clan, CP, and all the
other cool UK Clans!!

Many thanks to ID Software for such a mind blowing game - roll on QUAKE II!

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 your arse kicked, but that doesn't happen to
me very often ;)

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

Please, if you use this program, e-mail me (mst95r@ecs.soton.ac.uk) and
let me know, I want to see how many ppl use it. Also, any bug reports
please send to me with the console file that caused them. And any
suggestions for extra features are welcome....

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