BudHUD

____________________________________________________________________
BudHud beta2		-By: VéKTöR (thegecko@home.com)

Concept and original coding by: [QB]Vita (vitamax@mindspring.com)
____________________________________________________________________

BudHud - The last word in Buddy-Tracking Software :)

Requires: 	PrestoPack 0.93
		NewOpts 0.91 or better
		Supports Warpoints if installed

This readme comes in 3 distinct sections:
	1) Installing the script
	2) Setting up Script preferences
	3) Using the script in-game

In short, BudHud lets you easily waypoint friendly players, enemy players, flag carriers. It lets you keep
tabs on any buddies you may have online. It lets you dynamically add or remove buddies. BudHud can track
messages you may want to pay special attention to, and pop them up in a "pager" window, accompanied by a
sound to catch your attention.
____________________________________________________________________
	1) Installing the Script
____________________________________________________________________

To install this script, simply unzip the .zip file to your 
Tribes/Config folder (remember to include directory info :). Then
copy the .wav files to your Tribes\Base\Voices folder. These files contain
the sounds that get played when you receive a page, when a bud joins, drops,
or changes teams (explained later). If you want to use your own sounds, just
copy them into the Tribes\Base\Voices folder instead of the ones provided in
the zip file.
Next, unless you want to hear when other people get pages, or have other people
hear when you get pages (not recommended) you should rename all these files to
something unique, not likely to be used by other players. Use the following
guidelines for renaming:
	The name must start with "w"
	The name must end with ".wav"
	The name must be 8 characters of less, not counting the ".wav" part
Remember (or write down) the filenames you used, 'cause You'll need them later.
You should also probably write down/remember what the sounds will be used for
(ie write down which will be for page, client join, etc)

Then, add the following line to your autoexec.cs file (in the 
Tribes\Config folder). The line must be copied EXACTLY as shown and
should be somewhere at the bottom (at least after the line that says
exec("Presto\\Install.cs"); )

enter this line:
include("VeKToR\\BudHud.cs");

When you first go into Tribes you will need to go to the options menu. In NewOpts
(the Scripts tag) you'll find BudHud - prefs in the script list. You will see
a bunch of sounds in there - that's where you put your filenames. Follow these
rules for entering the filenames:
	DO NOT include the "w" at the beginning
	DO NOT include the ".wav" at the end

____________________________________________________________________
	2) Setting up Preferences
____________________________________________________________________
Note: I am working on a BudManager system to let you do all this EASILY through
      Newopts, so just bear with me on the somewhat complex set-up procedure.	

Next, you'll have to add buds and textscans (optional). To do this, look in the
Tribes\Config\VeKToR\BudHUDPrefs.cs file. You'll see sections to add data for
textscans, buds, custom bud sounds, and custom bud textscans.
I have provided some examples in the file, including examples on how to move the
popup HUD to where you want on the screen.

In order to keep the prefs file short and sweet, all instructions on how to enter
you info in the prefs file are in THIS readme - you may want to keep both the prefs
file and this file open at the same time. The prefs file can be edited with any
common text editor (I use notepad myself).

Here's a bunch of info on what each function used in BudHudPrefs does, and how
you should use it to make your initial bud list.

 ------------------------------------------
 BudHud::TextScan(%text, %bitmap);
 ------------------------------------------
This function adds a "text scan". Every non-server message you get from OTHER clients
(not yourself :) gets passed through these filters. If a match is found, the entire
message, along with the sender's name, an icon representing their team, and a custom
bitmap you define (optional) gets displayed on a little pop-up Tribes "pager". This
allows you to define custom messages that you want to draw special attention to.
Basically, you just enter a word or two (could be an entire phrase, though) that you
want to scan for. In the prefs file, place this phrase (in quotes) inside the brackets
of one of the BudHud::TextScan lines in the prefs file. If you would like a custom bitmap
to be displayed along with the text on the pager, enter the bitmap's name AFTER the phrase
you are scanning for. You must seperate the phrase and bitmap name with a comma.
As of yet, there is no list of built-in Tribes bitmaps that can be used with this function,
but I will be building one soon, and it will be made available to anyone who wants it :)
Although there are only a few spaces for BudHud::TextScan functions in the prefs file, feel
free to add as many as you want - just copy the function name exactly as it appears from the
existing lines.

Special use: 	If BudHud::TextScan is placed AFTER a BudHud::AddFriend call, the TextScan 
		defined will work ONLY for the buddy that you just defined in the line ABOVE
		the Textscan. For this reason, textscans that should work for ALL clients must
		be placed in the prefs file BEFORE any buds are defined.

 ------------------------------------------
 BudHud::AddFriend(%name, %partname, %prefletter);
 ------------------------------------------
This function adds a buddy to your list of online buds. There are two ways this function can
work.
First: Entire name scan.
Using this method, the player's name must EXACTLY match the text you enter here (although
upper-case letters make no difference). Partname must be 

• VEKTOR/BudHud.cs
• VEKTOR/BudHud.txt
• VEKTOR/BudHudDefaults.cs
• VEKTOR/BudHudMenus.cs
• VEKTOR/BudHudPrefs.cs
• VEKTOR/BudHudHelp.cs
• VEKTOR/gui/BudHudPref.gui
• VEKTOR/gui/budhudkeys.gui
• VEKTOR/wCHANGE_JOIN.wav
• VEKTOR/wCHANGE_PAGER.wav
• VEKTOR/wCHANGE_QUIT.wav
• VEKTOR/Waypoint.cs