]{arhu's mIRC Script syntax v1.1

================================
1.0 What is this?
 1.1 Version history

2.0 Installation

3.0 Making mIRC Scripts part of your EditPlus
 3.1 File types
 3.2 Syntax
 3.3 Filters
 3.4 Templates

4.0 Configuring colors
 4.1 Syntax source

5.0 Author
================================

1.0:: What is this?

You know those colors in the document when you edit a C++, HTTP, Perl etc. file? Those
colors are ment to make your coding job easyer. Of course EditPlus has to know what words
it colors and what not. That's why EditPlus has to support the code language you are
writing to color the command words, quotes, comments in the code etc. The file that tells
EditPlus to color certain words, is called syntax. This is mIRC syntax which is compatible
with mIRC script. It colors all the commands, identifiers, variables etc. and that way
helps you to edit the script. Information about the colors and stuff are under section 4.0.

1.1:: Version history

v1.1 Propably the final version of ]{arhu's mIRC syntax. Can color all the commands like
     in the previous version, but with different system and other small color changes
     makes it worth the download.

v1.0 Colored all the commands, variables, if-then-else statements etc. but wasn't perfect
     with the colors because mIRC uses e.g. command 'query' as an 'on event' too.

--------------------------------
2.0::Installation

I assume you have a program like WinRAR you used to open the archive and can now see this
text. Extract these files to your EditPlus directory:
	
	MIRC.STX......................Syntax file, MUST INSTALL
	TEMPLATE.MRC..................Template file
	README.TXT....................This readme file
	EXAMPLE.MRC...................Example file, SHOULD INSTALL
	
After extracting all the files to the EditPlus directory, open your EditPlus.
Open the 'Tools' menu and then choose 'Preferences'.

From the 'Categories' list double click 'Files' and then choose 'Syntax'

In the 'Syntax types' list are listed all the syntaxes your EditPlus supports.
Click button 'Add...'

EditPlus opens a EditPlus' directory for you, if not, then goto your EditPlus directory
with it. When in the EditPlus directory, select file: 'mirc.stx' and then click button
'Open'.

EditPlus adds the mIRC Script into the 'Syntax types' list. Then write in the 'Extension:'
textfield: 'mrc;knl'. Now EditPlus supports mIRC Script syntax, but not yet is associated
with it. To see how to make mIRC Script syntax part of your EditPlus, goto section 3.0.

--------------------------------
3.0::Making mIRC Scripts part of your EditPlus

If you have followed the instructions in the 'Installation' section, proceed, otherwise
read the 'Installation' under section #2.0.

3.1:File types

You can change the EditPlus setting on how to edit mIRC Scripts by adding mIRC Script in
your File types. To do this follow the instructions below:

Open the 'Tools' menu and then choose 'Preferences'.

From the 'Categories' list double click 'Files' to open it. Then choose 'Settings'.

In the 'File types' list are all the file types EditPlus has own settings for. Click
'Add' button to add mIRC Script.

EditPlus add's an item: 'New Settings' into the list and then opens it. In the 'Description:'
text field write text: 'mIRC Script'. After that write in the 'Extensions:' text field
write text: 'mrc;knl'. Now you have your personal settings for mIRC Scripts, for help
with the settings of mIRC Script read the instruction below. In case you want to keep your
own settings, goto section #3.2.

When making e.g. a bot or a full script, the length of the script code may become very long
and then it's hard to find some parts of it when needed. By marking the 'Show line number' 
box, EditPlus adds line numbers in the left side of EditPlus edit window. That way you
can memorize one line number and then later if needed go back to there easily. Some people
find the line numbers annoying but their weird people :).

If you have before made mIRC scripts with mIRC's 'mIRC Editor' you know how it adds two
spaces to seperate lines under 'if' commands and 'on event' lines to make it easyer to
edit. In the 'Tab' text field you can write the amount of spaces per one tab. If you set it
to '2', you can use it to write those 2 spaces in to the text. I have had problems when 
using tabulator with mIRC scripts because I used to write the script with EditPlus and then
copy'n'paste it to mIRC Editor. For some reason it added small black boxes to indicate tabs
and that way messed the script so mIRC couldn't understand it. This problem might go away
with later version of EditPlus or mIRC, but I suggest you try it before starting to use it.

In the 'Word wrap' box you can make EditPlus wrap long lines, but this makes, especially,
mIRC scripts hard to read and edit. I really suggest you don't put this on.

These are all the settings that have really difference when writing mIRC scripts, so if you
want to you can change 'em to what ever you like.

3.2:Syntax

How to add ]{arhu's mIRC Script syntax to your EditPlus are told in the section #2.0.

3.3:Filters

This is important section if you want to really make mIRC scripts as part of your EditPlus.

Open 'Tools' menu and then choose 'Preferences'. From the 'Categories' list double click
'Files' to open it. Then choose 'Filters'.

In the 'File filters' list are listed all the files that are associated with EditPlus.
Click button 'Add'. EditPlus adds an item 'New Type' in the list.

In the 'Description:' text field write: 'mIRC Files'. Then in the 'Wild cards:' text field
write: '*.mrc;*.knl'.

Then check the 'Add to 'Common Files' filter' box.

So you could open mIRC Script files by double clicking 'em, check the 'Associate in Explorer'
box.

By checking ''Edit with EditPlus' on Context menu' box you can open mIRC Script files with 
EditPlus in Explorer by right clicking 'em and then choosing 'Edit with EditPlus'.

3.4:Templates

Open 'Tools' menu and then choose 'Preferences'. From the 'Categories' list double click
'Files' and then choose 'Templates'.

In the 'Templates' list are listed all the template files EditPlus has. Template file
is the file that open when you create a NEW file that is associated with EditPlus (e.g.
Java, Perl, C++...)

Click the 'Add' button. EditPlus makes a new item in the list called 'New Template'.
Write in the 'Menu text:' text field: 'mIRC'.

Click the '...' button that is after the 'File path:' text field. It opens a directory list
of EditPlus, if not goto your EditPlus directory with it. In the EditPlus directory select
file: 'template.mrc' and then click button 'Open'.

Now you have fully installed mIRC Script syntax. To configure syntax colors goto section #4.0

--------------------------------
4.0::Configure colors

If you want to change the colors of the mIRC Script Syntax, follow the instructions below:

To make selecting good colors easy I've made a example script that uses all the color
things in the mIRC Script syntax. In case you didn't copy the example file you can now
be a shamed of your self.

Open the example file from EditPlus directory and then Open 'Tools' menu and then choose 
'Preferences'. From the 'Categories' list double click 'Files' to open it and then
choose 'Syntax'.

From the 'Syntax types' list find text 'mIRC Script' and then select it. In the white box
with colored text are all the colors that the syntax uses. To change the color of e.g. 
'Commands', select it and then from the color box in the left click the color that makes
you horny.

To see how it looks in a script now click the 'Apply' button in the bottom. From the mIRC
Script example document that is open you can see how it looks like.

These are the colors I think look good:

	Identifiers = PURPLE
	Commands = BLUE
	Operators = RED
	on EVENT = BLUE (SHOULD be the SAME color as 'Commands', if not, try and see why...)
	Variables = DARK PURPLE
	Line comment = GREEN
	Block comment = PURPLE
	Block comment2 = DARK RED

--------------------------------
4.1:Syntax source

It's not yours so don't screw it.

--------------------------------
5.0::Author

Timo Karhu alias ']{arhu'
karhu@techie.com

--------------------------------

If you think something sucks in this syntax, mail me about it and I'll see what I can do :)

Thank you for choosing ]{arhu's mIRC Script syntax as your mIRC script syntax.