ircbot

Installation

Requirements

• node.js
• mongodb

Clone this repository and install dependencies

git clone [email protected]:h4x3d/ircbot.git
cd ircbot
npm install

Create config.json file. See config.template.json for possible options. The config file consists of environment specific blocks. Environment variable NODE_ENV determines which block is used. If the environment variable is not present, the development block will be selected. all block is always used and the block selected is merged into it so that it overwrites the values defined in it.

Start your bot

node index.js

Usage

Channels

Handles joining/leaving channels

Commands

!join [channel]

Joins to channel

---

!join [channel] [password]

Joins to channel with password

---

!part [channel]

Leaves channel

---

!part [channel] [message]

Leaves channel with part message

---

Say

Handles sending messages to channel or nickname

Commands

!say [target] [message]

Sends a message to given target (channel or nickname)

---

Auth

Handles commands for user authentication and user management

Commands

!auth help

List all commands

---

!auth users

List all user

---

!auth create [username]

Create a new user

---

!auth remove [username]

Remove user

---

!auth change-pass [password]

Change password

---

!auth reset-pass [username]

Reset password

---

!auth login [username] [password]

Log in

---

!auth logout

Log out

---

---

Development

• Install package

git clone [email protected]:h4x3d/ircbot.git
cd ircbot
npm install

• optional Install and start UnrealIRCd

• Start bot

node index.js

npm test only passes if you have ircserver running in port 6667 on your local machine