====== medGameStat =======
=== a UT99 mutator by ====
==========================
_ _ _
| | | | ___ | | ___ _ __
| |_| |/ _ \| |/ _ \ '_ \
| _ | __/| | __/ | | |
|_| |_|\___||_|\___|_| |_|

==========================
== Version 018 ===========
== www.birdieman.com/forum
== 2012.04.09 ============


After a game ends, this mutator will turn the game stats directly into an html stats file.

PROS?
- There is an html stat file ready for immediate use after a game.
- It logs any chat that occurs before or during the game (optional).
- You can change the look of the html file with a css file (a default css file is included).
- Has translocator stats (optional).
- option to not do item pickup stats (to save processing).
- It can include a path to a picture of the map (optional).
- It supports Deathmatch, TDM, CTF, DOM, or any class that inherits from these.

CONS?
- The normal ngStats log file is no longer created.
- If you are running a pubic server, you're still going to have to move the html files
to your domain host (maybe, see the Advanced section later).
- You have to read this entire readme. Carefully.


==========================================================
| Where to put the files |
==========================================================

Put these files into your UnrealTournament/System folder:
medGameStat018.int
medGameStat018.u
medGameStat.ini

We will place the medGameStatE.css somewhere else in a moment.


==========================================================
| You MUST create these folders |
==========================================================

In your UnrealTournament folder, create these two folders:
medLogs
medLogsTemp

Now in the medLogs folder, you must create a folder that is named after the current year,
and within that folder you will create a folder named after the current month, and you will
use digits for all the folder names. FOR EXAMPLE. Let's say today's date is April 9th, 2012.
So I will create a year and month folder like this:

UnrealTournament/medLogs/2012/04

so your directory tree will look like this after:

+-UnrealTournament
| +-Maps
| +-medLogs
| | +-2012
| | | +-04
| +-medLogsTemp
| +-Music
| +-Sounds
| +-System
| +-Textures


Basically, for every year and month you plan to use this mutator, the current year and month
folder must ALREADY EXIST within the medLogs folder. So while you're at it, make a few more.

+-UnrealTournament
| +-Maps
| +-medLogs
| | +-2012
| | | +-04
| | | +-05
| | | +-06
| | | +-07
| | | +-08
| | | +-09
| | | +-10
| | | +-11
| | | +-12
| | +-2013
| | | +-01
| | | +-02
| | | +-03
| +-medLogsTemp
| +-Music
| +-Sounds
| +-System
| +-Textures


Etc, etc. If you like this mutator and keep using it, you will have to remember to create the
future folders.


==========================================================
| medGameStatE.css |
==========================================================

For the moment, place this file in the UnrealTournament/medLogs folder.

If you don't know how to edit a css file, no problem, skip down to the next section.

If you DO know to use html and css, here's a couple of points for you.
A. You can open the medGameStatE.css file and edit it to your liking. You can play with it
later once you've got a stats page generated.
B. You must literally use this instance of the file, because it has particular encoding
built into it that helps with a firefox bug. (You may not use firefox, but your players might).
In other words, you cannot just create your own text file, and call it"medGameStatE.css",
because it won't have proper encoding. But you can open the one included and edit it to
your hearts content.


==========================================================
| That's it for basic setup |
==========================================================

At this point you can give it a try. Start UT, play a game, make sure to include the mutator
called "medGameStat018".

After the game, go into the current year and month folder within medLogs, and you should see
an htm file in there. Double-click it to open it in your browser.


==========================================================
| Options you can set in medGameStat.ini |
==========================================================

Open the medGameStat.ini to review these settings.

[medGameStat018.medGameStat]

bRun - if true, this mutator will run. If you set a new value for this through
the mutate command, it will take effect the next game.

bLogInfo - if true, will add some info to the unrealtournament.log file. Helpful
if you're having trouble figuring something out.


[medGameStat018.medStatLogFileRelay]

bLogInfo - if true, (same as above)


[medGameStat018.medStatLogFile]

bLogInfo - if true, (same as above)

bGroupFiles - leave as true (or see Advanced).

bLogPickups - if true, shows stats for pickups. Given as an option to turn off to save
processing.

bLogTranslocator- if true, shows stats for the translocator. Given as an option to turn off
to save processing.

news - This will add a "news" row to the Server Info section, and it will contain
whatever text you enter here (and you could include html tags too, like
<br> for instance to help long messages to wrap better).

botTag - Text that follows the name of a bot to help identify it as a bot.

baseDir - leave this alone (or see Advanced).

baseDirTemp - leave this alone (or see Advanced).

htmExtension - extension you want for the html file.

bIncludePic - if true, the stats page will include a table, and will point to a jpg file
that exists... (see next setting)

picPath - the stats page knows what map is played, so it is going to create an image
tag in the htm with the picture called, for example, "DM-Agony.jpg". What
YOU have to do is supply the relative path to this picture, and, supply the
picture.

css - name of the css file to use.

cssBody - the body class within the css file to use. The point for all these css options
is to allow you to have as many classes as you want in your css file, and
these options allow you to change which one to use.

cssTable - the table class within the css file to use.

cssTDTitle - the cell "title" class within the css file to use.

cssTDHeader - the cell "heading" class within the css file to use.

cssTDValue - the cell "value" class within the css file to use.

cssTDVLine - maybe don't play with this one.

cssTR - not supported.

cssA - the anchor class within the css file to use.

bGiveCredit - if true, shows a link for this mutator back to my forum.


==============================================
| ADVANCED |
==============================================

bGroupFiles - Ok, you don't *have* to create all those years and months files. If you set the
option bGroupFiles to false, then all the stats files will go straight into the root of the
UnrealTournament/medLogs folder. However, this will cause a buildup of a massive amount of files
in one folder. It is much, MUCH easier to have them organized, or "grouped". I have a server that
now has over 10,000 of these stat files, so trust me.

The baseDir and baseDirTemp settings. Ok these might be worth playing with. If you are able to
host your html files from the very same computer that your UT server is on, then you might as
well have them created straight into the folder they will be hosted from, right? That is what
the baseDir setting will do. Look at the current value in the ini file. Notice that it is a
RELATIVE path. So the medLogs folder does not technically have to reside in the UnrealTournament
folder. It can exist anywhere on your computer, as long as you supply the proper relative path.
The path needed is relative to the location of the medGameStat.u file.
(Note, the medLogs folder and its years and month folders must still exist ahead of time).

And though you can change the location of the medLogsTemp folder, don't bother, there is no
advantage to doing so. But if you want to, follow the same rules for the medLogs folder.


==============================================
| command line |
==============================================

If you are running a server and your host allows you to edit the startup command line, here is
an example that would include this mutator:

unrealtournament.exe DM-Codex?game=Botpack.DeathMatchPlus?MaxPlayers=16?mutator=medGameStat018.medGameStat -server

To specify more than one mutator, you just separate them with commas:

unrealtournament.exe DM-Codex?game=Botpack.DeathMatchPlus?MaxPlayers=16?mutator=medGameStat018.medGameStat,medToggle350.medToggle -server


==============================================
| help |
==============================================

try www.birdieman.com/forum

To see a bunch of existing stat files, go to www.birdieman.com/stats, and
then click on the 2012 link, and then click on one of the month links.


==============================================
| fin |
==============================================