Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/discordjs/commando

Official command framework for discord.js
https://github.com/discordjs/commando

bot commando discord discord-api discord-bot discordjs framework

Last synced: 4 months ago
JSON representation

Official command framework for discord.js

Host: GitHub
URL: https://github.com/discordjs/commando
Owner: discordjs
License: apache-2.0
Archived: true
Created: 2016-09-09T22:34:14.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2021-08-10T21:03:33.000Z (over 3 years ago)
Last Synced: 2024-04-14T02:42:17.477Z (9 months ago)
Topics: bot, commando, discord, discord-api, discord-bot, discordjs, framework
Language: JavaScript
Homepage:
Size: 2.08 MB
Stars: 500
Watchers: 22
Forks: 246
Open Issues: 36
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Commando

[![Discord](https://discordapp.com/api/guilds/222078108977594368/embed.png)](https://discord.gg/bRCvFy9)

[![Downloads](https://img.shields.io/npm/dt/discord.js-commando.svg)](https://www.npmjs.com/package/discord.js-commando)

[![Version](https://img.shields.io/npm/v/discord.js-commando.svg)](https://www.npmjs.com/package/discord.js-commando)

[![Dependency status](https://david-dm.org/discordjs/Commando.svg)](https://david-dm.org/discordjs/Commando)

[![Build status](https://github.com/discordjs/Commando/workflows/Testing/badge.svg)](https://github.com/discordjs/Commando/actions?query=workflow%3ATesting)

## About

Commando is the official command framework for [discord.js](https://github.com/discordjs/discord.js).

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.

## Features

- Plain command names and aliases

- Regular expression triggers

- Robust parsing of arguments (with "quoted strings" support)

- Sophisticated argument system (optional)

	* Automatic prompting for arguments that aren't provided

	* Type system with rules, automatic validation, and parsing to usable values

		- Basic types (string, integer, float, boolean)

		- Discord objects (user, member, role, channel, message)

		- User-defined custom types

		- Union types

	* Automatic re-prompting of invalid arguments

	* Optional arguments with default values

	* Infinite arguments (arguments that accept as many values as provided)

- Multiple responses to commands

- Command editing (user edits their message that triggered the command, and the bot's response updates with it)

- Command reloading, as well as loading/unloading

- Command throttling/cooldowns

## Installation

**Node 12.0.0 or newer is required.**  

`npm install discord.js@12 discord.js-commando`

## Documentation

[View the docs here.](https://discord.js.org/#/docs/commando)  

See the [discord.js documentation](https://discord.js.org/#/docs) as well.