Giter Club home page Giter Club logo

discord.js-commando-plus's Introduction

Commando-Plus

Dependency status peerDependencies status Build status

This is still a work in progress.

About

Commando-Plus extends on Commando. Info snippet from Commando:

It is flexible, fully object-oriented, easy to use, and makes it trivial to create your own powerful commands. Additionally, it makes full use of ES2017's async/await functionality for clear, concise code that is simple to write and easy to comprehend.

If you are looking for better support, and do not plan to use any of the features of Commando-Plus, please use Commando instead. This repository is mostly here to support my own Discord bots in order to share common used code between them without having to manually duplicate them in every repository.

Features on top of Commando

  • Easily extendable commands through third-party modules
  • Command responses can handle reactions
  • Limit commands to certain server channels (configurable through whitelisting commands)
  • Background workers
  • Supports caching with the Memory and Redis providers
  • Supports database storage with the MongoDB provider
  • Supports localization with the i18next provider (default locale is en-US)
  • Supports an additional settings provider: YAML

Installation

Node 8.0 or higher is required.
If you are using Node 8.2 or lower, you might have to run node with the harmony flag.

Commando-Plus supports additional features that have peer dependencies that need to be installed separately.

Install Commando-Plus by running: npm install archomeda/discord.js-commando-plus --save

Settings (required)

Create your own SettingsProvider, or use:

Localization (required)

Create your own LocaleProvider, or use:

Caching (optional)

Create your own CacheProvider, or use:

When using the RedisCacheProvider, Redis 3.2 is required as an additional dependency.

Database storage (optional)

Create your own StorageProvider, or use:

When using the MongoStorageProvider, MongoDB 3.4 is required as an additional dependency.

Documentation

discord.js-commando-plus's People

Contributors

archomeda avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

m7rlin

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.