SquadMsg
Version 1.2 Beta
By: Kong98 (Kent M)
Date: July 8, 2001
E-Mail: kentm98@yahoo.com
www: http://www.geocities.com/kentm98

Overview
--------

The SquadMsg HUD is a new message HUD that only displays messages
from the people you specify.  It will keep you from missing important
messages from your squad-mates.

This is useful for:

    - Working in small or medium sized teams.
    - Bombers - Pilot won't miss the tailgunner's "I'm out of flares"
      message.
    - If you use a Command-Circuit "War Wizard", you won't miss his
      messages!
    - Catching messages from friends in Pub servers.


Installation
------------

1.  Put SquadMsg.vl2 into your Tribes2/GameData/base directory.
2.  Start Tribes2, and to to Settings->Controls.  A key option has
    been added: "SquadMsg Options".  Setup a key for this.


Uninstallation (But why would you want that?? :)
------------------------------------------------

Delete File:  GameData/base/SquadMsg.vl2
Delete File:  GameData/base/scripts/autoexec/SquadMsg.cs.dso
Delete Directory: GameData/base/SquadMsg


Options
-------

Once you start the game, press the key configured in step 2 above.
This will open the SquadMsg Options HUD.  You can configure a
number of options here:

Display SquadMsg HUD
    - Should the SquadMsg HUD be displayed?

Transparent HUD
    - Should the SquadMsg HUD be transparent?

Expand HUD up
    - When you add lines to the HUD, should they be
      added to the top or the bottom?  If you put SquadMsg in the bottom
      of the screen, this should be on.

HUD Position (x y)
    - The x,y coordinates where the HUD should be placed.  I recommend:
            640x480:  "1 352"
            800x600:  "1 472"
            1024x768: "1 642"

Hud Width
    - The width of the HUD.  I recommend leaving this at 500.

Number Of Lines
    - The number of lines of text to display in the hud.  This will
      automatically update the height of the hud.

Filter Lists
    - You can configure up to 5 filter lists.  Each list must be a
      comma separated list:

            Bill,Ted,GrimReaper

    The toggle button in front of the list is used to indicate which
    filter list you want active.  When you select a different list, the
    old list is ignored, and the new list is filtered on.

    ** NOTE: Don't put spaces between the names, and the names _are_
             case sensitive.  "Kong" is not the same as "kong".

Save
    - Save the changes so they appear the next time you run Tribes.

Close
    - Apply the changes to the current game, but do NOT save them.


Known Bugs and Features
-----------------------

1.  The transparent setting is not applied until you go to the command
    circuit or game menu screen.  I don't know why it does't get applied
    when I re-display the HUD.

2.  The HUD text disappears when you type a team or global message.  It
    will re-appear when you print a message, or the next time a message
    is displayed on the HUD.

3.  This script does NOT work with PanamaJack's SuperChat enabled.
    PanamaJack changes the default behaviour of the message HUD, and this
    blocks out SquadMsg.  You'll need to disable SuperChat before using
    SquadMsg:
        a) In the SuperChat options, disable all the HUDS. (Team, Enemy, Death)
	b) Then disable SuperChat
	c) Restart Tribes


Future work
-----------

1.  Add a scroll-back feature similar to the main system chat.
2.  Allow user configured colors and fonts.


Thanks To...
------------

Robert Blanchet (xgalaxy) for his FilterMsg.  SquadMsg was originally
based off of this script, but has had major modifications since then.
    http://www.planettribes.com/depot/downloads/view.asp?id=113

PanamaJack for his amazing scripts.  I used SuperChat as a reference to
implement the message vector.
    http://www.planettribes.com/pj/

Writer for his support scripts:
    http://www.planettribes.com/depot/downloads/index.asp?db=t2&Action=ShowScript&ID=60
