@mumbot/framework

Open sourced framework for @Mumbot, the Discord bot with a personality.

Highlights

• This framework is still in its very early stages
• Start a Discord bot in under 10 mins
• Extensible and allows for adding and contributing plugins
• Powerfully typed with Typescript driven scripting
• Fully documented

Install

npm i --save @mumbot/core

Usage

// Typescript
import createBot from '@mumbot/core';
// Javascript
const createBot = require('@mumbot/core').default;

// Get from Discord's developer site
const token = 'ABC1DEfgHIJ2KLMnOPQ3RSTU.VWXYZA.BCd4eFGhiJKLMnopqrstu5v6wxY'

// Initialize the bot
createBot({ token: token });

Yes, it's that simple. Of course, however, that's the simplest part...

Listening to Events

Events are actions that happen inside your discord server (or "Guild"). We create a simple way for you to register these events/listeners and perform actions.

Creating Commands

Commands are prefix based actions that are triggered by other Discord members, even other bots.

import createBot from '@mumbot/core';

const token = 'ABC1DEfgHIJ2KLMnOPQ3RSTU.VWXYZA.BCd4eFGhiJKLMnopqrstu5v6wxY'

createBot({
  token: token,
  prefix: '!',
  commands: [
    {
      keyword: 'ping',
      classification: 'ping-pong',
      help: 'This command echo\'s Pong back at you',
      examples: ['!ping'],
      options: [],
      flags: [],
      handler: msg => msg.reply('Pong!')
    }
  ]
});

Using Plugins

Plugins are a pre-built set of events to be triggered collectively or seperately to acheive a particular goal.

For instance, lets take a simple "Greeting" event, instead of writing the entire definition of how the bot is to send a message greeting the user, you can use a simple little function within the "plugins" argument.