                           ***************************************
                           *         Highlight Script v1.0       *
                           *           By SSJ4_Son_Goku          *
                           * Originally finished on June 6, 2004 *
                           * Edited and uploaded on July 6, 2008 *
                           ***************************************

***** INSTALL *****

To install this addon, unzip the folder and put it in your $mircdir (to find out what your
mircdir is type //echo -a $mircdir in any window). Then type
//load -rs $$sfile($mircdir.*mrc) in any window. Navigate to the highlight.mrc file. Done.
Right click anywhere to find the Highlight Options.

***** FEATURES *****

Ok, this script has a ton of features, so hopefully it has everything you want and more.

I will explain the features in the order they appear in the main dialog:

SETUP TAB

This is where you add the Networks and Channels you want the script to work for. For each
channel, you can specify which words will trigger a highlight for you. For example, if my
$nick was SSJ4_Son_Goku, I would add "ssj4", "goku" and "$me" to the list, as those are
the most common names people refer to me as. If my real name was Bob, I would probably
also include Bob. If I have a nickname with a few people, I would include that as well.
If you prefer, every channel can have completely different highlight-trigger words.

If you want to add another Network/Channel, you can either go to 
File -> Add/Delete -> ... Network/Chans or Right-click anywhere in mIRC and follow the
same path (Highlight -> Add/Delete -> ... Network/Chans).

This dialog is self-explanatory. Click Add Network to add a Network, and Delete Network
to delete a Network. Same thing with the channels. Again, you can specify your own set of
channels for each Network.

If you have the main Highlight dialog open while doing this, results will automatically
be updated. From here, you can either add words in the list to the right (using the +
button), go to File -> Add/Delete -> ... Words (same with the Menu), or double-click on
the list of words.

In this new dialog box you can add/delete words to each channel. Using Shift and Control,
you can highlight several channels to add the words to each channel at one time. You can
even add several words (also to several channel) at the same time by separating the words
with commas. Again, all the lists are updated automatically when making changes.

Finally, in the main Highlight dialog, you can remove words simply by clicking on the
word on the list and using the "-" button. Do note that if you remove the last word for a
channel, that channel will be deleted from the list on the left. If that was the last
channel in a certain Network, that Network will be deleted.


SETTINGS TAB

* Play Sound on Highlight
  -> Check this box and use the "..." Button to navigate to a sound file that should
     play automatically when someone highlights you. The rule for which files are
     acceptable is that if you can play them with /splay, the file is fine.

* Flash X Times with msg
  -> Simple. If mIRC is not your active Window when you are highlighted, mIRC will flash
     X amount of times with the specified Message in the Titlebar.


* Color text in <color>
  -> This makes mIRC color the highlighted word in the specified color. Especially
     useful for situations in which you are highlighted and can't figure out why (say
     your name is Alex and someone talks about Alexander the Great).

* Notify be Echo .. in active/target
  -> Just as it says. When you are highlighted, you can have it echo a specified message
     into your your active and/or the target window. Feel free to use $identifiers and
     colors in your Echo msg.

* Log on Highlight
  -> checking this will make the script write to a logfile (with either Strip'd Text
     and/or Prefixed Nicks, which you can specify) that you specify. The format is
     predetermined (for now) as follows:

------------------------- $fulldate ($chan/$nick)
$timestamp <nick> Message($1-)



ADVANCED SETTINGS TAB

* Place in editbox (if empty)
  -> If the editbox in your $active is empty, you can choose to place a line of text
     into your editbox. Useful for when you return from bathroom breaks (for example) and
     can automatically see if you were highlighted and when/where/by whom. Again, feel
     free to use $identifiers and color codes.

* Events
  -> Obvious. Select which events you want the script to trigger for.

* Match only whole words
  -> Checking this will only match whole words. If "test" is your highlight-trigger word,
     and you have this feature enabled, it will not match "TESTing". If you have this
     feature disabled, it will match "TESTing" and "asldkfjl;TESTsfdjkl" as well.

* Case Sensitive
  -> Obvious. If you enable this feature, the script won't match "test" "Test" or "TEST". 
     Disabling it will match "test" with "TeST", etc.

* Ctrl Code Sensitive
  -> Ctrl Code means bold/underline, etc. If you enable this "test" will not match a
     partially underlined "test". However, if the entire word is underlined, it will still
     match it. Disabling this will match it either way.

* Call Alias on Highlight
  -> Want to make your own script do something when you're highlighted? Make an alias for
     it and include it here. Example: hightlight.notify $nick $1-


That's all for the features.

If you right click anywhere in mIRC, you'll see that you can turn the entire script on/off if you want.


***** CONTACt *****

If you have any questions/comments regarding this script, feel free to e-mail me at
songoku1@gmail.com or send me a Private Message at mircscripts.org. You can also reach
me on MSN Messenger by using my e-mail as my username.