Cluster: A Clunky Modular Bot Framework for Discordrb

Cluster is a modular bot framework I made for discordrb, partially inspired by gemstone.

I really only made it for two reasons:

• To get my own personal bot projects more organized
• To function as a superweapon for the Diamond Authority after the failed colonization

All individual modules, called crystals, are located in the src directory. The main folder contains all the crystals that are loaded by default, and the dev folder contains crystals that will be loaded either by themselves or alongside the main crystals as desired.

Instructions

To begin, clone this repository to your local machine, then run rake remove_git to delete the repository files.

To run a bot, fill in config.yml with all the necessary information and then execute rake on the command line. It will automatically load all crystals present in the src/main directory. To run crystals present in the src/dev directory, execute rake run:dev for dev crystals exclusively and rake run:all to run both main and dev crystals.

Installing a crystal

Simply drag the crystal_name.rb file into the src/main directory and run the bot as normal. If a data folder is also included, drag the contents of it to the data folder; do the same for lib if it is included as well.

Developing a crystal

Generating a crystal

For development of crystals, a simple crystal template is included in src. Simply run rake generate[CrystalName], replacing CrystalName with the name of your crystal in CamelCase, and a starter crystal will be generated.

Coding a crystal

A structure for a basic bot can be seen here -- crystals, however, have a slightly different structure as detailed below.

Creating a command

To define a command, call the instance method command within the module and fill in its parameters and block as necessary.

An example of a basic command definition looks like this:

command :greet do |event|
  "Hi, #{event.user.name}!"
end

For details on the method, refer to its documentation.

Creating an event handler

To define an event handler, call its respective instance method within the module and fill in its parameters and block as necessary.

An example of a basic event handler definition looks like this:

member_join do |event|
  puts "User #{event.user.name} has joined the server."
end

For details on what event handlers are available, refer to the docs.

Additional details

The bot object is defined as a constant, Bot::BOT. As all crystals are submodules of the main module, Bot, they have access to this constant.

If a crystal you are developing needs additional code to be loaded, they should be placed in the lib directory; all files in this directory are loaded prior to loading all crystals.

A crystal's data files can be placed in the data directory; the constant Bot::DATA_PATH contains the path to said directory, which all crystals have access to.