
FragLog Version 1.5 Help File

Copyright (C) 1997-1998 by Mike Dowell


DESCRIPTION

FragLog is a simple parsing program that takes the log file created by
Quakeworld and Quake II mods, and creates a sorted chart. Information
such as Rank, Deaths, Frags, Suicides are shown as well as calculated Totals,
Efficiency and Score. The number of users is limited to the amount of memory
on the machine. You can create custom HTML header and footer files to be
imported. This way a customized HTML file can be created quickly and easily.
The resultant HTML file will have the format of:

[IMPORTED HEADER FILE]
[FRAGLOG CHART]
[IMPORTED FOOTER FILE]


THE CHART

An example of the chart is shown below. The calculations used are:

    Efficiency = Frags / ( Frags + Deaths )

    Totals = Frags - Suicides

    Score = Efficiency * Totals

There are a few exceptions because of the rules of math...

         IF (Totals < 0) AND (Effeciency > 0)  THEN
           Score = Totals - (Totals * Efficiency)

          IF (Efficiency = 0) THEN (Score = Totals)

The chart is sorted by Score and then Efficiency. Here is an
example of the output:

Rank   Player      Score Efficiency  Frags  Deaths    Suicides  Totals
 1      Snip        19      83%       25       5          1        24
 2     frijole      16      80%       21       5          1        20
 3     dwelch       13      62%       23      14          1        22
 4      Bink        12      78%       18       5          2        16
 5    Mikey-D       12      73%       17       6          0        17


EXTENDED ASCII CHARACTER NAMES

With the release of Quakeworld 2.xx we can once again use the extended ASCII
character set to create multi-color and graphical names. FragLog will translate
these extended ASCII characters to the closest matching character to be
displayed in HTML. To find out how to make one of these names check out a
file on my web page:

    http://www.mike-d.com/games/name_fun.zip


USAGE

The usage of FragLog is very simple.

  fraglog [switches] filespecs

  -d number     Drop players with (Frags + Deaths) < number
  -f filename   Footer file, default is footer.html
  -h filename   Header file, default is header.html
  -l            Print chart of leaders
  -o filename   Output file, default is fraglog.html
  -n number     Set max number of players to print out
  -s            Treat log file as a Log Standard file
  -?            This help screen

For example the following command line:

  fraglog -d 10 -l -n 50 -o gumbydeath.html -h arenahead.html frag_*.log

will print the top 50 players with (Frags + Deaths) > 10 and the leaders
chart using all the frag_*.log files. It will try to import the default
footer.html and the specified header file arenahead.html. The output file
will be gumbydeath.html


LEADER CHARTS

In this version I have implemented a fun new feature. If you specify the
-l option you will get a chart of the stats leaders. The person with the
most Frags is the Brutality Leader, the one with the most Deaths is the
Mortality Leader, and the poor soul with the most Suicides is the Harakiri
Leader. Here is an example output:

               Brutality Leader: *DeathSpine* with 2020 frags
                Mortality Leader: -=sp00ky=- with 956 deaths
                  Harakiri Leader: bimbo with 493 suicides

Nothing spectacular, but it gives people something to shoot for or avoid.


LINUX AND SOLARIS VERSIONS

Starting with version 1.4 FragLog is now available on multiple platforms. I
tried to stick with portable C and it looks like it has paid off. I have
been using the Linux versions on my servers for a long time and they work
great.


QUAKEWORLD AND GIBSTATS STANDARD LOG FILES

FragLog will handle the log files created by Quakeworld by default. Starting
with version 1.5 FragLog will now read the Standard Log files that the author
of GibStats has created a spec for. Since Quake II doesn't have a frag logging
option, most mods that are out have implemented either the Quakeworld or
Standard Log file as output. I haven't done any additional output for the
Standard Log, just the regular chart, but if I get requests for it I might
add that later. Check the FragLog web page periodically for lists of mods
that have logging capabilities.


REAL TIME LOGGING IN QUAKEWORLD

I have set my server up to flush the log file every time a map change
occurs. This requires a simple change to the Quake C. In the "CLIENT.QC"
file look for the function definition for "execute_changelevel", inside
that function insert this code:

    localcmd("fraglogfile\n");
    localcmd("fraglogfile\n");

This is assuming that logging is already turned on. What the code does is
sends a command to the command line of the server just as if it were typed.
So the first "fraglogfile" command will turn off logging and close the
log file. Then the second "fraglogfile" will open a new log file and begin
logging again. If you don't know how to do this or just want the modified
.QC file feel free to email me.


CONTACTING ME

Please send me email just if you downloaded this so I can get a feel as to
how many people actually tried it. My email is  mdowell@mike-d.com and the
address for my home page is:

    http://www.mike-d.com/

The FragLog home page is currently:

    http://www.mike-d.com/freeware/fraglog.html

A sample of the output is available on my Gumby Death Quake II Server Page:

    http://www.mike-d.com/gumbydeath.html

These may change in the near future so just email if you get an error.
Again please send feedback so I can make this more useful. If you don't
want to have me in the middle let me know and I'm sure I can part with
the source code...fair warning though...both my C and HTML coding are
pretty grotesque!


RESPECT TO THE HOMEYS

I have to say a big thanks to the fraggers who have been using FragLog and
giving me great feedback and ideas. Two of them have been extremely helpful
and I just want to give a shout out to them. Both Highlander and *this have
worked with me and tested betas when I needed help. You guys rock!


HISTORY

*Version 1.5*   Released June 19, 1998

    -Added support for GibStats Standard Log files
    -Added optional leader chart for most frags, deaths and suicides
    -Added command line options for filtering, leaders, output file,
     header file, footer file and  number of players to print
    -Fixed a bug with player names that were blank
    -Speed should be even better now

*Version 1.4*   Released August 20, 1997

    -Number of players is only limited by total available memory
    -Speeeeeeed! this version should be about 4 times faster than 1.3
    -Support for Quakeworld 2.xx extended ASCII character names
    -Table is broken up every 100 users for faster browser loading
    -Have Linux and Solaris executables available

*Version 1.3*   Released August 7, 1997

    -Decreased the name size and increased number of players to 750
    -Got rid of the X/Y Chart...HTML files too big
    -Added Score data
    -Added sorting by Score, then Efficiency
    -Changed the rules to handle negative and zero values

*Version 1.2*   Never Released - experimenting

*Version 1.1*   Released April 21, 1997

    -Placed Kill Chart at top for quicker overview
    -Added Efficiency data
    -Sorted Kill Chart by Efficiency and X/Y Chart by Totals
    -If player has no Frags their Efficiency will be the negative value of
     their Deaths

*Version 1.0*   Released April 16, 1997

  This is the initial release...I hope somebody finds this useful and with
  feedback I can make it even more useful.


