--------------------------
Tribal Logs v0.7 beta
by Chris "WegBert" Wegrzyn
--------------------------

NOTE: READ THIS WITH WORDWRAP ON!

--- Disclaimer ---
The author is not responsible for any harm to your computer, yourself, or anything/anybody else through the use or misuse of this program. This is beta software and may not work entirely correctly (although it should...it has been tested)

--- Introduction ---
I always really liked GibStats for Quake/Quake2. I always thought it was fun seeing how much I annihilated someone (or unfortunately how much they destroyed me), and when I purchased Starsiege: Tribes, I felt something was missing. I thought it would be very cool to have a similar system for Starsiege: Tribes, so I set out to make Tribal Logs. And, well, here it is!

--- BETA NOTE ---
This software is in beta state. It should work well, but any bug reports, feature requests, or general comments would definitely be appreciated. See the Contacting the Author section below for more info on how to get a hold of me. Remember though, check the help file before contacting me!

--- 3 Easy steps to Installation ---

If you downloaded tlogsetup.zip:
1. Unzip all of the files in the tlogsetup.zip file into a directory.
2. Run the included setup.exe file and follow the instructions.
3. Finally, run Tribal Logs!

If you downloaded tlogsmall.zip:
1. Unzip all of the files in the tlogsmall.zip file into a directory. If you have already installed Tribal Logs, use your Tribal Logs directory. Make sure you overwrite all of the existing files.
2. Finally, run Tribal Logs!

--- Program Use ---
Include with Tribal Logs is a full setup file. Every feature of Tribal Logs is described. If you have any questions, first check with the help file, and if that doesn't answer the question contact me (see Contacting the Author below)

--- Tribal Logs Mod ---
Tribal Logs mod was created so that server admins could track certain events that Starsiege: Tribes had not originally provided for, such as Flag Captures and Objective Holding. Because of the variety of the script files between different mods (i.e. Insomniax, IxAdmin, Renegades) and the Base version as well as between different versions of the Base, I have provided multiple versions of the Tribal Logs mod. Each version is in a zip file included with your Tribal Logs distribution. Below is a reference to which version you should use.

/---------------------------------------------------\
| Tribes Version | Modification  | File to Use      |
|----------------+---------------+------------------|
| 1.3            | Base (none)   | base1.3.zip      |
| 1.3            | IxAdmin 0.7   | ixadmin0.7.zip   |
| 1.3            | Insomniax 0.7 | insomniax0.7.zip |
| 1.3            | Insomniax 0.8 | insomniax0.8.zip |
| 1.4            | Base (none)   | base1.4.zip      |
| 1.4            | IxAdmin 0.7   | ixadmin0.7.zip   |
| 1.4            | Insomniax 0.7 | insomniax0.7.zip |
| 1.4            | Insomniax 0.8 | insomniax0.8.zip |
| 1.4.1          | Base (none)   | base1.4.zip      |
| 1.4.1          | IxAdmin 0.7   | ixadmin0.7.zip   |
| 1.4.1          | Insomniax 0.7 | insomniax0.7.zip |
| 1.4.1          | Insomniax 0.8 | insomniax0.8.zip |
| 1.4.4          | Base (none)   | base1.4.4.zip    |
| 1.4.4          | IxAdmin 0.7   | ixadmin0.7.zip   |
| 1.4.4          | Insomniax 0.7 | insomniax0.7.zip |
| 1.4.4          | Insomniax 0.8 | insomniax0.8.zip |
\---------------------------------------------------/

For information on implementing the Tribal Logs mod features into your modification, check out the Tribal Logs webpage.

--- Version Information ---

v0.5b - First version

v0.51b - Bug Fix Interim Release
 - Fixed a bug where logs with two of the maps would crash on HTML export (ouch)
 - Added Team Tracking Features
   - If a player's team is detected, they will have a colored box next to their name depending on their team in ranking mode.
   - Team Color Editor. You can change default colors (which are used if a team color isn't specified) or you specify a color for a specific team name (i.e. set team name to Diamond Sword and select a color, that color will then be used for players in that team)
   - Team Ranking view. Allows you to view Ranking mode style stats for teams. If a player has no team, they will be placed in the No Team team =)
   - Right clicking on names in the player list will set teams. Don't do this in Team Ranking mode, it will have unexpected results =)
 - Added team processing to HTML Templates
   - Create a team loop like this: <$LOOP TYPE=TEAM$> and work like normal loops
   - Inside of the loop, you can access team stats just like player stats: <$TEAM VAR=Statname$>

v0.6 - Major update
 - Progress Bar can be enabled or disabled when importing a log
 - Major speed updates in importing of both client side and server side logs
   - If you disable the Progress Bar, import speed will be MUCH MUCH faster (On a 2.7 MB Server Log, it takes 120 seconds w/ the progress bar and 4 seconds without)
   - I will try to speed up the Progress Bar in future releases...It requires special programming called threading, though, which can be a pain
 - Modification support!!!!!
   - Included with this version of Tribal Logs is a serverdef.txt and def.txt with Insomniax support
   - To select a modification, choose the correct entry in the Modification list on the import dialog
   - For more information on creating modification definitions, see the help file
   - Btw, someone should complain to the Insomniax guys for making their sourcecode so ugly for people who want to look at it and AREN'T copying it...It was a pain getting all of the data I need...Ok...not THAT bad...but...
 - Server Side Team Kill Tracking
 - Tribal Logs Mod (TLogsMod for short, server-side only)
   - Insomniax 0.7, Base 1.3, and Base 1.4 included. Other mods will be added on request. Please note that all code I used is marked by a "TLOGSMOD" comment. It should be simple to add it to other mods.
   - TLogsMod allows you to track:
     - Objective Holding (like on Scarabarae)
     - Flag events (such as return, capture, and grab)
     - Enemy Base Destruction
     - Team changing (eliminates many TeamKill problems)
 - Greatly enhanced team tracking for server-side logs
 - Log import resume support. You can now continue parsing a log from where you last left off. Simply load the Tribal Logs database file and during import, select the Resume from Current Game option.
 - New Variable for Calculations and HTML Export -> MapsPlayed
   - Holds the number of maps played
   - New calculation added: AvgScore which is the players Total score divided by maps played

v0.7
 - Graphing! (Accessed from View | Graphs)
   - Currently you can graph Kills, Deaths, and Total Score
   - Graphs can be saved to disk as .BMP files
   - Comments on the graphing system would be greatly appreciated as I try to develop it
 - Internal storage systems reworked some
   - Old save files won't work!
   - Should provide various bug fixes and speedups, though
 - New HTML Help file
 - Fixed yet another MAJOR bug in Server side processing that didn't correctly handle people leaving servers. It made Tribal Logs think that a person who had already left was still playing after another person connected to the server and was given a server id that had already been used. *pant* Get that? =)
 - Better resume from existing database on import support (in both Import Log dialog and Autoexec Wizard - Import dialog)
   - Resume from start of log file (use this if, for instance, you rename your logs)
   - Resume from position last read from the file (use this if you allow the log to continuously accumulate, so you can import incrementally)

--- In Progress ---
Key:
 * = New in progress entry for this update
 - = Old in progress entry
 ! = Completed in progress entry

Entries:
 ! Totally reworked HTML Help file with more screenshots (done)
 - Program that queries Tribes servers and returns the data in HTML format. (75% done; Just need to add templates)
 - Multithreading during log import to allow a MUCH MUCH faster progress bar (5% done; basically in trial + research phase...and crash phase...lots of crashes =) )
 - Better team score tracking (Flag caps are tracked by player, not by team, and so when a player changes teams, he takes his score with him) (0% done)
 - Program that can dynamically generate player data HTML. Large server logs generate FAR too much player data to be able to make individual pages for each player during export. (0% done)
 * More graphing features (ongoing)

--- Thanks ---

I would like to thank the following programmers who contributed material to CodeGuru:
 - Zoly Farkas for his expression parser
 - Levente Farkas for his CStatusBarWithProgress class
 - Guy Gascoigne Piggford for his C++ version of the Regular Expression library
 - Iuri Apollonio for his CSortClass class

I would like to thank the author of GibStats, because his program inspired me to create my own. I also have used some of the GibStats calculations as described in the GibStats help file.

Finally, I would like to thank FireHawk, who was the very first person to send me a server log file. He has been a beta tester and bug hunter ever since.

--- Contacting the Author ---
WWW:	http://www.planetstarsiege.com/triballogs (or Help | Tribal Logs Web Page in Tribal Logs)
ICQ:	522886
E-Mail:	triballogs@planetstarsiege.com

--- Copyright ---
This document and the Tribal Logs program is Copyright (c) 1999 WegBert Developers and Chris Wegrzyn.