/ScriptServ

_______________________________________
readme.txt File For Antoshi Note System|
©2005				       |
¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯|
¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯

Thanks for downloading this fun & simple note system by Antoshi! :D

------------------------------
Version History:
v1.2
- Problems concerning the new popup menu to turn functions on/off fixed.
- /newnote and !newnote commands added
- /total & !total message changed from active window to channel.
- Also added !commands and !help for confused outside users.

v1.1
- Added /total
- Added !notes command
- Added !addnote command
- Added !total command
- Added Flood Protection (floodprotect.mrc)
- Fixed an error
- ANS can now be turned on and off
- !addnote command can also be turned on and off
- Notes can now be viewed and edited via /editnotes or through Channel Popup

v1.0
- First version
- All main commands created: !note, !search, and user commands, etc.
------------------------------


First-time Setup:

Once the notelogger.mrc file & floodprotect.mrc file are in your
main mIRC directory, run mIRC and type " /load -rs notelogger.mrc "
in the server window. Click OK when it asks you if you want to run
the initialization commands, and you're ready to go!

Upgraders:

With mIRC open, type " /unload -rs notelogger.mrc " and
" /unload -rs floodprotect.mrc ". Overwrite the existing notelogger.mrc
file in your directory with the new one, and overwrite the existing
floodprotect.mrc file in the directory with the new one. Then type
" /load -rs notelogger.mrc ", Click OK at the prompt and you're ready
to enjoy the new features of the upgraded version! (The floodprotect.mrc
file will automatically load so you don't have to worry about it. :P)

Now, let's explore the commands!


User Commands:

/note (number)

When you input the command, it will read the note in
the notes.txt file with the line you specify.
Ex: " /note 15 " will return the 15th note.

/search (keyword) (line to start from)

This command allows you to search for keywords, and, if 
applicable, a line to start from.
Ex: " /search Bob " will return any note with "Bob" in it, even
if it is inside another word, like "Thingamabob".
"/search Bob 15 " will search for any note with "Bob" in it,
starting from the 15th note.

/addnote (text)

This command will add notes to your text file. It will also add
a number next to it, to show you how many notes you have so far,
and to keep it in sequence.
Ex: " /addnote <Bob> Haha, me so funny! || <Tim> No, you're not. "
That will add the text to the next note. If it is the first note,
for example, it will show up afterwards with a "1." next to it.
So, when you use " /note 1 ", it will return
"1. <Bob> Haha, me so funny! || <Tim> No, you're not. "

/total

This command will show the total number of notes logged in your
notes.txt file.

/editnotes

This command will open the notes.txt file, allowing you to change,
rearrange, modify or delete your notes. This command can also be 
accessed by right-clicking a channel window, highlighting "Antoshi
Note System", and selecting "Edit Notes."

/newnote

This command shows the newest note added to the notes.txt file. The
new note is copied to a new text file called "newnote.txt".


Outside User Commands:

!note (number)

Works the same as " /note (number) ", except your friends
and other people can use it.

!search (keyword) (line to start from)

Works the same as " /search (keyword) (line to start from) ",
except your friends and other people can use it. You don't
need to educate them on how to use it, if they make a mistake
it will give them a notice telling them they can't do that.
Like, if they tried " !search I am ", it will tell them
how to properly use the command. Just be sure to tell them
they can add a line to start from after their search query. :P

!addnote (text)

Works the same as " /addnote (text) ", except your friends
and other people can use it. Also, the text "(Contributed By:)"
will appear in the note text, which recognizes the person who
contributed that note.

Also, the bot doesn't have any coloring to it, so you should go
into the script and give it some colors if you want! :P

!total

Works the same as " /total ", except your friends and other
people can use it.

!newnote

Works the same as " /newnote ", except your friends and other
people can use it.

!commands/!help

Sends the user a notice about the outside user commands and how
to use them (in case they're not familiar with them).


Accessing the Channel Popup Commands

By Right-clicking a channel window and highlighting "Antoshi
Note System", you can access several new features to the bot.
These commands are:
- Edit Notes: Opens the notes.txt file to allow you to view &
edit your notes.
- !addnote Off: Turns the !addnote command off, disabling outside
users to add notes to your script.
- !addnote On: Turns the !addnote command back on. By default, the
bot is set to !addnote On.
- Turn ANS Off: Turns the entire bot "off", however, you can still
make use of the user commands, like /note, /search, etc. All
outside user commands and flood protection will be turned off.
The channel popup menu will still be available when you choose
to turn the commands back on.
- Turn ANS On: Turns the entire bot back "on." Outside user commands
and flood protection will be active again. NOTE: If you turned
!addnote off, it will stay off regardless of whether or not you
turned the bot off and then back on again. You'll have to click
"!addnote On" to re-instate the command.


One final little thing to add is if you or another user
use " / note ", " !note ", " /search " or " !search " without
anything after it, it will display a random note!


If you have any questions or comments, direct them at:
antoshi@gmail.com

That's all! Enjoy! :D