  /////////////////////////////////////////
 /////  mIRCD v1.0 by linel0k  /////
////////////////////////////////////////



1...........Introduction
2...........Installation
3...........Usage
4...........Future Plans
5...........Contact



  ////////////////////////////////
 /////  1. Introduction  /////
///////////////////////////////

First of all, I would like to thank you for downloading my work.
This is an attempt to create an IRC Deamon using mIRC
Scripting only. mIRCD, as you will notice on your own, if you
are actually planning to use it and not steal it, provides the
basics of a usual IRCD without the services.

I could say that it runs smoothly without any dramatic problem
and is very easy to use. I included a dialog to make the setup
of the program easier, rather that editing configuration files.
I would propose to use it on a standalone mIRC client to prevent
possible variable conflicts and ensure the stability of the server
itself.

From the coder's point of view I would like to go a little bit more in
detail. I used Hash Tables to store the desired information and lots
of while loops to help the data spread to all the users equally.
I have coded a number of raw commands to simulate popular
IRCD software behaviour(e.g. Bahamut).

Finally, I would like to say that if you are planning to edit my code
you can do it freely, although I have a weird scripting style. On the
other hand, if you are planning to present my work as if it is yours,
even plagiarising it, then, as you already know about yourselves,
you are not real scripters and you will never be, at least not by
using other people's work. That's all, have fun ;-)



  ///////////////////////////////
 /////  2. Installation  /////
//////////////////////////////

The installation of mIRCD is simple and straightforward. I would
just recommend to install it on a new, fresh, mIRC client to avoid
having strange problems and ensure the stability of the server.
Now, unzip mircd.ini in your client's root folder. Run your mIRC
client and type the following:

/load -rs mircd.ini

Then, it will ask you whether you want to run the initialization
commands of the script and make sure you answer "Yes". You 
should be looking at the mIRCD Configuration dialog window, 
if you completed the above installation steps successfully of
course.



  /////////////////////////
 /////  3. Usage  /////
////////////////////////

As I mentioned above, if you installed the script successfully, you
should be looking at the configuration window of your server. Now,
things are very easy. By pressing each button, you provide the
essential data that the server needs to run. Below, I will analyse
the function of each button in detail, although it should be very clear
already:


--------------------------------------------------------------------------------------
IP: Here you put the ip of your machine. This is the IP address that
      your future clients will connect to.
--------------------------------------------------------------------------------------
MOTD: For those who don't know, the Message of the Day that you
            might have come accross when connecting to an IRC server.
--------------------------------------------------------------------------------------
Port: Here you put the port that your future client will connect to
         your server. The usual IRC port is 6667.
--------------------------------------------------------------------------------------
Max Users: I think that this is self explainable. You declare the 
                  maximum users that can connect at you server.
--------------------------------------------------------------------------------------
Name: Here you enter the name of the administrator of the server,
           probably you. If not the real name, at least a nickname.
--------------------------------------------------------------------------------------
Email: Here you enter the email of the administrator of the server,
          probably you. Just put an Email  Address to exist if you don't
          want to put your real one.
--------------------------------------------------------------------------------------
Location: Here you enter the geographic location of the server or
               the administrator of the server. (e.g. UK, London)
--------------------------------------------------------------------------------------
OK: It exits the configuration panel which, by the way you can bring
      up again anytime you want by pressing F12.
--------------------------------------------------------------------------------------
RELOAD: As it says, it unloads literally everything, including the script
              and performs a new, fresh installation of the script.
--------------------------------------------------------------------------------------
UNLOAD: It unloads mircd.ini clearing the hash tables and all the
               variables possibly used by the script.
--------------------------------------------------------------------------------------
Start mIRCD: This will initiate your server after you have completed
                     the configuration successfully, meaning providing all
                     the required information for the server.
--------------------------------------------------------------------------------------
Stop mIRCD: This will shut down your server, preventing anyone to
                    connect to it until you start it again.
--------------------------------------------------------------------------------------



  /////////////////////////////////
 /////  4. Future Plans  /////
////////////////////////////////

I could say many things about the future of this "project" but I would be
more accurate if I would just say the following:

1) Creating an Services Addon
2) Consider connectivity and interactivity with other mIRCD servers
3) Correcting possible bugs that you will find out by using mIRCD


  ///////////////////////////
 /////  5. Contact  /////
//////////////////////////

I would like to denote something. An IRCD is A LOT of work and the possibility
to come face to face with an error is great. That's why I need you to run mIRCD,
use it, test it (within the existing capabilities of course) and provide me with
feedbacks, suggestions, bug reports, ideas, comments, anything you want.
That will help me to produce better and error free future versions of mIRCD faster.

Email: linel0k@yahoo.com
IRC: gr.irc.gr or check at www.irc.gr to find a valid server for GRNet (#test-, #scripting)