------------------------------------------------------------------------------------------------
* CTFHuD Version 1.4

  Released 6.14.00
  Scripted by Rayn // rayn@tribalwar.com
  Rayn's Bucket O' Tribes: www.tribalwar.com/rayn

  WWW.TRIBALWAR.COM - Your #1 Community Resource

------------------------------------------------------------------------------------------------

[Documentation Index]

  - Script Description
  - Hud Components
  - Key Bindings
  - Note on Waypointing
  - Script Requirements
  - Install Instructions
  - Changes Since the Last Release
  - Bugs / Contact

------------------------------------------------------------------------------------------------

* SCRIPT DESCRIPTION:

  CTFHuD is a heads-up-display script intended to increase your awareness within
  the game by showing vital information on your screen.  The primary goal of
  CTFHuD is to maximize this vital information while minimizing occupied screen space.
  The actual HUD is relatively small compared to similar HUDs and contains a few
  optimal features making it targetted at the CTF mission type, but still
  usable in other types of the game.

------------------------------------------------------------------------------------------------

* HUD COMPONENTS

  Team Score   : Displays the captures each team has made thus far.
  Team Size    : Displays the size of each team
  Flag Location: Displays the location of each team's flag (home/field/player)
		 If the flag is dropped in the field CTFHuD will display a timer
		 which will tell you when the flag will be automatically returned
		 to its home base.
  Kill Count   : Displays your kills on the left, and your deaths on the right.
  ScoreHUD     : Displays your current score (kills + caps - suicides/TKs) as well
		 as your personal flag capture count. Note that this score
		 HUD does not support MODs which award points for events other
		 than kills and caps. A future release may attempt this.
  ItemHUD      : Displays the status of your repair kit, as well as the count of
		 your mines, grenades and beacons. The icons will dim when you
   		 no longer have any of the respective items. The repair kit
		 is represented by a red cross. The mines, grenades and beacons
		 are represented by an M, a yellow grenade, and a beacon like
		 icon respectively.
  Objective    : On maps with one objects, the objective status will turn green
		 when you control the objective and red when the enemy controls
		 it. It will remain gray on maps that do not contain an
		 objective or if no one controls the objective.
  Waypoint     : Displays the status of the auto-waypointer. An arrow pointing
		 towards the green flag will indicate auto-waypointing to
		 an enemy flag grabber, while the arrow pointing towards the
		 red flag will indicate auto targeting of a friendly flag
		 carrier.

------------------------------------------------------------------------------------------------

* KEY BINDINGS

  Default key bindings are as follows:

  Control-H : Toggles HUD Display
  Alt-H     : Resets the HUD variables
  Shift-H   : Toggles through the auto-flag waypointing settings in the order
	      Off -> Enemy Flagger -> Friendly Flagger (and around)

  You can reconfigure these in the script or NewOpts (discussed below) This is
  not recommended.

------------------------------------------------------------------------------------------------

* NOTE ON WAYPOINTING

  The waypointer is just a shortcut from using the command menu, therefore you can
  only accurately waypoint enemies who would be displayed on the command map. That means
  the enemy must be in the visual range of one of your teammates or within the range
  of your sensors. If this is not the case, the waypoint will be inaccurate and point
  somewhere of the corner of the map.  If you set such a waypoint, and the targetted enemy is 
  sighted, the waypoint will auto-adjust itself to their last known location. Similarly,
  if the enemy is targetted and then moves out of sensor/visual range, the waypoint will
  remain at the targets last known location. Note that you will always get an accurate
  waypoint when targetting a friendly player.

------------------------------------------------------------------------------------------------

* SCRIPT REQUIREMENTS

  - Presto Pack v0.93 (http://www.planetstarsiege.com/presto)

    CTFHuD uses the event functions, the HUD functions, as well as the team and kill
    tracking functions in Presto Pack. People have asked why I write my scripts for
    Presto and the fact of the matter is that it is simply software reuse.  No need
    to reinvent the wheel as they say.  Presto is the accepted standard for scripters
    to use, and to deviate from this pattern would mean my script would cause other
    Presto compatible scripts to function, or cause my own not to work.  Just go
    Presto baby :)

   - Zear's NewOpts (http://www.planetstarsiege.com/zear) [recommended]

    NewOpts is useful in the configuration of your script without the messy
    editing of the actual script file.  I recommend you install this useful
    script so you can adjust which HUD components you want displayed with ease
    as well as set alternate HUD key bindings.     

------------------------------------------------------------------------------------------------

* INSTALL INSTRUCTIONS

    In order for your script to function properly all the included files must be
    placed in the proper directories.  If you unzip the ctfhudv13.zip file to 
    your Tribes/config directory with paths, the files should place themselves accordingly.
    If this is not case, the files that are included should go to the following locations:
    
    ctfhud.cs		- /tribes/config/rayn
    ctfhud.gui
    *.bmp		- /tribes/config/rayn/bmp

    Once the file is unzipped, add the following line to your tribes/config/autoexec.cs
    file at the bottom as shown:

    Include("rayn\\ctfhud.cs");

    You can then set the script options in Zear's NewOpts or by editing the
    options portion of ctfhud.cs (Not recommended, instructions are contained in the
    ctfhud.cs file if you must do this) Note that the 'Clear Waypoints after Flag Events'
    option is reversed, meaning that if you check this option the waypoints will not
    clear, that is to say that if your flag is returned home after an enemy takes it,
    that enemy will remain waypointed, useful in warning yourself about problematic
    would-be cappers. Unchecking this option will

------------------------------------------------------------------------------------------------

* CHANGES SINCE THE LAST RELASE

    Version 1.4 introduces the following:

	- Observer Mode Support: Now you can follow the action accurately in observer mode.
	- Flag Timer Bug Fixes: Code corrections should ensure that all users timers work.

    Version 1.3 introduces the following:

	- Finally: NewOpts support. Configure your script from your options menu!
	- Target Retention: Script no longer resets waypoints if a target drops
          and regains the flag. This was annoying when hiding enemies moved from
   	  sensor range and erased their last known location when they regained
	  the flag.
	- New Icons: Icons were redone for aesthetic purposes.
	- Team Size Bug: Some servers (mostly MODded) were causing the
 	  team sizes to be wrong. This should now be dealt with.

------------------------------------------------------------------------------------------------

* BUGS / CONTACT

   If you encounter what you believe to be a bug please thoroughly review this
   documentation for a solution.  If this does not help you may contact me at
   rayn@tribalwar.com. Between running Tribal War, and maintaining my scripting
   my e-mail is constantly full and a response may not be as timely as you like.
   Alternatively, you can usually find me on IRC in the Tribal War IRC channel
   on irc.dynamix.com in #TRIBALWAR. Stop on by sometime!

------------------------------------------------------------------------------------------------

