Squeebot NPM | npm.io

Squeebot

Pluggable chat bot spanning multiple worlds.

Minimal Setup

Clone this repository git clone https://gitlab.icynet.eu/Squeebot/squeebot-core.git
Install dependencies npm install
Install a protocol below (or any other module made for Squeebot)
Run npm start to start the default runtime
(optional) Install core plugins > plugin repo install https://gitlab.icynet.eu/Squeebot/squeebot-plugins

Protocols

Currently available protocols

IRC - npm install squeebot-protocol-irc
Discord - npm install squeebot-protocol-discord
Matrix - npm install squeebot-protocol-matrix

How to configure

In order to add new protocol configuration entries, you can run the following in the Squeebot CLI:

protocol new - Prompts you to create a new protocol configuration
protocol config protocol/name - Edit the previously created configuration
protocol start protocol/name - Start the configuration

For more detailed information, take a look at the wiki.

Relaying chats

Click here to learn how to configure relays.

Events

Every event is passed through one core event emitter and supporting core functions are available to all plugins. Messages coming from all configured protocols are standardized into a simple data object plugins can utilize. If more data is required from the protocol, the protocol class can implement supporting functions which can also be accessed from plugins.

Click here for more information on events.