~~META:
creator       = Aikar
&description abstract = Performs various actions with the chat log including playing sounds when you are being spoken to.
~~
~~NOCACHE~~
====== ChatMon (1.5) ======


===== Plugin Information =====

^   Information  ^^
^   Developer:| [[:user/Aikar|Aikar]] |
^   Download:| [[http://windower.net/plugins/ChatMon.dll | ChatMon]]|
^   Download Count:| [dlcount]chatmon[/dlcount] |
^   Support:| [[http://www.windower.net/forums/viewforum.php?f=22 | Click Here]] |
^   Release Date:| April 28th, 2008 |
^   Changelog:| [[:plugins:chatmon/changelog | Click Here]] |

===== What is ChatMon =====
ChatMon is a replacement of the external program ChatMon. It plays sounds based on chat events in game that pertain to you. It will play a sound anytime someone says your name in linkshell, party, say, emote, or shout. It will play a sound when someone does a normal /emote to you. It will play a sound when someone examines you, and finally, it will play a sound when someone invites you to party.

You can also setup custom strings to play sound files on too.

You can also configure it to not play these sounds when the game is in focus (Only play them if your alt-tabbed). You may configure custom rules to bypass this setting on a specific basis.

===== Configuring ChatMon =====
==== Settings ====
Settings has 6 attributes that can be set to configure ChatMon. The 5 sound settings are the default sounds to play on those events, if not set or set to none, those events will only be usable with triggers.
   * **DisableOnFocus:** If this setting is true, ChatMon will not any sounds while the game is in focus, and only play them out of focus (when you are alt-tabbed to another window). This setting may be overrode with Triggers.
   * **TellSound:** Sound to play when someone sends you a tell. Valid Entries described below.
   * **ExamineSound:** Sound to play when someone examines you. Valid Entries described below.
   * **EmoteSound:** Sound to play when someone does an emote to you. Valid Entries described below.
   * **TalkSound:** Sound to play when someone says your name in chat. Valid Entries described below.
   * **InviteSound:** Sound to play when someone invites you to join a party. Valid Entries described below.
==== Triggers ====
Triggers are custom rules for playing sound files also. This can commonly be used for triggering sounds on commonly used nicknames for yourself.

Trigger has 1 reqiured attribute or text value:
   * **Sound**: <trigger Sound="Sound Entry Name"> or <trigger>Sound Entry Name</trigger> \\ \\ A sound file has to be specified for the trigger to work.

Additional Attributes, Anything specified here must match true to parse the trigger:
   * **Match**: Wildcard format for matching the message coming in. <trigger match="*mynickname*">Talk</trigger> ((Warning, do not do this trigger AT ALL! Read the Warning at bottom of this page about ALL type))
   * **NotMatch**: Wildcard format to make sure it does NOT match this format. <trigger match="*dre*" notmatch="*dream*">Talk</trigger>
   * **From**: Where the incoming message is coming from. ((Be careful when using ALL here combined with another mode. Read warning at bottom of page.)) <trigger from="Party|Linkshell|Say|Shout" match="*dre*" notmatch="*dream*">Talk</trigger>
       * Valid Entries are: Say, Shout, Party, Linkshell, Tell, Invite, Emote, Examine, All
   * **NotFrom**: Checks that the incoming message is not from these types. <trigger from="Party|Linkshell|Say|Shout" NotFrom="ALL" match="*dre*" notmatch="*dream*">Talk</trigger>.
       * Read notes below for using NotFrom="ALL"
==== Valid Sound Entries ====
There are 5 default sound files embedded into the plugin that you may use without having the file on your PC. They are listed below. If you do not want a sound to play, you may specify 'None' or delete the configuration line.
^  Sound Name  ^  Description  ^
|  Talk  | A female voice that says //You are being talked about.//  |
|  Tell  | A female voice that says //Incoming Tell.//  |
|  Examine  | A female voice that says //You've been examined.//  |
|  Invite  | A female voice that says //Party Invitation.//  |
|  Emote  | A female voice that says //Incoming Emote.//  |

Additionally, you may specify a FULL File path to a .WAV file to play instead of the defaults. YOU MAY NOT USE ANYTHING BESIDES .WAV. MP3 Support will NOT be added. There are plenty of MP3 to WAV converters.
==== Default XML Config ====
This file is automatically created upon plugin load if it does not exists. You can delete the file to restore it to this default.
<code xml><?xml version="1.0" ?>
<ChatMon>
	<settings
		DisableOnFocus="false"
		TellSound="Tell"
		ExamineSound="Examine"
		EmoteSound="Emote"
		TalkSound="Talk"
		InviteSound="Invite"
	/>
	<!-- Add Triggers below. The line below is a comment for an example -->
	<!-- Valid From entries: Say, Shout, Party, Linkshell, Tell, Invite, Emote, Examine, All -->
	<!-- match should not be used for Emote. Examine matches to Examiners name, Invite matches to Inviters name. -->
	<!-- <trigger match="*YourNickNameHere*" notmatch="*SomecommonMatch*" notfrom="Tell" from="Party|Linkshell" sound="IncomingTalk" /> -->
</ChatMon></code>


===== Usage =====

Load the plugin for the first time and the Default configuration file will be created. You may edit settings in **\Windower\Plugins\ChatMon.xml**. Once you have saved the file issue **%%//%%chatmon reload** to reload the file.
===== Notes =====
__**Note: **__ 2 Sound files may not play on the same event unless triggered by ALL Trigger. If you have a trigger set for Tells and the default IncomingTell triggers, your trigger rules will not be parsed, and the sound file set in TellSound will be used. If TellSound is not set, Triggers are parsed for the incoming type of Tell.

__**Warning: **__ ALL breaks this rule. All WILL trigger 2x sounds if 2 things match, so be careful when using ALL. ALL will also trigger if you make it match your characters in game name every time you send a message! IF your name is Aikar, making a <Trigger match="*aikar*"> is not a good thing to do.

__**Suggestion: **__ Highly recommended you use NotFrom="ALL" on ALL triggers based on chat messages. ALL should only be used for non chat related messages such as other chat log entries (Spell/ability casting etc.)