//////////////////////////////////////
Substats v1.0 - keep track of all those monster kills and killing sprees.

Written and tested by Unreality (Unreal Tournament iDOM/iCTF clan) - Visit us at #-<U>- on quakenet or http://www.clan-unreality.com/

Hope you enjoy!

-<U>-Subtractive
14/1/2004

//////////////////////////////////////
WHAT IS SUBSTATS?

SUbstats records the following information about each player and provides it on the scoreboard:

Number of Killing Sprees
Number of Rampages
Number of Dominatings
Number of Unstoppables
Number of Godlikes

Efficiency
Time since start of game
Ping
Packet Loss
Accuracy

Number of Double Kills
Number of Multi Kills
Number of Ultra Kills
Number of Monster Kills (only records one per monster kill, so double monster kill only counts as one)

Location

Threat Rating - this is calculated as follows:

If the game has not started, or the player has been in the game for less than 30 seconds, the threat is 'unknown'.
If the player's score is significantly higher than his kill count, the threat is 'lamer' - this player is likely to have had a large number of flag kills.

Otherwise the base threat rating is calculated as follows:

Threat = (0.7 x Efficiency) + (0.15 x Normalised FPH) + (0.15 x Normalised Accuracy)

where:

Normalised FPH = (FPH/600) x 100 i.e. the player's FPH as a percentage of 600FPH
Normalised Accuracy = (Acc/35) x 100 i.e. the player's Accuracy as a percentage of 35%

Players receive extra threat points for each killing spree and multi kill as follows:

Killing Spree	0.4
Rampage		1
Dominating	1.8
Unstoppable	3.2
Godlike		5.4

Double Kill	0.1
Multi Kill	0.25
Ultra Kill	0.45
Monster Kill	0.7

The player is then assigned a textual rating depending on their final threat score as follows:

N00B		0 - 42.5
COMPETENT	42.5 - 50
DANGEROUS	50 - 55
LIABILITY	55 - 60
PWNER		60 - 65
OMFG!		65 - 75
BOT?		> 75

The mutator should not cause any problems with pure or anything like that.

//////////////////////////////////////
INSTALLATION INSTRUCTIONS

1. Copy the substats.int, substats.u & substats.ini files into your server's system directory.
2. Open your UnrealTournament.ini file.
3. Find the section titled "[Engine.GameEngine]".
4. At the bottom of this section add the line: ServerPackages=SubStats
5. Restart your server and use your web admin or in game admin to apply the mutator.
6. NOTE: If you use the Admin Tool to remotely control your server, you must have installed substats to your local machine too.

//////////////////////////////////////
CONFIGURATION

To configure what substats displays, you can edit the substats.ini file. To turn something off, set it to false, an example set up is below:

m_bSprees=true
m_bMultiKills=true
m_bAccuracy=true
m_bEfficiency=true
m_bFPH=true
m_bPacketLoss=false

Setting Sprees to true will display the number of: Killing Spress, Rampages, Dominatings, Unstoppables & Godlikes a player has had.

Setting MultiKills to true will display the number of: double kills, multi kills, ultra kills & monster kills a player has had.

All the other options are self explanatory :)

//////////////////////////////////////
VERSION HISTORY

v1.0 - 14th January 2004

SubStats is finally unleashed on the world.  It has been successfully tested with pureRC6E and Windows v451 server. Please report bugs or make suggestions in our IRC channel!
	
Known Issues:

When going to sudden death CTF, time is calculated incorrectly presenting incorrect FPH values.
This release of substats has been designed for instagib only - it *does* run on nw servers too, but some values will not be calculated properly.