GameLogger v4.0 Release Candidate 3
A mutator for Epic Games' Unreal Tournament 2004

Contents:

1. What is GameLogger
2. Archive Contents
3. Installation
4. If you have problems with installing UT4MOD
5. Plugin system overview
6. Notes on using Gamelogger
7. Copyright notices

1. What is GameLogger: to top       

Note: more detailed information on GameLogger, it's options and plugins can be found in full readme, that you can find in UT2004/Help/GameLogger folder

    Game Logger's purpose is to log all the game events such as kills, players scoring, team scoring, items being picked up, players' talks, sprees & multikills. It also writes down most rules of the game - time limit, server type, map, gametype specific settings, such as time to score for Double Domination. In the end of the match it recreates and logs end game score table. In brief, GL is like an IRC-reporter, but it writes the HTML log instead of transmitting to the IRC-channel. The size of one log shouldn't be more than 500kb, and it downloads faster, because of text compression, that is very useful for the dial-up users. They can understand what was happening in the game without downloading the demo. And I might add they don't need to download extra files used on server. This mutator is designed mostly for the LAN events, where not always could exist the possibility to upload demos or set up UTV.
    By default, GameLogger supports only standard gametypes and Jailbreak2004. Since this version, GameLogger has a plugin system that allows you to add support for your favorite mod or gametype.


2. Archive contents: to top       

UT4MOD version:

1. GameLoggerv4RC3.ut4mod - GameLogger installation module
2. GameLoggerReadme.int.html - This readme.
3. GameLoggerReadme.rus.html - Russian version of this readme.

Zip/RAR version:

Both versions have the same content, but those who have WinRAR might prefer RAR version, as it offers better compression and, obviously, lesser file size.

1. System/GameLogger.u - mutator's main package
2. System/GameLoggerECE.u - package with damagetype plugin for recognizing ECE vehicles damagetypes
3. System/GameLoggerJB.u - package, containing classes required for Jailbreak support. Loaded only if current gametype recognized as Jailbreak.
4. System/GameLoggerTTM.u - package, containing stats plugin for retrieving accuracy stats from TTM2004.
5. System/GameLogger.ini - Ini-file, that stores settings of mutator and it's plugins.
6. System/GameLogger.ucl - File of UT2004 caching system, allowing UT to see the mutator.
7. Userlogs/gameloggerimages - folder, containing images, used by logs.
8. GameLoggerReadme.int.html - This readme.
9. GameLoggerReadme.rus.html - Russian version of this readme.
10. Help/GameLogger - folder conaining more detailed vesrion of readme

3. Installation: to top       

UT4MOD version:

Just double-click the ut4mod file and follow the instructions, appearing on the screen. If you have problems installing the UT4MOD, check the last section of readme.


Zip/RAR version:

Unzip/unrar three folders - System, UserLogs and Help into your UT2004 folder, keeping the folder structure

3. If you have problems with UT4MOD : to top       

When you doubleclick UT4MOD Windows asks what to use to open this type of file

    Copy GameLoggerv4RC3.ut4mod to the System folder of your UT2004. Now, click [Start] button and select "Run..." option. In the opened window click [Browse] button and select Setup.exe that is located in your UT2004/System folder. When done, add in the end of the "Open" field, after the path to Setup.exe: install GameLoggerv4RC3.ut4mod. Now "Open" field should contain something like this:

C:\UT2004\System\Setup.exe install GameLoggerv4RC3.ut4mod

Now click [OK], and follow the instructions of the installator.

When you doubleclick UT4MOD it opens properly, but when you click "Next" on the page where you need to enter the path to UT2004, installator says that there's no UT2004 in this folder.

    To fix this, go to your UT2004/System folder and find there a file called Manifest.ini. If there is, make a backup copy. If it's absent, create one. Now, open the file and add the following lines to it:
[Setup]
MasterProduct=UT2004
Group=UT2004

[UT2004]
Caption=Unreal Tournament 2004
Version=3186
If you installed a different patch, change the Version value respectively.


5. Plugin system overview: to top       

    Plugin system allows you to create plugins that will allow GameLogger to log your favorite non-standard gametype. It also allows to make GameLogger independent from the packages containing these gametypes. There are 3 types of plugins:

Report Plugins

    These are the most complicated. They have functions that are called from nearly each function of GameStats allowing you to "comment out" nearly every event in the game, or add your own GameRules and call functions in you report plugin to add support for the new gametype. This is how Jailbreak support now works. If you're going to code the report plugin, check the included source code, you'll find comments on nearly each function. If you don't get something, feel free to mail me. To see how works plugin creating it's own Gamerules and working with them, check JB reporter plugin. An example of plugin creating it's own log to create a small summary of the match - check the CTF Summary plugin.

Extra Stats Plugins

    These are less complicated and much more restricted in use. By default they are called only once and only if "Dump players' individual stats" option is enabled. Their purpose is to collect stats during the whole game, and write it in the log in the end. See TTM Stats plugin for an example.

DamageType Plugins

    These are the simpliest. Actually they don't have any code at all, just properties. They store information on non-standard damagetypes, allowing GameLogger to recognize the damage dealt by this damagetype and write an appropriate action string


6. Notes on GameLogger usage. to top       

    GameLogger takes some lines from the game, so it is highly recommended to set your server's language to English. It highly not recommended to use GameLogger if language of the game uses non-latin fonts (i.e. Korean or Chinese simplified). Otherwise some strings in the log may consist from squares. To set the game's language to english you should open your UT2004.ini, scroll down to the [Engine.Engine] section and change the Language value to int (Language=int).

7. Copyright notices. to top       

Using code.

Everything that is being written by a person (literally) is a matter of copyright. This also includes source code. To obtain copyright you don't have to do anything. You obtain it autocmatically upon creation. To use something written by another man you need his permission. This also regards GameLogger's source code. Writing and debugging it take nearly 7 months, lots of nerves and fard work. If you want to use some parts of it you should mail me. Well, all I ask is to tell me where are you using this code. Note that I myself used some code of other authors, but the fact that they've permitted me to use it, doesn't mean that they permitted it to you.

Distribution and modifictaion of the content.

You may not modify files included in the package. You may not remove legal notices from the produced logs and summaries. You are free to distribute the archive with mutator in any way, via any media until it's contents remains intact. You may not sell the the mutator or put it on the media that is sold for money (that doesn't regard CD's and DVD's suppiled with magazines). If you're adding it to any pack, please inform me. If you uploaded it on your site for people to download, please inform me, so I can add you to the mirrors list.

Design of the log produce by UTXMPManualStyledWrapper is based on manual for UTXMP (Unreal Tournament eXpanded MultiPlayer), a mod for UT2004 made by Free Monkey Interactive © 2004-2005 Free Monkey Interactive.

Unreal Tournament 2004 ©2004 Epic Games Inc. All Rights Reserved. Unreal Tournament and Unreal Tournament logo are registred trademarks of Epic Games Inc. All other trademarks and names, and places of origin mentioned above are property of their respected owners.