MultiMessage v2.1.1

-----------------------------------------------------------------------
                  MultiMessage+ ver. 2.1.1 Readme
                        by the Kiln Quad
               Email: [email redacted]
-----------------------------------------------------------------------
-------------------
New to this version
-------------------
Nows supports character specific plug-ins. Expanded Sniper insult code.
Flood protection enhancements.

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

This script is (IMHO) the ultimate in auto chat message scripts. It
contains the following features:

Presto script banner (to massage our swollen egos).
On\Off toggle! Default keys are Ctrl+Tab, MultiMessage is *ON* by 
	default.
On screen status pop-up window that displays the name of the current
	plug-in in use.
Message Script plug-in support and plug-in auto-detect.
It thanks people who repair you.
It apologizes for causing team damage
It tells your teammates to watch their shooting when they damage you
	and acknowledges the apologies of other MM users (and some
	who just use a TeamDamage message script).
It alerts your team when you begin and complete repairs to anything 
	other than yourself and changes your icon on TeamHUD to reflect
	your actions.
It alerts you team when the power is out when you try to use an 
	unpowered ammo or inventory station.
It annouces when your are placing deployables and changes you TeamHUD
	icon to reflect your actions.
It alerts your team when you grab the enemy flag (with a delay, just in
	case you get creamed in the first few seconds after you grab
	it).
It cheers 50% of the time when your team scores a cap, cheer is 
	detrimined randomly.
It cheers 100% of the time when you personally score a cap.
	BOTH cheers are yelled on a slight delay to avoid overlapping
	Tribes cap sound.
It alerts your team when your flag is taken.
It scoffs at snipers who kill you.
It gives a random taunt when you make a sniper kill.
AND it does it all with flood protection (where needed)!

FlagAnnouce concept courtesy of Crunchy. For full credits view the
script itself.

This script requires the Presto Pack and the newest version of
Zear's NewOpts. 

Presto’s site: http://www.planetstarsiege.com/presto/
Zear's site: http://www.cetisp.com/~thammock/scripts/

----------------------
Explanation of Options
----------------------

MultiMessage on at start.: This allows you to set MultiMessage to be on
	or off by default.
SniperMessage on.: Allows you to turn off the sniper portion of Multi-
	Message, if you don't snipe why have it on?
DeployAnnouce on.: Allows you to turn off DeployAnnouce, if you aren't
	the defensive type MM might as well spend it's parsing time
	else-where.
TeamDamage Messages on.: Allows you to turn off the team damage
	messages, if you only play on servers that have team damage
	turned off (WHIMP!) you might as well turn off this feature
	too.
Flag Cap cheers on.: Allows you to turn off cheering on your team's
	caps.
Flag announcements on.: Turns off the "I have the flag" message.
Repair announcements on.: Turns off the "Making reapairs to..."
	messages.
Save Prefs: Saves your current settings to disk, MultiMessage will 
	automaticly load your saved settings next time you play.
	
------------
Install info
------------
To install just unzip to your Tribes\config directory. If you have a
previous version of multimessage installed we ask that you remove it's
include line from your autoexec.

Message script plug-ins must be placed in your Tribes\config\Kiln
folder for MultiMessage to take advantage of their features. To get
MultiMessage to make use of the added sounds in the Ruthless Design
Sound Pack you must edit the rd sound plug-in (the file named rd.ms.cs
that's located in your Tribes\config\Kiln directory), editing
insructions are contained within the plug-in itself, open it useing any
text editor.

For details on how to create character specific message plug-ins view
the MultiMessagePlugins text file.

-----------------------------------------------------------------------
		          MultiMessage 2.1.1
			Plug-in Documentation
               Plug-in design and Docs by [ARX]NecroMaster
                    [email redacted]
=======================================================================
===============================
What is a MultiMessage Plug-in?
===============================
A multiMessage plug-in is a basicly a tiny script file that tells
MultiMessage what messages to use for what messageing functions and
what sound (if any) to use with each message. This allows sound pack
designers and players to easily add their own special messages and
sounds to MultiMessage.

=====================================
How do I make a MultiMessage Plug-in?
=====================================
You can take a look at any of the sample plug-ins included with 
MultiMessage to see how this is really done. Basicly speaking each
message is assigned a catagory and a number within that catagory, the
catagory is then given a number that's equal to the total number of
messages in the catagory.

------------------------------
***Example: this is copied from the rd sound packs plug-in.
------------------------------
$TeamDam::Total = 4;
$TeamDam::Message0 = "Watch where you're shooting!~wwshoot3";
$TeamDam::Message1 = "HEY!  What did I ever do to you?~wdotoyou";
$TeamDam::Message2 = "Watch it with that thing!~wwatchit";
$TeamDam::Message3 = "You're a step away from a boot call.~wpissme";

The catagory here is $TeamDam, these are the messages used when a
player is injured by his own team. Message number assignments HAVE
to start from zero and go up. Sounds are added to the text of the
message itself with a ~w before the sound file's name.

--------------------------------
***Example: In $TeamDam::Message3 we used the sound named pissme, to
use that sound we added ~wpissme directly to the text of the message
itself. 
--------------------------------

ALL catagories MUST be listed in a plug-in, whether you are useing them
or not. If you choose not to include changes to a catagory in your
plug-in just change the Total value to 0, this will cause  MultiMessage
to skip that section of your plug-in and use it's default messages
instead.

==================
Plug-in File Names
==================

Plug-in files have to have the same name as the sound pack for which
they were made for MultiMessage to detect them at runtime. By same
name I'm refering to the name they have when a player chooses their
voice set from the player configuration menu within tribes, NOT the
name of the volume the sound files are stored in. If you look in the
Kiln folder in your Tribes\config folder you'll see many plug-ins
that are included with MultiMessage, one default plug-in for each of
staderd voice sets that come with tribes and the RD/RuthlessD plug-in,
each of them is a perfect example of how to name you plug-in files.

--------------------------------
***Example: The default plug-in for the male1 voice set is named
male1.ms.cs
--------------------------------

Character specific plug-ins are named exactly the same way, accept
instead of being named after a voice set they have the same name as
the character they have been created for.
--------------------------------
Example: ArxFornax's message plug-in file name is ArxFornax.ms.cs
--------------------------------
Special Note: Character plug-ins override sound pack plug-ins, if
MultiMessage finds a character plug-in for your character AND a plug-in
that matches your voice set it will use the character plug-in.

All plug-in file names must end with .ms.cs for MultiMessage to
auto-detect them. The ms identifies the file as being a message script
file, the cs is used for all Tribes script files.

That's all there is! The only thing left to say is: please, if you make
a plug-in you'd like to share with community, email me a copy at the
Kiln. We're going to try and maintain a database of all the
MultiMessage plug-ins worth downloading on our site.

mailto: [email redacted]

• MultiMessageReadme.txt 4.0 KB
• Kiln/GUIs/multimessage.gui 4.5 KB
• Kiln/support/Events.cs 10.1 KB
• Kiln/support/event.cs 13.4 KB
• Kiln/support/flood.cs 1.5 KB
• Kiln/support/include.cs 7.7 KB
• Kiln/support/inventory_table.cs 9.7 KB
• Kiln/support/version.cs 5.6 KB
• Kiln/kilnmultimessage.acs.cs 30.1 KB
• Kiln/rd.ms.cs 5.0 KB
• Kiln/male1.ms.cs 1.3 KB
• Kiln/male2.ms.cs 1.3 KB
• Kiln/male3.ms.cs 1.3 KB
• Kiln/male4.ms.cs 1.3 KB
• Kiln/male5.ms.cs 1.3 KB
• Kiln/female1.ms.cs 1.3 KB
• Kiln/female2.ms.cs 1.3 KB
• Kiln/female3.ms.cs 1.3 KB
• Kiln/female4.ms.cs 1.3 KB
• Kiln/female5.ms.cs 1.3 KB
• MultiMessagePlugins.txt 4.1 KB