@cloudrex/forge
The elegant bot framework
Last updated a year ago by cloudrex .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @cloudrex/forge 
SYNC missed versions from official npm registry.

Mix Logo
Build Status NPM Package


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 library.

Useful Links

=> View the NPM package

=> View the documentation (Still being written)

=> View CLI tool on NPM

=> Example bot

Quick Start with the CLI tool (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 @cloudrex/forge

Then you may proceed import/require Mix's classes:

import {Bot, Utils, Store} from "@discord.mix/mix";

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).

Features

  • Core
    • Generic "fragment" base model for all entities (commands, services, etc.)
    • Deep-loading for fragments
    • Support for regular expression loading
    • Dependency management (commands, services, etc.)
    • Fully modular (through interfaces)
      • Implement custom command handling
      • Basically everything is modular
    • Support for Hot-reloading any module(s) and/or fragment(s)
    • Automatic advanced optimization for large bots
    • Codebase is tested
    • Various syntaxes for creating components/fragments
      • Using decorators
      • Using class members
  • Commands
    • Aliases
    • Advanced argument support
      • Flag support (ex. --key or --key="value")
      • Type system with custom type(s) support
        • Mentions (users, channels, etc.)
        • Booleans ("yes", "no", "false", "true", etc.)
    • "Constraints" to limit execution
      • Cooldowns
      • Server permissions (both bot & issuer)
      • Chat environemnt (NSFW, DMs, etc.)
      • Specifics (guild(s), channel(s), member(s), role(s), etc.)
      • Ability to define custom constraints
    • Middleware "Guards" to limit execution
    • Connections "Relays" allow for relaying an execution event across multiple methods
    • Result feedback with reactions
    • Ability to emulate command execution
    • Ability to re-execute upon message edits
    • Support for multiple prefixes (includes regular expression prefixes)
  • Services
    • Run in the background
    • Direct access to all the bot's resources and modules
    • And more ...
  • Tasks
    • Recurring tasks
    • And more ...

Contributing

Thanks for your interest in helping in the project. To contribute to this project, you will be required to use pull requests.

Versioning

When contributing, please follow the Semantic Versioning guidelines.

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

Helpful Snippets

Command

Command with arguments

Service

Service with event handling

Service handling multiple events with the same action

Service with disposable resources

Forked service

Task

Recurring task

Serializer

Current Tags

  • 1.2.5-beta.13                                ...           beta (a year ago)
  • 1.2.5                                ...           latest (a year ago)

39 Versions

  • 1.2.5                                ...           a year ago
  • 1.2.5-beta.13                                ...           a year ago
  • 1.2.5-beta.12                                ...           a year ago
  • 1.2.5-beta.11                                ...           a year ago
  • 1.2.5-beta.10                                ...           a year ago
  • 1.2.5-beta.9                                ...           a year ago
  • 1.2.5-beta.8                                ...           a year ago
  • 1.2.5-beta.7                                ...           a year ago
  • 1.2.5-beta.6                                ...           a year ago
  • 1.2.5-beta.5                                ...           a year ago
  • 1.2.5-beta.4                                ...           a year ago
  • 1.2.5-beta.3                                ...           a year ago
  • 1.2.5-beta.2                                ...           a year ago
  • 1.2.5-beta.1                                ...           a year ago
  • 1.2.5-beta.0                                ...           2 years ago
  • 1.2.4                                ...           2 years ago
  • 1.2.3                                ...           2 years ago
  • 1.2.2                                ...           2 years ago
  • 1.2.1                                ...           2 years ago
  • 1.1.9                                ...           2 years ago
  • 1.1.8                                ...           2 years ago
  • 1.1.7                                ...           2 years ago
  • 1.1.6                                ...           2 years ago
  • 1.1.5                                ...           2 years ago
  • 1.1.4                                ...           2 years ago
  • 1.1.3                                ...           2 years ago
  • 1.1.2                                ...           2 years ago
  • 1.1.1                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.9                                ...           2 years ago
  • 1.0.8                                ...           2 years ago
  • 1.0.7                                ...           2 years ago
  • 1.0.6                                ...           2 years ago
  • 1.0.5                                ...           2 years ago
  • 1.0.4                                ...           2 years ago
  • 1.0.3                                ...           2 years ago
  • 1.0.2                                ...           2 years ago
  • 1.0.1                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 39
This Month 39
Last Day 0
Last Week 0
Last Month 40
Dependencies (14)
Dev Dependencies (19)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |