Modular chatbot framework designed for group chat rooms on Facebook
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
src
.gitignore
.npmignore
LICENSE
README.md
banner.txt
package.json
tsconfig.json

README.md

Botyo

npm npm license

Botyo is a modular bot designed for group chat rooms on Facebook. It is designed with flexibility and modularity in mind.

Requirements

  • Node.js >= 8.3.0

Install

npm install --save botyo

Documentation

Documentation for Botyo is available here:

Quick Start

Please explore the Botyo Example Project to jump start your project.

Modules

Want to see your module for Botyo here? Please refer to the Botyo API for documentation on how to develop modules for Botyo. Then submit a PR with a link to your module to have it included in this list.

Bundles

Bundles are collections of multiple modules.

Commands

Commands are modules that handle commands that users can send to the bot. Commands must begin with a prefix that can be configured globally, or on a per-chat-thread or per-user basis.

  • Ping Command - sends a ping in a private message to a specific person, or makes the bot respond to the ping sent by the participants of a chat thread

  • Quote Command - uses Markov chains to generate quotes based on messages sent by the participants of a chat thread

  • Reverse Image Search Command - runs a reverse image search on the last uploaded picture and posts links to the results from Google Images, Bing Images, and TinEye

  • ShowMe Command - returns the first few images found in Google Images matching a query

  • Spotify Command - posts a Spotify song to the chat

  • YouTube Command - posts a YouTube video to the chat

Filters

Filters are modules that manipulate or filter out messages as they arrive.

Scheduled Tasks

A scheduled task is module that defines a task that is executed periodically or upon the start of the bot.