MKLOG

MKLOG

Quake III Log File Statistics Generator.

/***************************************************/

/* M K L O G */

/* */

/* Quake III Log File Statistics Generator */

/* */

/* (c) Martin Kilcoyne 1999 / 2000 */

/***************************************************/

Author : Martin "Killer" Kilcoyne

Version : 1.21 - 4th January 2000

E-Mail : [email protected]

Website : http://www.planetquake.com/killer

After playing Quake III for a while and discovering the log file which it

updates for every game you play I decided it might be nice to see how well you

fare against your opponents statistically. Not only that but I wanted some

programming to do and this seemed like as good a project as any :-) Anyway,

MKLOG is the result.

Please read the INSTALLATION and RUNNING instructions carefully. The program is

easy to use but please read them before mailing me and asking me why it isn't

working :-)

It is very much a work in progress and I intend to keep improving and updating

it with new features. I'm sure there are some bugs in it and I'll endeavour to

fix those with further releases of the program. If you find any show stopping

bugs, don't hesitate to mail me and let me know but please make sure you check

the "KNOWN LIMITATIONS" section at the bottom of this document and also the

Frequently Asked Questions file ("faq.txt") before you do.

Check my site for the latest version of MKLOG and details about planned

features for future version. It is updated on a regular basis and is worth a

visit I reckon :-)

If you have any suggestions for additional features to include in new versions

of MKLOG by all means mail me (mail address at top of document).

/************/

/* FEATURES */

/************/

- Output to template dictated HTML files (individual templates for index,

players and map pages for maximum customisation).

- Input from Quake III generated log file.

- Statistics for total FRAGS, SUICIDES, GAMES, PLAYERS and MAPS contained in

the log file.

- Individual statistics for each player.

- FRAG, SUICIDE, GAME and TIME totals for each player.

- Frag breakdown, weapon by weapon, for each player.

- Suicide breakdown, weapon by weapon, for each player.

- Pickup breakdown detailing WEAPONS, AMMO, HEALTH, ARMOUR and POWERUPS.

- Statistics for total FRAGS, SUICIDES and GAMES for each map played.

- Statistics for MEAN FRAGS PER MINUTE for each map played.

- Statistics for MEAN SUICIDES PER MINUTE for each map played.

- Fast execution even on large log files.

See "changes.txt" for details of new features in this version.

/****************/

/* INSTALLATION */

/****************/

You can install MKLOG to a directory of your choice as you can specify the

path to the log file using command line arguments. For simplicity's sake I

recommend installing the program to:

C:\mklog

Make sure you check WinZip's "Use Folder Names" checkbox when you extract the

files or your HTML templates will be in the wrong place.

For your information the following files will be created upon installation:

C:\mklog\mklog.exe - The actual executable program.

C:\mklog\mklog.txt - This text file.

C:\mklog\changes.txt - Changes in this version.

c:\mklog\faq.txt - Frequently asked questions.

C:\mklog\templates\index_template.html - Template for the index file.

C:\mklog\templates\player_template.html - Template for the player files.

C:\mklog\templates\map_template.html - Template for the map files.

/*****************/

/* RUNNING MKLOG */

/*****************/

MKLOG is a simple DOS executable so running it is easy. Go to the Start menu

and click on Run. Rype the path to the MKLOG executable, e.g

c:\mklog\mklog.exe

This will run the program with the default options (detailed below) but there

are various command line options which are listed below.

mklog -l

- This allows you to specify the exact path to

the log file on which you wish to generate

statistics. The path must include the actual

name of the log file e.g

"C:\quake3\baseq3\games.log". The path can

contain spaces as long as it is enclosed in

double quotes.

* DEFAULT: "games.log"

mklog -itemp

- This allows you to specify the path to an

alternate index file template. The path must

include the actual name of the template file

e.g. "templates\my_index_template.html". The

path can contain spaces as long as it is

enclosed in double quotes.

* DEFAULT: "templates\index_template.html"

mklog -ptemp

- This allows you to specify the path to an

alternate player file template. The path must

include the actual name of the template file

e.g. "templates\my_player_template.html". The

path can contain spaces as long as it is

enclosed in double quotes.

* DEFAULT: "templates\player_template.html"

mklog -mtemp

- This allows you to specify the path to an

alternate map file template. The path must

include the actual name of the template file

e.g. "templates\my_map_template.html". The

path can contain spaces as long as it is

enclosed in double quotes.

* DEFAULT: "templates\map_template.html"

mklog -fmin

- This option allows you to specify the minimum

number of frags a player must have for him to

be linked when you use a

or a

identifier.

The value must me a positive integer value.

e.g. mklog -fmin 5 will only produce links to

players with 5 or more frags. Note ALL the

players statistics files are still generated.

* DEFAULT: 0 (i.e. print all player links)

I recommend you use a batch file to run MKLOG with your preferred options, it

saves a lot of typing on the command line where it is easy to make mistakes. To

create a batch file you can use Notepad to write the command line you want, for

example something like:

mklog -l c:\quake3\baseq3\games.log -ptemp my_cool_template.html -fmin 10

Then save the file as a .BAT file (rename it if necessary, Notepad doesn't like

saving files other than .TXT). You can then run MKLOG by just typing the name

of the bat file in a DOS window in the MKLOG directory.

All the output files will be generated in the same directory as the executable.

So once the program has run all you need to do is to fire up a web browser and

open "mklog_index.html".

/********************/

/* TEMPLATE DETAILS */

/********************/

The use of HTML templates in MKLOG enables you to customise the output so it

looks how you want it to look. If you don't want to customise the output or

can't be bothered then there are 3 default templates included which show you

all the stats that are available.

The use of custom templates is simple. All you need to do is to create a web

page which looks just how you want and wherever you want a certain statistic

you just need to insert one of the special identifiers which are listed below.

If you are still not sure how to go about creating a custom template then just

have a look at the default ones and I'm sure you'll soon get the hang of it.