smart nickcomp 1.1
by cold (cold@brasnet.org) - http://cold.is.dreaming.org - #scriptx@irc.brasnet.org
made in mIRC 5.61, you can use in 5.7

(Enable the word-wrap and maximize this window)


.--+---------------[INDEX]
: 1: Introduction
: 2: How to install
: 3: How to uninstall
: 4: Configuring smart nickcomp
: 5: Configuring the styles list
: 6: Creating a style
: 7: mIRC's bug
: 8: Greetings
'--'


[1]----------------[INTRODUCTION]

Thanks for using smart nickcomp 1.1. This new version brings very much corrections, news and facilities. See the advantages of this version:

* Small size in bytes, with more user-friendly and velocity;
* Much more compatible;
* If you was using smart nickcomp 1.0: when installing this new version, you can IMPORT the styles and commands from that version :)
* Well.. better, easier and smaller than smart nickcomp 1.0, considering the quantity of news, improvements and corrections.

PAY ATTENTION SCRIPTER: IF YOU ALREADY USE AN EVENT **ON INPUT** THAT CHANGES THE DEFAULT FORM OF MIRC'S WAY OF SENDING MESSAGES, SMART NICKCOMP WON'T WORK AS IT SHOULD.
Doubts, suggestions or comments about this addon, send an email to cold@brasnet.org, subject "smart nickcomp 1.1", and wait a possible reply.


[2]----------------[HOW TO INSTALL]

You should install this addon in mIRC 5.61 or 5.7, NO OTHER.
Just unzip the file "smartnc11.zip" to any folder that doesn't use spaces (ex: c:\lala lala)

Then run mIRC and type: /load -rs c:\"smart-nickcomp-folder"\smartnc11.mrc
Then, choose "YES" on the window that appears next.
Done. "How to use" instructions will appear in the active window.

[3]----------------[HOW TO UNINSTALL]

Easier. To uninstall smart nickcomp, on mIRC, follow any procedure bellow:

A) Type /snc.unload
B) Open Status Window popup and select "smart nickcomp 1.1 > Uninstall"
C) On smart nickcomp general options dialog, click "Uninstall".


[4]----------------[CONFIGURING SMART NICKCOMP]

Here i'll explain each dialog items.

Options
* smart nickcomp enabled
enables/disables smart nickcomp, but doesn't uninstall it.
* Choose which nick complete if 2 or more are found
If more than 1 nick matches your nickcomp string, it asks you for which nick you want to complete on your command or your message. But, if your nickcomp string is exactly equal to any nick on the channel, the choice won't be done and THIS nick will be completed.

Search for the typed string
* In all parts of the nicks
smart nickcomp will search for your nickcomp string in ALL the nick. Example: if you type "ol: hi" and i(cold) be there, my nick will be completed, because it contains "ol".
* In the beggining of the nicks
smart nickcomp will COMPARE your nickcomp string with the BEGINNING of the nick. Example: if you type "co: hi" and i be there, my nick will be completed (because co = co -> cold). But if you type "awa: hi" and "cold-away" be there, my nick WON'T be completed (because col != awa)

Styles
* Configure
configures your styles list.
* Modify the actual style
opens the styles creator and load the actual selected style, to let you modify it.
* Create a style
opens the styles creator.

Activators
* Characters
define the nickcompletion activators. The characters ":", ";" and "," are default. So, to complete a nick, you could use "ni: hi", "ni; hi" or "ni, hi".
* Position
define the activator's relative position to the nickcomp string. Choosing "In front of the nick", you could use "ni: hi". Choosing "Behind the nick", you could use ":ni hi".

Commands
smart nickcomp lets you complete nicks also in your "/commands". Example: if you wanna /whois me.. instead of using "/whois cold", add the command "/whois" to the list and type "/whois co:".
ATTENTION: smart nickcomp completes ONLY the FIRST PARAMETER of the configured commands. If you add the command "/dcc" and use "/dcc send co:", it won't work, because "co:" is the SECOND PARAMETER (1st is "send").

* Add
adds a command to the list.
* Remove
removes a command from the list.
* Disable
disables the command completions.


[5]----------------[CONFIGURING STYLES LIST]

The styles list contains the styles that you configure, and some options that work with them, like "Use random styles", that lets mIRC choose a style to use when you type the string to complete.


[6]----------------[CREATING A STYLE]

The style structure of smart nickcomp consists in IDENTIFIERS, each identifier means a parte of the completed nickname or the message for him/her.

* The identifier &1 returns the 1st part of the beggining of the nick, which means the 1ST LETTER OF THE NICK.
* The identifier &2 returns the 2st part of the beggining of the nick, generally means the 2ND LETTER OF THE NICK or the 2nd plus the 3rd.
* The identifier &3 returns characters of the MIDDLE OF THE NICK.
* The identifier &4 returns the 1st part of the ending of the nick, generally means SOME LETTERS BEFORE THE LAST ONE OF THE NICK.
* The identifier &5 returns the 2nd part of the ending of the nick, which means the LAST LETTER OF THE NICK.
* The identifier &6 returns the message you send to the completed nick.

See an example of a structure that means "nickname: hi":
&1&2&3&4&5: &6

See it's identifiers now separated (like a table):
 _____________________
|&1|&2| &3 |&4|&5|: &6|
| n| i|ckna|m |e |: hi|
 ---------------------
See now a structure that means "(n)icknam(e); hi":
(&1)&2&3&4(&5); &6
 _________________________
|(&1)|&2| &3 |&4|(&5)|; &6|
| (n)| i|ckna|m |(e) |; hi|
 -------------------------

Doubts (*sigh*)? cold@brasnet.org, subject "smart nickcomp 1.1".


[7]----------------[MIRC'S BUG]

In some "mIRCs" (all 5.61+), the preview isn't showed correctly when the style contains ctrl+b (bold) in it's structure. This is a mIRC bug.


[8]----------------[THANKS]

Thanks to all the people who sent emails commenting smart nickcomp 1.0 :)
Also to all BrasNET friends (irc.brasnet.org) and to smart nickcomp 1.1 beta-testers: p0lux, Danie|_, Mafagafinho and Shark`. They fixed several bugs of this version :D

Have fun,
cold - @#scriptx