---------------------------
Welcome to FilterMsg!
---------------------------
Thank you very much for choosing FilterMsg. It is my hope 
that you enjoy using this script as much as I have enjoyed 
creating it. Below are a few instructions on how to use 
FilterMsg, customize its options, as well as some other 
goodies.

Thanks once again!
xgalaxy & Halide

---------------------------
Very Special Thanks
---------------------------
Without the following people this script would not be possible!

Halide's credits:
- BigWig, for helping with the awesome icons (Default set).
- Blaque, for sending me the new icons included in v3.0.
- TruSoulja, for the global kills idea.
- MikSchultzy, for the clan tag removal idea.
- Hypn0tik, for hosting T-U, and a place to download this!

xgalaxy's credits:
- LabRat, for providing scripting help to a noob!
- [AKA]PanamaJack, for giving me assistance and providing the 
ever cool PJSupport. (Previous Version)
- Wizard_TPG, for assistance and guidance :)
- Writer, for providing the community with awesome support 
scripts which will form the backbone of the scripting 
community!

And thanks to all the private beta testers I sent updated 
versions to to test and fix problems.

---------------------------
What is FilterMsg?
---------------------------
FilterMsg is a script that utilizes Writer's Support.vl2 
support scripts in which you, the user, can filter messages 
from the Chat Hud, and place them in another, more specifically 
the death messages. This is very usefull for a number of 
reasons. One being the ability to keep track of player death's 
and not have it interfere with important global and/or team 
messages that might otherwise be hard to read. FilterMsg also 
has LabRat's HudMover support. Many Tribes folks will recognize 
FilterMsg as being very similar to Vektor's SplitMSG for 
Tribes. Indeed it is, and with Vektor's permission I bring this 
script back to life with a new name for a new game.

---------------------------
Installing FilterMsg
---------------------------
1) Place the FilterMsg.vl2 file in your Tribes2\GameData\base 
folder (you should not unzip the files).

2) Start Tribes 2. Click on Launch -> Scripts -> FilterMsg

3) The options tab contains all of the options to customize 
FilterMsg to your needs.

---------------------------
The Options
---------------------------
1) Display FilterMsg Hud: Allows you to turn on/off the Hud. 
This does NOT turn on/off the filtering of the death messages.
With this option off, death messages will still be filtered, 
just not displayed at all, in the Chat Hud, or the FilterMsg 
Hud.

2) Transparent Hud: Makes the hud transparant (no background).
This is useful in that it allows you to see more of the
viewable playing field. It comes at a cost of lessening the
readability of the hud itself, especially on maps with snow.

3) Color Names: Colors the names of the players either 
red/green for either foe/friend respectively. This option does 
not affect the option 'Color Me Different'.

4) Color Me Different: Colors your name differently in the Hud 
death text. Any death events that involve you will have your 
name colored differently.

5) Mute Death Messages: Removes the death messages that you 
normally see in the Chat hud.

6) Time-Out Messages: After several seconds the messages will 
disappear. This can help minimize clutter if you are using the 
transparent background. It's also cool. :)

7) Scroll Messages Down: If enabled, the new messages will be 
added at the top, and the rest will scroll down. If disabled, 
the new kill lines will be added on the bottom, and the older 
messages will scroll up.

8) Display Global Kills: If enabled, ALL death messages
will be filtered from your chat hud and displayed in the hud.
If disabled, only death messages with you as the
killer/victim will be shown, with all other death messages
hidden from both the chat hud and the FilterMsg hud.

9) Remove Clan Tags: This option removes the player's clan
tag from their name to make the hud more compact and also
easier to read.

10) # Message Lines: Choose how many lines to display in the hud.

11) In-game key toggle: Set a toggle key under controls to 
toggle FilterMsg altogether.

---------------------------
Goodies
---------------------------
FilterMsg now supports custom icons! To create your own, check
out the FilterMsg.ico.cs file. You can use just about any size
icons, and customize the icon for each damage type.

Save custom .png icon files in your custom icon folder...
(Tribes2)/GameData/base/textures/FilterMsgIcons/CustomFolder

Then, create your own .ico.cs file (with a unique name) by using
the template provided. These files go in the FilterMsg folder.
(Tribes2)/GameData/base/FilterMsg

You can also package it in a .vl2 (zip) file which goes in the
"base" folder with relative paths.

The .vl2 file should have paths like this:
FilterMsg/CustomName.ico.cs
textures/FilterMsgIcons/CustomName/(icon).png

I would be glad to host custom icon sets on my website. :)

If you have any other questions, contact me!
<halide@popmail.com>

---------------------------
Thank You, Enjoy FilterMsg!
xgalaxy & Halide
---------------------------