Node IRC Framework
How To Use It
- create a new config:
- create a new script:
var framework = path = cfgPath = path // initialize config config = framework // initialize irc client irc = framework; // add kill listeners to graceful shutdown irc clientprocess;process; // now you can connectirc;
- run it:
$ node ./YourScript.js
How To Customize It
If you plan on working with this Frawork you might want to customize the behavior of the IRC Client in this package. You can do so by extending the client and add events or operate on the client itself.
For this you can write the following code:
// when initializing the client you can append an object and a callbackvar framework = tools = frameworktools irc = framework;
What Is Shipped With This Module?
This module consists of 3 parts:
irc
- the smart and customizable irc clientconfig
- a preconfigured and defaulting configuration provider including Union-Array lists for special settingstools
- a set of core tools which provide helping functions
Which Are Valid Settings?
A full configuration of this framework consists of the following settings:
host
: ip or domain which IRC Client shall connect toport
: port on which IRC Client shall connect touseSSL
: Wheter to use SSL protocoluseSASL
: Wheter to use SASL AuthenticationautoRejoin
: Wheter to rejoin on channels after being kicked or notnick
: That's the name of your client in the chat ;)admins
: A list of admins who are eliglible for issueing commandsblacklist
: A list of clients who shall be ignoredchannels
: A list of channels IRC Client shall join / rejoinnickserv
: Whether to auto identify with nickserv (using given credentials)nickservPassword
: Password to use forNickserv
authenticationnickservEmail
: Email to use forNickserv
authenticationuseAdmins
: Enable or Disable restricted command access