This repository contains the various Pieces submitted by users and collaborators.
Pieces are simply parts of code that can be downloaded and installed straight into your Komada bot installation.
Pieces can include:
- Commands: Chat commands that generally respond with a message after taking some actions.
- Events: Pieces that get executed when a Discord event triggers.
- Functions: Functions that are made available to other Pieces. These functions can range from utility functions to blocks of code repeated enough to justify making a function out of it. They are not seen by the members.
- Inhibitors: Inhibitors are pieces that run before a command is executed and may take action on the message received, and block a command from running in certain cases (thus inhibit a command).
- Monitors: Monitors are pieces that can run on every message, whether or not it triggers a command. Useful for spam monitoring, swear filters, etc.
- Providers: Support for a specific database type. By default a very small amount of DBs are supported, but you can extend the support by adding a provider for whatever database you choose, and configure it to point to your own database.
- Finalizers: (New in v0.20.0) Pieces that run on messages after a successful command.
- Extendables: (New in v0.20.0) Pieces that act passively, attaching new getters, setters or methods to the current Discord.js classes. They're executed at startup before any other piece.
- Packages: A Pieces Package containing one or more of other pieces. Packages are presumed to work as a single entity, meaning, custom functions are used by commands, so are data providers, etc.
Check out the documentation:
To submit your own pieces for approval (quick steps):
- Fork this repository
- Create a new piece in the appropriate folder
- Create a Pull Request to the repository.
- Be patient. Someone will approve/deny it as soon as they can.
We will automatically deny PRs that:
- Have identical functionality to an existing Piece
- Have code that breaks/does not catch errors/etc
- Contain NSFW, NSFL contents or contents we deem to be unacceptable.
- Contain hacks/exploits/etc
- Have code that might cause a bot to break the TOS or Ratelimits
- Any reason WE feel is valid.
WE RESERVE THE RIGHT TO REFUSE ANY CONTENTS FOR ANY REASON WHETHER YOU ACCEPT THEM OR NOT.