3.5 KiB

Raw Blame History

🧩 Plugins

The bot supports loading external plugins.

Specifying plugins to load

For each plugin file you'd like to load, add the file path to the plugins option. The path is relative to the bot's folder. Plugins are automatically loaded on bot startup.

Creating a plugin

Plugins are simply .js files that export a function that gets called when the plugin is loaded.

For details about the function arguments, see Plugin API below.

Example plugin

This example adds a command !mycommand that replies with "Reply from my custom plugin!" when the command is used inside a modmail inbox thread channel.

module.exports = function({ bot, knex, config, commands }) {
  commands.addInboxThreadCommand('mycommand', [], (msg, args, thread) => {
    thread.replyToUser(msg.member, 'Reply from my custom plugin!');
  });
}

(Note the use of object destructuring in the function parameters)

Example of a custom attachment storage type

This example adds a custom type for the attachmentStorage option called "original" that simply returns the original attachment URL without rehosting it in any way.

module.exports = function({ attachments }) {
  attachments.addStorageType('original', attachment => {
    return { url: attachment.url };
  });
};

To use this custom attachment storage type, you would set the attachmentStorage config option to "original".

Plugin API

The first and only argument to the plugin function is an object with the following properties:

Property	Description
`bot`	Eris Client instance
`knex`	Knex database object
`config`	The loaded config
`commands`	An object with functions to add and manage commands
`attachments`	An object with functions to save attachments and manage attachment storage types
— `addStorageType(name, handler)`	Function to add a new attachment storage type
— `downloadAttachment(attachment)`	Function to add a new attachment storage type

bot - the Eris Client object
knex - the Knex database object
config - the loaded config
commands - an object with functions to add and manage commands
attachments - an object with functions to save attachments and manage attachment storage types
- attachments.addStorageType(name, handler)

Create a .js file that exports a function. This function will be called when the plugin is loaded, with 1 argument: an object that has the following properties:

bot - the Eris Client object
knex - the Knex database object
config - the loaded config
commands - an object with functions to add and manage commands
attachments - an object with functions to save attachments and manage attachment storage types

See src/plugins.js#L4 for more details

Work in progress

The current plugin API is fairly rudimentary and will be expanded on in the future. The API can change in non-major releases during this early stage. Keep an eye on CHANGELOG.md for any changes.

Please send any feature suggestions to the issue tracker!

3.5 KiB Raw Blame History