Mix (previously known as Forge) is a powerful, modular and extensible Discord bot framework for serious bot development.
Note: Mix is a library to create bots and not a Discord API wrapper library.
Note: This project has not yet reached a stable point, and not all functionality will work as expected.
Useful Links
- View the NPM package
- View the documentation (Still being written)
- View CLI utility on NPM
- Example bot
🍭 Quick Start with the CLI utility (recommended)
Get started quickly with your next Discord bot project by using our CLI tool!
To install and create a template bot in seconds, issue the following commands:
# Install the CLI utility $ npm install --global d.mix.cli$ mix new bot$ cd bot # Install node modules $ npm install # Configure your bot $ npm run config # Run the bot $ npm start
A bot boilerplate will be created under the bot
directory.
Congratulations, you are now ready to begin creating your next masterpiece.
Installing
To incorporate Mix into an existing project, simply issue the following command:
$ npm install --save d.mix
This will add Mix to your project's dependencies. You may now proceed to import/require Mix's classes and utilities:
;
Building
To build the project, use npm run build
or yarn build
if using the Yarn package manager.
Make sure that you have installed the project dependencies (npm install
or yarn
).
Contributing
Thanks for your interest in helping in the project. To contribute to this project, you will be required to use pull requests.
Helpful Snippets
- Commands
- Services
- Tasks
- Other
Additional Notes
Mix is intended for both serious, large scale and simple, elegant bot development, however it may not be suitable for everyone.
If such is the case, it may be worth considering the following fine alternatives:
📦 Klasa by Dirigeants
📦 Commando by discordjs
📦 yamdbf core by yamdbf team