Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.24 KB

README.md

File metadata and controls

36 lines (22 loc) · 1.24 KB

BMO

Build Status bitHound Score ![David dm] (https://david-dm.org/drakoumel/BMO.svg)

An xmpp client,in nodejs, based on node-xmmp. The main usacase is hipchat, although it should work for other jabber based chats.

If you want to help [Check the TODO] (https://github.com/drakoumel/BMO/blob/master/TODO.md)

Howto

The server.js file contains the main functionality to get started. Fill in config/default.json with your details to connect.

It is advised however to use environment variables to handle your credentials.

Start your app server:

$ cp default.json production.json //fill in your details
$ grunt
$ NODE_ENV=production node server.js 

Directives

The folder Directive is meant to be used as a location to store different "command" bundles. As exposed in the repository, the directive default is used for standard functions, such as help.

The Directives are chosen from the controller.js

Events Exposed

At the moment the following events are being exposed for use:

  • connected
  • joinedRoom
  • messageReceived