Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yamdbf/core
The core YAMDBF Framework
https://github.com/yamdbf/core
bot discord discord-bot-framework discord-js framework typescript yamdbf
Last synced: about 1 month ago
JSON representation
The core YAMDBF Framework
- Host: GitHub
- URL: https://github.com/yamdbf/core
- Owner: yamdbf
- License: mit
- Created: 2016-09-19T12:22:13.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-08-02T06:26:16.000Z (over 3 years ago)
- Last Synced: 2024-11-01T09:13:43.469Z (about 2 months ago)
- Topics: bot, discord, discord-bot-framework, discord-js, framework, typescript, yamdbf
- Language: TypeScript
- Homepage: http://yamdbf.js.org
- Size: 5.13 MB
- Stars: 65
- Watchers: 5
- Forks: 13
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## YAMDBF: Yet Another Modular Discord Bot Framework
[](https://discord.gg/cMXkbXV)
[](https://www.npmjs.com/package/@yamdbf/core)
[](https://david-dm.org/yamdbf/core)
[](https://david-dm.org/yamdbf/core?type=peer)
[](https://travis-ci.org/yamdbf/core)
YAMDBF is a lightweight Discord Bot framework for rapid bot development using [Discord.js](https://discord.js.org),
making it simple to get a bot up and running with minimal effort and configuration.
## Features
- 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
- Easy to use storage with support for custom storage providers
- Ships with a default JSON provider, and other optional providers using Sequelize:
- Postgres
- SQLite
- MySQL
- MSSQL
- Easy to use Plugin system
- 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
## Installation
Ignore any warnings about unmet peer dependencies as they are all optional unless
using a Sequelize-based storage provider.
>**Note:** YAMDBF Requires > Node 8.0.0 to run
- Regular install: `npm install --save @yamdbf/core`
- With the Postgres provider: `npm install --save @yamdbf/core pg sequelize`
- With the SQLite provider: `npm install --save @yamdbf/core sqlite3 sequelize`
- With the MySQL provider: `npm install --save @yamdbf/core mysql2 sequelize`
- With the MSSQL provider: `npm install --save @yamdbf/core tedious sequelize`
>Indev builds can be installed from NPM: `npm install --save @yamdbf/core@indev`
Documentation for indev builds can be found [here](https://yamdbf.js.org/indev).
Indev builds currently require >= Node 14.0.0 to run.
## Links
- [YAMDBF Documentation](https://yamdbf.js.org)
- [YAMDBF Discord server](https://discord.gg/cMXkbXV)
- [YAMDBF GitHub](https://github.com/yamdbf/core)
- [YAMDBF Issues](https://github.com/yamdbf/core/issues)
- [YAMDBF NPM](https://www.npmjs.com/package/@yamdbf/core)
- [YAMDBF Yarnpkg](https://yarnpkg.com/en/package/@yamdbf/core)
- [Zajrik on Patreon](https://patreon.com/zajrik)