================
 Nc styler v1.1
================

Written by Spola_Crite
Credits go to Nycon for perfecting my oh so not perfect english


Contents of this zipfile: 

  nc_help.txt   = This file. (the manual)
! nc_styles.txt = Holds all your created styles.
! nc_system.mrc = Holds the script.

(don't delete ! files)

:What is this addon?

 This is an addon that styles (outgoing) nicknames. It is useful 
 in BIG channels where you wanna make sure a user sees what you 
 type. With "styling" a nick i mean this:

 You type: Freddy, how do you do?
 You get: =Freddy=, how do you do? (of course with colours etc...)

 More as styling the nickname, this addon provides you with the 
 Nick Style Creator studio, so you can create your own styles.

:Options
 
 When you use /nco you'll see a dialog popping up. It's rather
 self explanatory. I'll just explain it quickly to make sure 
 you get the point:

 triggers: Fill in the triggers here, (i use '=' and '+')
 style: the style that should be used.
 Colours: Some colours suck (sorry if i offended anyone). here
 you can select which colours will be selected when the #r# 
 token is used. (i use '4 1 2 3 5 6 7 10 12 13')
   HINT: not all users use white backgrounds, same for black.
         therefor, use colours that re visible on both white
         and black backgrounds.

:The nick styler creator.

 This nifty tool allows you to do whatever you want with a nick.
 it uses tokens (scripters note: not like $gettok etc...). if you
 have never used tokens...
    ...Then this is your first time =)

 it's simple, use a token anywhere you want, it will get replaced
 by a value.
 eg. the #r# token returns a random colour. so use #r# where -
     ever you want. 
     (small note, all the #r#'s get replaced by the same colour,
      if you want two colours, use #r1# and #r#. This goes up to
      #r10#)

 By selecting a different style index, different tokens will 
 become active. Styles that involve random things, will have a 
 (r) behind them.

 1. Normal
    No special effects.

    #nick# -> returns the nick that has to be styled.
    eg for freddy, =#nick#= returns =freddy=

 2. Two parts (r)
    Divides the nick in two (random) parts.

    #part1# return the first part
    #part2# returns the second part

    eg for freddy, -#part1#=#part2#- returns -fr=eddy-
    note that it might be better NOT to use visible
    characters in the middle, i use the middle for bold
    underlines and colours etc...

 3. One Random character. (r)
    Takes one random characer in the nick.
    
    #part1# returns the text before the char.
    #part2# returns the text after the char.
    #char# returns the char.

    eg for freddy, -#part1#|#char#|#part2#- returns -fre|d|dy-
    same note as style 2

 4. First and last letter.
    Uses the first and the last letter.
 
    #char1# returns the first char. of the nick.
    #char2# returns the last char. of the nick.
    #middle# returns the middle of the nick.

    eg for freddy, #char1# #middle# #char2# returns f redd y
    same note as style 2

:Additional notes using the Creator.

 - For random colours, use #r#, #r1#, ..., #r10#

 - Don't use colour indexes such as '1' use '01'.
   (if there are numbers in the nick, it'll get corrupted)
   Like say your nick is guest12345 and you get the (style 2)
   nc 4#part1#1#part2#, it would look like guest112345
   wich would make the second part in lightcyan, AND a 1 would
   be missing. I'm not sure if you got the point.

 - <current> is the slot in which you create your styles.
   When you click on another slot, you'll see it's code.
   if you return to the <current> slot, your style will still
   be there, this only works with the <current> slot.

 - Once again: DON'T use visible char's in the middle of
   a nick. also, don't use char's that can be used in a
   common nick next to the nick.
   (eg NOT e#freddy#d because it would return efreddye, and
   the point of this addon is to make it easier to see your
   nickname).

 - Backgrounds are not appreciated by everyone.

 - The basic styles are made to let you see how to use the creator.

 - Some channels (#helpdesk in dalnet) don't like it when to
   many control codes (crtl + BURK) are present.

:Additional notes using the addon in general.

 - You'll always have people who start their nick with a
   hard to get character (such as ^ or  etc...), instead of typing
   the first char, just type ?. 
   eg you're in a room with stupidnick and ^lamenick (trigger '=')
   if you wanna talk to stupidnick. use ????st= , if you wanna
   talk to ^lamenick use ?la=
   kewl eh =)

 - If i tell you this, you won't need my addon, ah well, Using [TAB] 
   completes the nick while it's in the editbox.

 - This addon ignores the following char's , ; . " ' ) ( !
   not ? because of the things mentioned in note 1.
   so when you're in a channel with freddy, you can use fr=,

 - All the styles included are made by me, my preference goes to
   "i just like it"

:Planned Improvements.

 - The #prefix# token to return @%+

 - If anyone knows a style index that could be added...

 - Support for more as one style - file. (nc_styles.txt here)

 - Support for author and description in a style.

 - A thingie to automatically send stylefiles to other 
   users and me (email)

 - A better way to enable/disable colours.

:What you can do

 - Make styles and mail 'em to me, they'll be added 
   in the next version

 - Tell other people about this addon

 - This addon is part of a (currently) unfinished script. 
   Download it as it becomes available.

:Contact

 - To mail me, please mail to Spola_Crite@yahoo.com
   respect the following rules:

 1. Don't use html coded emails, i can only read text.
    

 2. Comments:
     Subject has to start with "COMMENTS NC_STYLER_v1.1" 
     (without the "")

     - I like comments, so keep 'em coming as a way
       of saying thanks for the creation of this addon.

 3. Styles: 
     Subject has to start with "CONTRIBUTION NC_STYLER_v1.1" 
     (without the "")

     - with the new style fromat coming out in the next
       version, you'll be able to add your name yourself,
       for now, i'll just do it manually. You'll have to wait
       till the next version to state comments on a style.

     - If at any give time, you decide you don't want your 
       styles to be added to newer versions, mail me again,
       (with the same address, or specify some kind of
        password in the first mail.)

 4. Bug reports:
     Subject has to start with "BUG_REPORTS NC_STYLER_v1.1" 
     (without the "")

     - Bug reports will be investigated, and (if possible) 
       corrected. You will get some kind of credit in the helpfile.

   Please PLEASE follow these rules.



...