Skip to content
This repository was archived by the owner on Jul 5, 2021. It is now read-only.

Lemmmy/rocketchat-bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rocketchat-bot

A bot framework for Rocket.Chat, built on bot-commander.

Usage

Load the bot like so:

const Bot = require("rocketchat-bot").Bot;

const bot = new Bot({
  server: "your.rocket.chat",
  username: "botuser",
  password: "botpass"
});

bot.start();

bot.on("ready", () => {
  bot.loadPlugins(__dirname + "/plugins");
});

Create a plugins directory, containing your named plugins (e.g. test, droll). Then create a plugin.js file in the directory:

module.exports = bot => {
  bot.command("test")
    .action(meta => {
      bot.send(meta, "Hello, world!");
    });
};

For more information on the bot object, see the bot-commander documentation.

The WebSocket and REST APIs are exposed via bot.wsAPI and bot.webAPI respectively.

About

Bot framework for rocket.chat

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published