____________________________________________________________________
BudHud beta2		-By: VKTR (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 set to false (as it's not Part of
the player's name we're looking for). To use this method, simply find the BudHud::AddFriend
lines in the BudHudPrefs file. Insert their name (in quotes, again) inside the brackets. After
this, enter the word false (no quotes needed). Make sure the name and "false" are seperated by
a comma. Finally, you can customize the player's PREFERRED letter that will be displayed on the
Buddy menu In-game. Keep in mind that if two buds are trying to use the same letter in the same
menu, the second one's letter will be replaced by an automatically assigned letter or number. This
last bit is completely optional and can be left out if you want. If you choose to use a preferred
letter, it should go after the "false", again seperated by a comma.

Second: Scan for parts of a name
Using this method, BudHud will scan to see if a part of the client's name matches a specified bit
of text. For example, if you wanted to find everyone with "[TOP]" in their name, you should use this
method. Simply enter the text you want to scan for (in quotes) inside the brackets. Following that,
enter the word "true" (no quotes needed). This sets the partname option to true (since we ARE looking
for PART of a client's name, not an exact match of the whole thing). Make sure the text and the word
true are seperated by a comma. If you want to define a preferred letter, follow the steps outlined for
adding a preferred letter to the "Entire Name Scan" 

 ------------------------------------------
 BudHud::AddSetSound(%pager, %join, %drop, %changeteam);
 ------------------------------------------
This function defines custom sounds for one specific bud. Like the BudHud::TextScan function, it
must be placed directly after the BudHud::AddFriend it's supposed to apply to. Simply make the
following substitutions. Remember that all .wav files must obey the rules described above (ie no
"w" on the front, no ".wav" at the end)
replace %pager with the name of a .wav file you want to play when this client pages you
replace %join with the name of a .wav file you want to play when this client joins the game
replace %drop with the name of a .wav file you want to play when this client disconnects (drops)
replace %changeteam the name of a .wav file you want to play when this client changes teams

make sure all the wav file names are in the proper order (yes, order matters) and that they are
all seperated by a comma. If you want to leave a .wav file as it's default value, just enter
two consecutive quotes (like this: "") in place of a .wav file name.

The remaining functions are relatively simple, and have been briefly explained in the Prefs file.

____________________________________________________________________
	3) Using BudHud
____________________________________________________________________
BudHud uses a NewOpts interface. Before you start playing with BudHud, you should go to the options
menu and set your prefs and keybinds for BudHud. After this had been done, you should be ready to
start playing Tribes with BudHud. There are several useful features accessible from the BudHud Main 
Menu. They are described below:

Waypoint Friendly - set a waypoint to a teammate of your choice
Waypoint Enemy    - set a waypoint to an  enemy of your choice. Note that the enemy has to be
		    visible to another teammate or your team's sensors to get an accurate waypoint.
Waypoint Buddy	  - set a waypoint to any buddy on your bud list (enemy OR friendly). This is a quick
		    way to find buds, without going through the friendly/enemy menus and searching for
		    them.

Waypoint Friendly Flag Carrier - sets a waypoint to your teammate carrying the enemy's flag.
Waypoint Enemy Flag Carrier    - sets a waypoint to an enemy carrying your flag.

Clear BudHud Message Queue     - Deletes all messages from the pager, and clears any messages waiting
				 to be displayed.

Pager Mute Menu	  - Keeps track of the last 6 clients who have paged you. If you mute a client, you
		    will NOT receive any pages from them until you restart Tribes or remove the mute
		    using the "Remove mute" menu (which appears under the pager mute menu)

BudHud Options    - Lets you toggle Pager popups and pager sounds on/off, and gives you a few more
		    menus to play with:

Add Buddy Menu	  - Lets you dynamically add buddies In-game. If you come across someone you'd like to
		    "remember" as a buddy on a server, you can add them from within the game itself.
		    You will be prompted to add to either your "Permanent Buddy list" or "Temporary
		    buddy list". The permanent bud list is saved to disk every time you exit Tribes,
		    so the buddy will be remembered between sessions. Temporary buddies are deleted
		    every time you quit Tribes, and are useful for remembering players on public servers
		    that you will likely not see again.

Remove Buddy Menu - Lets you PERMANENTLY remove either temporary or permanent buddies from your Bud list.
		    due to certain limitations, you can't remove any buds that you defined in your prefs 
		    file. After a buddy has been removed, he is deleted from your lists, and will NEVER
		    appear as a buddy again until you re-add him to your bud list.

Ignore Buddy Menu - Lets you TEMPORARILY ignore a buddy in-game. When you select ignore buddy, any join,
		    drop, or changeteam messages involving that player will be supressed, and he will not
		    appear on your buddy menu. The ignore status of each bud is removed when you exit Tribes.
		    This is useful if someone who has the same name as a buddy (or who matches a "part-name"
		    scan) is being registered as a buddy, and you don't want them to be.

Warpoint Location - This is BudHud's preliminary Warpoints implementation. As of yet, there
		    is no sound accompanying the waypoint you set, and the waypoint text looks
		    very uninformative (like "base" or "flag"). This will be improved upon in
		    the future, but remember... this IS a beta release!

Additionally, the following options are available:
	Buds Online: 	Displays a color-coded list of all your Buds who are connected to the server you are
			playing on. It toggles a box listing all online buds on or off. The names of these buds
			are color-coded. White buds are on your team, dark-brown buds are on an enemy team.

	Dropped Buds:	Works much like Buds Online. This command displays a box listing the last 15 buds who
			dropped from a server.