commanding.js

TABLE OF CONTENTS

• Installation
• Setup
• Changing Default Prefix
• Creating a Command
• Usage of minArgs and maxArgs
• Syntax Errors
  • Global Syntax Errors
  • Per Command Syntax Error
• Permissions
• MongoDB Connection
• Built in Commands
• Sources

Installation

NPM

npm i commanding.js

You can install the latest work in progress by -

npm i "https://github.com/CodyAaTherf/commanding.js#dev"

Note that these features are still in work in progress and some might not have been completed yet and your bot might break. You can check on to here to know more!

Setup

How to setup commanding.js -

const { Client , Intents } = require('discord.js')
const CommandingJS = require('commanding.js')
const { token } = require('./config.json')

const client = new Client({ intents: [Intents.FLAGS.GUILDS , Intents.FLAGS.GUILD_MESSAGES] });

client.once('ready' , () => {
    console.log("Ready!");

    new CommandingJS(client , 'commands')
})

client.login(token)

Prefixes

The default prefix of the bot on installing this package will be - > . You can change it in your main file using -

new CommandingJS(client)
    .setDefaultPrefix('!')

Creating a Command

Here's how to create a ping command -

module.exports = {
    name: 'ping' , // required
    commands: ['p'] ,
    description: 'Ping' , // optional
    callback: (message) => {
      message.reply('Pong!')
    }
}

You can either use commands: [''] or aliases: [''] , either works but you have to use one atleast.

Users can use >ping or >p and use the command.

minArgs & maxArgs

Minimum and Maximum number of args a user has to use before they can use the command. In this example the bot will ping the user you ping.

// ping-member.js

module.exports = {
    name: 'ping-member' ,
    commands: ['ping-member' , 'pingmember' , 'pm'] ,
    description: 'Bot pings the member you ping' ,
    minArgs: 1 ,
    maxArgs: 1 ,
    callback: (message) => {
        const { mentions } = message
        const target = mentions.users.first()

        if(target){
            message.channel.send(`Hello , ${target} !`)
        }
    }
}

Note - minArgs cannot be less than maxArgs or you will get an error.

Syntax Error

Global Syntax Error -

The default syntaxError is Wrong Syntax ! You can change it in your main file using -

new CommandingJS(client)
    .setSyntaxError("")

Per-Command Syntax Error -

You can specify the syntax error for each command using -

module.exports = {
    name: 'ping-member' ,
    commands: ['ping-member' , 'pingmember' , 'pm'] ,
    description: 'Bot pings the member you ping' ,
    syntaxError: 'wrong symtax! use {PREFIX}{COMMAND} <@mention>' ,
    minArgs: 1 ,
    maxArgs: 1 ,
    callback: (message) => {
        const { mentions } = message
        const target = mentions.users.first()

        if(target){
            message.channel.send(`Hello , ${target} !`)
        }
    }
}

You can use - {PREFIX} - to show the bot's perfix on the Error

{COMMAND} - command name

Permissions

Making a ban command or any other command that requires permissions? You can do it by -

module.exports = {
    name: 'ping' ,
    commands: ['p'] , // or aliases: ['p'] . either works
    description: 'Ping' ,
    requiredPermissions: ['ADMINISTRATOR'] ,
    callback: (message) => {
      message.reply('Pong!')
    }
}

Here are all the permissions that you might have to use.

MongoDB Connection

MongoDB Connection is optional. You will need it to use the built in commands or any commands that you use that requires to save data. You can define it in the main file using -

// index file

const config = require('./config.json')

new CommandingJS(client)
    .setMongoPath(config.mongo_uri)

config.json

{
    "token": "" ,
    "mongo_uri": ""
}

Built in commands -

>prefix - Displays the prefix of the bot

>prefix <new prefix> - Changes the prefix of the bot. It is supported per server. Required MongoDB Connection. See MongoDB Connection to know to to connect to MongoDB.

>command <enable | disable> <command name> - Enable or Disable any command. It is supported per server. Requires MongoDB Connection.

>commands - Displays all the current commands of the bot.

SOURCES

All these snippets have come from Commanding.JS Test Repository. It has been maintained by me itself.