YAMDBF is a lightweight Discord Bot framework for rapid bot development using Discord.js, making it simple to get a bot up and running with minimal effort and configuration.
Note: Features described here are representative of the state of the master branch. Installing directly from GitHub is currently preferred due to the proximity to release and dependency issues in the latest stable release.
Use
npm install --save zajrik/yamdbfto install from GitHub. This requiresgitto be installed and in your PATH, and also requires > Node 8.0.0 to run.
Documentation for the master branch can be found here.
- Fully localizable (English by default)
- Base commands for control over default settings
- Full control over all base commands via disabling or overloading
- Simple structure for creation of custom commands
- Automatic custom command loading
- Fine control of command execution per-user/globally via configurable ratelimits
- Robust middleware system for fine control of execution flow and
control over the data passed to your commands- Ships with methods for resolving different data types and ensuring
certain args/types are passed to commands
- Ships with methods for resolving different data types and ensuring
- Easy to use storage with support for custom storage providers
- Ships with a default JSON provider, and other optional providers using Sequelize:
- Postgres
- SQLite
- Ships with a default JSON provider, and other optional providers using Sequelize:
- Full TypeScript support (It's written in it!)
- Support for decorators for simpler handling of:
- Event listeners
- Command metadata
- Command middleware assignment
- Attaching Logger for logging/debugging
- Support for decorators for simpler handling of:
Ignore any warnings about unmet peer dependencies as they are all optional unless using a Sequelize-based storage provider.
Regular install: npm install --save yamdbf
With a Postgres provider: npm install --save yamdbf pg sequelize
With an SQLite provider: npm install --save yamdbf sqlite3 sequelize