monbot v0.1.13

Monbot

A library with simple API for creating your own discord bots.

:warning: Not recommended for use yet. Under development and api is still shaping up.

Installation

Install using npm install --save monbot discord.js or yarn add monbot discord.js.

Quickstart

Monbot makes it easier to create discord bots with custom commands. Here's quick example:

import { Monbot, createCommand } from 'monbot';

// Create a command that is triggered when word "hello" is found in the message, e.g. "Hello friend!"
const hello = createCommand({
  name: 'hello',
  trigger: /(^|\s+)hello(\s+|$)/i,
  run: ({ channel }) => {
    channel.send('hi 👋');
  },
});

// Initialise the bot
Monbot('BOT_AUTH_TOKEN', {
  commands: [hello],
});

You can find expanded example from example/

Bot permissions in discord

For bot to work with adding or removing reactions to messages that are not in its cache, e.g. messages send before bot became online, it requires Read Message History permission.

Without the permission bot cannot fetch non-cached messages and the reactions will not trigger the action.

API documentation

Monbot

TBA

createCommand

Creates a command configuration.

type Command = {
  name: string;
  trigger: RegExp;
  run: (message: Message, { removeTrigger, parseArgs }: CommandExtraParams) => void;
  requiredRoles?: string[];
  adminOnly?: boolean;
  channels?: string[];
  guilds?: string[];
};

Example

export const hello = createCommand({
  name: 'hello',
  trigger: /(^|\s+)hello(\s+|$)/i,
  run: ({ channel }) => {
    channel.send('hi 👋');
  },
});

createReaction

Creates a reaction configuration.

type Reaction = {
  name: string;
  trigger: string | string[];
  onAdd?: (reaction: MessageReaction) => void;
  onRemove?: (reaction: MessageReaction) => void;
  requiredRoles?: string[];
  channels?: string[];
  guilds?: string[];
};

Example

export const wave = createReaction({
  name: 'wave',
  trigger: ['👋'],
  onAdd: ({ message: { channel } }) => {
    channel.send('You added :wave:');
  },
  onRemove: function ({ message: { channel } }) {
    channel.send('You removed :wave:');
  },
});