Installation

Requirements

IRC Node requires node.js to be installed on the system. Information about how to download and install node.js can be found at http://nodejs.org/.

Installation

The installation of IRC Node is very simple.

1. npm install -g ircnode (sudo may be required)
2. Edit the configuration files in $HOME/.ircnode
3. Execute the command ircnode

Configuration files

Setting up basic cofiguration for IRC Node is simple. For a very basic setup you need to copy and edit the following two configuration files. More extensive information about configuration can be found in the Configuration page.

The configuration files are by default expected at the ~/.ircnode directory.

config

This is the base configuration file containing connection settings. The default file is config.sample.

The file contains the values:

• "port": xxxx -- number, the port for the bot to connect to
• "address": "irc.server.com" -- string, the server address for the bot to connect to
• "nick": "botname" -- string, the nick for the bot to use
• "user": "botname" -- string, the username for the bot to use
• "chan": "#chan" or "chan": ["#chan1", "#chan2"] -- string or array, the channel or channels for the bot to join
• "realName": "Bot Name" -- string, the real name for the bot to use
• "prefix": "!" -- string, the command prefix for the bot to listen to

users.json

This is user information file containing all settings and information about the users. The default file is users.json.sample.

The file contains the users in the following syntax:

{
  "user": {
    "auth": "owner" -- Marks user as owner (also includes admin rights).
    Other information about user is stored here.
  },
  "secondUser": {
    "auth": "admin" -- Marks secondUser as admin.
    Other information about secondUser is stored here.
  }
}