DEPRECATED

I have completely rewritten the bot's architecture; consequently, the previous plugin system is no longer compatible. I will revise and redocument the new plugin system once I am happy with it.

Plugin Template

Template to quickly create new plugins for the bot.

########

Note:

Features include both general features that the plugin adds, and things that don't require commands.

If you write an auto-moderation plugin, it may do things in the background without needing a command. Example:

Features

• Swear filter: Deletes messages that contain naughty language.
• Active spam/raid prevention: Detects spam and prevents raids.

Code Structure

• Develop all commands in src/commands/<command group>
  • Example: src/commands/music/PlayCommand.ts
• Place any code that isn't a command and doesn't need to be shared outside the plugin in src/lib/
• If you need a non-command to be shared outside your plugin, it should be placed in the util package/repository.

Code Style

• Follow the same code style used in the other projects in the repository.
• The included dependencies should help enforce most things.
• Try to keep the commands small, refactor out most logic if possible, and place it in the src/lib/ directory. ########

<<-- DELETE EVERYTHING ABOVE -->>

Plugin Name

Brief description of plugin.

Features

• Plugin feature 1: Feature description
• Plugin feature 2: Feature description
• etc.

Commands

• ?pluginCommand1: Command description
• ?pluginCommand2: Command description
• etc.

Installation

All plugins should be installed in the plugins/ directory of the bot. Plugins are automatically loaded and registered when the bot starts.