***************************************************************			

                        ObserverHUD ver 0.60			      
			
***************************************************************

FIRSTLY:
Sorry about the length of this readme but if I dont tell you how to use this HUD properly you will all be messaging me with queries ;)  It does a HEAP of stuff so please read the whole readme before you use this HUD.


ABOUT OBSERVERHUD:
ObserverHUD was designed primarily for the use of shoutcasters but is also great for refs and anyone who enjoys looking at game stats.  It is designed to be lag free and gives you just about everything you could possibly want to know about a match.  The ObserverHUD huds are only active whilst in Observer Mode so do not intrude on your gameplay at all and, due to the fact that ObserverHUD does no message parsing at all (unlike T1 stats recorders) it will not slow your system down :)


WHAT DOES OBSERVERHUD DO?
It does a number of very handy things.
1) It allows you to easily define hotkeys to players in game to observe them quickly.
2) It allows you to observe the flag carriers at the touch of a key.
3) It allows you to cycle through a teams players.
4) It can auto-observe flag carriers on flag grab.
5) It has an extremely comprehensive list of team and player stats.
6) It outputs the match stats to css compatible html file (if you choose) at mission end.  Even if you have been playing and not observing! (Great for clanners who want stats on every player that participated!)
	

SPECIAL THANKS:
Cowboy - Cowboy wrote and designed the css and html code and layout.  This guy forced me to write and rewrite many parts of this HUD until it was perfect where I would nomally have done things the easy way (and it wouldnt have been as good).
PanamaJack - Without this guy this HUD would be only a fraction of what it is.  Many thanks PJ
ShoutCasters - Many thanks to the 'casters from ATN, TSN and WSBN who helped test and develop this HUD.  Without you guys and your feedback this HUD wouldnt exist.
T2Scripters - Thanks to everyone at T2Scripters for all the help and support
Beta Testers - You know who you are.  Thanks guys
Dynamix - What a game! :)
			

NOTES ABOUT OBSERVERHUD:
- ObserverHUD is totally HUDMover Compatible - I would strongly suggest grabbing it.
- The KeyBinds you set in ObserverHUD are only active in Observer Mode and will not effect your gameplay keys
- When installing ObserverHUD over a previous version of ObserverHUD, just overwrite the existing version.



INSTALLATION:
1) Ensure you have the file support.vl2 installed (ie. put it in tribes2/gamedata/base directory)
2) Put ObserverHUD.vl2 in your tribes2/gamedata/base directory (Do NOT extract either support.vl2 or ObserverHUD.vl2.  Just simply place these two files, as they are, in your tribes2/gamedata/base directory.)
3) Run tribes 2 and from the menu, select "Scripts".
4) Edit ObserverHUD GUI as you see fit
5) Play T2 and go to observer mode



UNINSTALLATION:
1) Turn off your computer, unplug your monitor and drop it on yourself. (FOOL! Why you wanna uninstall this!!!  lol)
2) Delete tribes2/gamedata/base/ObserverHUD.vl2
3) If you wish (optional), delete tribes2/gamedata/base/prefs/ObserverHUDPrefs.cs



GUI DETAILS & INSTRUCTIONS:

MAIN

Enable ObserverHUD HUDs
	Toggles all HUDs off if disabled.
Enable Team Stats HUD
	Enable or disable the display of this HUD
Enable Game Type Stats HUD
	ditto
Enable Player Stats HUD
	ditto
Enable Quick View HUD
	ditto
Enable Ping/PL Updates
	Enabling this option will update the ping/pl statistics of every player every ten seconds.  Enabling this option may cause some lag for modem users, shouldnt bother cablers though.  (If you get what looks like bad PL when playing then try disabling this feature)
AutoView Any Flag Carrier
	When some grabs a flag you will automatically observe them.
Team 1 Flag Carrier Only
	As above but it will only auto-observe flag carriers from team 1
Team 2 Flag Carrier Only
	As above but for team 2 carriers
Dont Auto View
	Normal observing mode.
SET DEFAULT KEYS
	Press this button to bind all the default ObserverHUD keys


HTML SETUP

Team 1 Clan Name
	Optional output of clan name as well as team name in html output (if left blank then team name only will show up)
Team 2 Clan Name
	As above
Max Players per Team
	If the number of players per team is known for a match they can be set here, otherwise the HUD will determine the max by itself.  This value is used when calculating the team's time % (refer stat descriptions below)
No Stats Output
	Dont output stats to html on mission end
Prompt for Stats Output
	Prompt for stats output to html on mission end
Auto Stats Output
	Automatically output stats to html on mission end
Output Stats on Disconnect
	Output stats to html if you disconnect from a game mid-game.
Ingame html output frequency
	Enabling this will allow ObserverHUD to output stats at x second intervals to a web directory for current ingame-stat output to shoutcast listeners. (Output of stats may cause a slight cpu lag on slow machines)
Ingame html output filename
	If a filename is placed here, the ingame output will always be outputted into this same file and will be overwritten at each output.  If you write "bla" then it will output to /base/ObserverHUD/bla.html.  If this option is left blank it will output as MapnameX.html.  eg.  Katabatic5.html


HTML FORMAT

Generate css in-line
	Enabling this option will create a single html file with the css colour scheme included in the file.
Generate seperate css file
	Enabling this option will create a html file and a css file.  This enables you to change the css file at any time later to easily alter colour schemes for your whole site!.  If you disable this option it will build the colour scheme data into the html file.  I strongly suggets you use the css file option.
Output Server Details
	Output all the stats in relation to the server
Output Team Details
	Output all the stats in relation to the teams
Output Player Details
	Output all the stats in relation to each individual player.
Colour Scheme
	Pick the colour scheme you would like for your html.  To add extra colour schemes to ObserverHUD read the topic relating to it below.
Main Html Table Width
	The width of the main html table.  The default is 600.  This value can be entered as an integer or as a percentage.  eg.  600  60%
APPLY CHANGES:  Save changes to your prefs file and activate changes



WHEN USING HUDMOVER WITH OBSERVERHUD

When using hudmover, place all your huds in the locations you wish them to remain in then save the positions in hudmover to something OTHER than default.  This way if problems occur, you can easily reload your positions.



DEFAULT OBSERVERHUD KEYS:
1-0: Quick view slots 1-0
Ctrl 1-0: Set quick view slot value to currently viewed player
o: Enable/Disable ObserverHUD
n: Enable/Disable Team Stats HUD
g: Enable/Disable Game Stats HUD
p: Enable/Disable Player Stats HUD
q: Enable/Disable Quick View List
l: Enable/Disable Player Details HUD
,: Observe current team 1 flag carrier
.: Observe current team 2 flag carrier
[: Observe previous team 1 player
]: Observe next team 1 player
;: Observe previous team 2 player
': Observe next team 2 player



ADDING EXTRA CSS COLOUR SCHEMES

This is a very simple process to do.  
1) Create a file  /base/wizard/observerhud_custom.cs
2) Put your custom css file in /base/wizard
3) Add a line like this to observerhud_custom.cs    
        AddCSSScheme(%name, %filename);
   eg.
        AddCSSScheme("Orange", "obshud_orange.css" );
4) Select your custom colour scheme from the Combo box in the GUI
   THATS IT...SIMPLE HUH?
   


STATS THAT MAY NEED EXPLAINATION

Team Time:
	This stat is determined by totalling all the players game time for that team and dividing it by the max players.  eg. In a 10v10 match, if a team has 10 players for the whole match their percentage will be 100% but, if they lose one player halfway through their percentage may only be 95%.  Likewise, if a team accidentally has an extra player in the match their percentage might be 110%.  It is a good indicator of effective team time.
Max Players
	The maximum number of players that was on this team at one time.  eg.  If one team has 10 players, and PlayerA leaves and then Player B joins, this team still only has a max players of 10.
Suicides
	If you kill yourself with a disc launcher this is counted as a suicide.
Deaths by Other
	Lava, Vehicle Pad Deaths, Lightning Strikes, Team Changes, etc
	


MOD SUPPORT	

If you are a modder and would like support written in to ObserverHUD for your mod, please contact me.  If you play a mod that ObserverHUD does not have any support for it will just use the base weapon lists.



FUTURE IMPROVMENTS AND KNOWN BUGS:
- Cap Time Stats HUD
- Custom Headers and Footers



VERSION HISTORY:

Version 0.61:	Major html improvments
		Prev and next team player buttons added
		Player kills/deaths details hud added
		Full html css support added.
		Multiple colour schemes added
		Intergame html output added
		Fixed bug with hudmover hud settings
		Fixed bug false PL bug after x maps

Version 0.30:	Many display and code bugs fixed
		Pings and PL shown for players
		Prev and next team keys removed
		html output tweaked and bug fixed
		Recording of players scores added

Version 0.21: 	Several bugs in next/prev team player view fixed

Version 0.20: 	Stat output in html format added
		Keys for prev and next team player added
		Bug fixed where QV list had no player name was usable
		Disabled Auto-Flag Carrier view if already viewing flag carrier

Version 0.10: 	Original Private Beta Release



DISCLAIMER

Although every effort has been made to make ObserverHUD totally accurate, factors (lag, scripts, and murphys law) can often interfere with its operation that can cause discrepincies in recorded stats.  ObserverHUD is designed as a guide only and, as such, should not be considered 100% accurate. (Although I would like to think 99% ;)
