___________ _____________  _______ ________   
\_   _____/|   \_   __   \/   ___ \\_      \  
 |    __)_ |   ||       _/    \  \/ |   |\  \ 
 |        \|   ||    |   \     \____|   \|   \
/_______  /|___||____|_  /\______  /_______  /
        \/             \/        \/        \/
EIRCD v3.0.-1 by poiuy_qwert
Contents
  1. Changes
  2. Introduction
  3. Installation
  4. Settings
    1. Server
    2. Admin
    3. Settings
    4. G-Lines
    5. Max
    6. Display
    7. Plugins
    8. Blacklist
    9. IRCOps
  5. Commands
  6. Customizing Your Server
    1. Commands
    2. Modes
    3. Fake Users
    4. Plugins
  7. Credits
  8. Contact
1. Changes (Top)
EIRCD v3.0.-1 ()
  • First public beta release.
2. Introduction (Top)
This is an IRC Daemon (IRC Server) written in the mIRC Scripting Langauge. Its designed for private servers, and should be efficient for up to 100 users, but no real tests have been done as of yet. Currently it is only in beta stages so everything should work, but some things are missing (like excess flood and finished readme).
3. Installation (Top)
The installation of this addon is quite simple, just follow these steps:
  1. Extract the EIRCD folder and all contents to your mIRC directory.
  2. Open up mIRC 6.21 or later, preferably a second copy of mIRC with no scripts loaded.
  3. Open the Remote Editor by holding the ALT key and press R.
  4. Load EIRCD by holding the CTRL key and press L.
  5. Go into the EIRCD folder, select EIRCD.mrc, and Open it.
  6. A popup will ask if you want to "Run initialization commands?", say Yes.
  7. Now the EIRCD Setup Wizard will open. Follow what the setup wizard says and complete the setup of your server.
    Note: The Remote Editor is no longer needed, you can press the Ok button on it during or after the setup wizard.
  8. After finishing the setup you can start the server by selecting the "Start EIRCD" check box at the end of the wizard, using the /eircd3 command, or the EIRCD popup menu.
4. Settings (Top)
Before using EIRCD, you should edit the settings in the settings.ini file.

1. Server (Top)
The server section holds server information.
  • Server:
       This is the server address, something like "irc.myserver.net" without quotes. This option does not let users connect to that address, you must setup a DNS for that to work. It is only used in messages sent to clients.
  • Name:
       A short name for the server. In mIRC this is used in the switchbar/treebar for the status window name.
  • Info:
       Small bit of info on the server sent in a /whois.
  • Port:
       The port the server will run on (usually 6667).
  • Location:
       The location of the server (EX: Dallas, TX)
  • Pass:
       The password of the server. If this is supplied users must supply a password when connecting.

2. Admin (Top)
This section is only to specify information sent with the /admin command.
  • Name:
       The name and/or nickname of the server admin.
  • Email:
       The email of the server admin.

3. Settings (Top)
This section is for server settings that don't fit under the other sections.
Note: You should not edit these settings unless you know what you are doing. The only setting you may want to change without advanced knowledge is the Hostmask setting explained bellow.
  • Nickallow:
       This specifies what characters are valid in nicknames. It accepts ASCII codes and ranges of ASCII codes. Restricted ASCII codes are: 32, 44, Channel Types, and Mode Prefixes.
  • Chanallow:
       This specifies what characters are valid in channel names. It accepts ASCII codes and ranges of ASCII codes. Restricted ASCII codes are: 32, 44, and Channel Types.
  • Chantypes:
       Prefixes for channel names.
  • Chanops:
       Which modes are considered channel operators.
  • Modes:
       Channel usermodes, used with /mode <chan> to set users access on channels.
  • Prefixes:
       Channel usermode prefixes. The order should be the same as the Modes setting.
  • Usermodes:
       Modes users can set on themselves with /mode <nick>.
  • Chanmodes:
       Channel modes, split into 3 groups by commas. The first group is modes that require a parameter to setting and unset them, and adds/removes the parameter from a list. The second group is modes that require a parameter to set and unset. The third group is modes which only require a parameter when setting, not unsetting. The last group is modes that don't require a parameter at all.
       Note: Do not include the modes set in the Modes setting, EIRCD will add them for you.
  • Hostmask:
       The mask that is applied to a users host when they set +x. A unique number is appended to the hostmask to keep users seperated.
  • Operpass:
       The length of the randomly generated IRCOp password when using /aoper.
  • Clonegline:
       This defines if users get G-Lined when they connect too many clones or not. Use 1 for Yes and 0 for No.
  • Checkping:
       This defines if the server should send regular PING requests to clients to check if they are still connected. Use 1 for Yes and 0 for No.

4. G-Lines (Top)
This section defines G-Line lengths for things such as connecting too many clones. Lengths can be 3 things: 0 for permanent gline, N for N seconds, or a formatted string like 100m2s. The formatted string uses y for years, M for months, w for weeks, h for hours, m for minutes, and s for seconds. So the example 100m2s is 100 minutes and 2 seconds, which is the same as supplying 60200.
  • Clone:
       G-Line length for connecting too many clones at once.

5. Max (Top)
Limits for your server are stored in this section. The allowed range for each setting is given in parenthesis at the end of the description.
  • Users:
       Max users allowed connected to the server at once (1 or more).
  • Clones:
       Max clones one user can have connected at once (1 or more).
  • Chans:
       Max chans a user can be on at once (1 or more).
  • Modes:
       Max modes allowed with one /mode command (1 to 10).
  • Nicklen:
       Max length of nicknames (1 to 30).
  • Topiclen:
       Max length of channel topics (1 to 300).
  • Kicklen:
       Max length of kick reasons (1 to 300).
  • Awaylen:
       Max length of away reasons (1 to 300).
  • Quitlen:
       Max length of quit reasons (1 to 300).
  • Chanlen:
       Max length of channel names not including the channel prefix (1 to 50).
  • Keylen:
       Max length of the channel key set with mode +k (1 to 30).
  • List:
       Max amount of items to list with /list, /who, and other list commands (1 to 500).
  • Targets:
       Max targets of a command, for example when doing something like /join #chan1,#chan2,...,#chanN (1 to 10).
  • Registerlen:
       The length in seconds a user has to register to the server by sending PASS (if required), NICK, and USER commands (1 to 60).
  • Pingtimeout:
       When the setting Checkping is set to 1 this is the interval in seconds the PING command will be sent to users (1 to 60).

6. Display (Top)
This section defines some things about how EIRCD is displayed.
  • Outgoing:
       Defines if the server should show outgoing raws in the EIRCD windows (this is not recommended to be used with lots of people). Use 1 for Yes and 0 for No.
  • Timestamp:
       This defines if a timestamp is used on the info shown in the EIRCD windows. It has 3 things it can be set to: off (no timestamp), on (uses timestamp defined in mIRC options), or a string which conforms to mIRC's $asctime identifier.
  • Listwidth:
       The width of the sidelist on the EIRCD Console (im not sure what the number means, but the higher the wider).
  • Action:
       The color of EIRCD actions in the EIRCD windows.
  • Receive:
       The color of received raws shown in the EIRCD windows.
  • Send:
       The color of sent raws shown in the EIRCD windows (if shown).

7. Plugins (Top)
This section shouldn't be manually edited. When plugins are loaded they are added to this section, when they are unloaded they are removed.

8. Blacklist (Top)
A list of blacklisted nicknames that only IRCOps are allowed to use. 1 means IRCOps only, 0 means temporarily allow anyone to use.

9. IRCOps (Top)
This is where the IRCOp accounts are stored. There must be at least one account. The items are the account name and the data is the password encrypted with md5. You should not edit this manually.
5. Commands (Top)
  • PASS:
       Sent before registering to server (only for servers which require it). Usage: PASS <password>
  • LUSERS:
       Gives information on the amount of: users, invisible users, max users allowed, IRC operators, and channels formed. Usage: LUSERS
  • VERSION:
       Gives the server software version, network address, and support settings for the server. Usage: VERSION
  • NICK:
       Changes your nickname on the server. Usage: NICK <newnick>
  • USER:
       Used to register yourself to the server. Usage: USER <username> <unused> <unused> <realname>
  • PING:
       Used to test connectivity to the server. Usage: PING <server/anything>
  • MOTD:
       Displays the servers Message of The Day. Usage: MOTD
  • OPERMOTD:
       Displays the servers Oper Message of The Day. (IRCOp Only) Usage: OPERMOTD
  • USERHOST:
       Gives the username and host of a user. If you are not an IRCOp the users real host will be hidden. Usage: USERHOST <nick>
  • MODE:
       Sets a user/channel mode. You can only set user modes on yourself, and can only set channel modes with channel operator status in that channel. Usage: MODE <yournick> <modes> or MODE <channel> <modes> [parameters]
  • WHOIS:
       Lookup usefull information on users. Usage: WHOIS <nick>[,<nick2>,...,<nickN>]
  • INVITE:
       Invite a user to join a channel you are on. Usage: INVITE <nick> <channel>
  • JOIN:
       Join channels. Usage: JOIN <channel>[,<channel2>,...,<channelN>]
  • TOPIC:
       Change or view the topic of a channel. Usage: TOPIC <channel> [topic]
  • NAMES:
       List the names of the users on a channel. Usage: NAMES <channel>
  • PRIVMSG:
       Send a message to a channel or user. Usage: PRIVMSG <nick/channel> <message>
  • NOTICE:
       Notice a channel or user. Usage: NOTICE <nick/channel> <message>
  • KICK:
       Kick users out of channels you are on. Usage: KICK <channel>[,<channel2>,...,<channelN>] <nick>[,<nick2>,...,<nickN>] [reason]
  • PART:
       Leave channels you are on. Usage: PART <channel>[,<channel2>,...,<channelN>]
  • AWAY:
       Set an away message to be displayed when messaged, or remove your away status. Usage: AWAY [reason]
  • WHO:
       Lookup usefull information on users. Usage: WHO or WHO <nick>[,<nick2>,...,<nickN>] or WHO <channel>[,<channel2>,...,<channelN>]
  • LIST:
       List channels, the amount of users in the channels, and their topics. Usage: LIST or LIST <channel>[,<channel2>,...,<channelN>]
  • ADMIN:
       Give some contact information on the server admin. Usage: ADMIN
  • TIME:
       Display the time where the server is. Usage: TIME
  • MODULE:
       List modules loaded onto the server. Usage: MODULE
  • OPER:
       Login as an IRCOp. Usage: OPER <account> <password>
  • AOPER:
       Add an IRCOp account. (IRCOp Only) Usage: AOPER <account>
  • POPER:
       Change the password of your IRCOp account. (IRCOp Only) Usage: POPER <oldpass> <newpass>
  • REHASH:
       Reload server settings from the settings file. (IRCOp Only) Usage: REHASH
  • GLOBAL:
       Send a global notice to everyone or, if -o is supplied, IRCOps only. (IRCOp Only) Usage: GLOBAL [-o] <message>
  • KILL:
       Kill someones connection to the server. (IRCOp Only) Usage: KILL
  • GLINE:
       Add a G-Line (global server ban) on an IP. (IRCOp Only) Usage: GLINE [-f] <length> <nick> or GLINE [-f] <IP/nick/address/realaddress> <length> Note: Length can be one of 3 things: 0 for permanent, a number for X seconds, or a formatted string like 100m2s. The formatted string uses y for years, M for months, w for weeks, h for hours, m for minutes, and s for seconds. So the example 100m2s is 100 minutes and 2 seconds, which is the same as supplying 60200. The -f switch forces a G-Line even if a matching G-Line is found.
  • GLINES:
       List all G-Lines matching a criteria. (IRCOp Only) Usage: GLINES [-m<N>] [settersnick [IP/origionalset [whenset [length [timeleft [reason]]]]]] Note: Anything not set is assumed to be *, which means anything. Lengths can be a specific length, or a range in the format length[-length]. If the second length isn't specified its taken as infinity. The -m switch specifies a maximum amount of matches to return.
  • RGLINES:
       Remove all G-Lines matching a criteria. (IRCOp Only) Usage: RGLINE [-m<N>] [settersnick [IP/origionalset [whenset [length [timeleft [reason]]]]]] Note: See /help rgline for an explanation of the parameters.
  • HELP:
       Gives help for server commands. Usage: HELP [topic]
  • QUIT:
       Disconnect from the server. Usage: QUIT [reason]
6. Custom (Tup)
EIRCD was designed to be easily customizable and pluggable. This section gives information on how to go about doing things to customize your server.
1. Commands (Top)
This is a beta so there is currently no information on this subject.

2. Modes (Top)
This is a beta so there is currently no information on this subject.

3. Fake Users (Top)
This is a beta so there is currently no information on this subject.

4. Plugins (Top)
This is a beta so there is currently no information on this subject.
7. Credits (Top)
EIRCD v3.0.-1 ()
  • Killgunner:
       Lots of testing and telling me what I was missing.
  • Log1x:
       More testing.
8. Contact (Back)
If you found bugs, have some suggestions or comments, you can contact me any of these ways: