~ discordjs-cmds ~

Simple-to-use command parser for discord.js

 

npm install discordjs-cmds --save

• Disclaimer
• Usage
• Default Commands
• Changelogs
• To-Do
• Docs
  • Constructor
  • Properties
  • Events
  • Methods

This project is currently in an early development phase, which means, that there could be some unidentified bugs. Also, there will be much more functions added and advanced later! Feel free to post issues or pull request if you noticed a bug or if you have improvement suggestions!

Implement the library, create your bot framework and create an instance of the CmdParser

const { Client } = require('discord.js')
const { CmdParser } = require('discordjs-cmds')

// Creating bot instance
const bot = new Client()
// Creating CmdParser  Instance
const cmd = new CmdParser(bot, "-")

// Login the bot instance with your discord token
bot.login(/*bot token*/)

Now, create some methods for commands somewhere

function cmd_say(msg, args) {
    msg.channel.send(args.join(' '))
}

function cmd_ping(msg, args) {
    msg.channel.send('Pong!')
}

// ...

Then, you can register your commands like following

cmd.register(cmd_say, "say", ["tell", "send"], "Send a message with the bot", "-say <msg>", cmd.type.CHAT, 1)
   .register(cmd_ping, "ping")

For permissions, you can register specific permission levels for specific roles

cmd.setPerms(["2134792837489213749", "2319480812347123431"], 1)
   .setPerms("8757023480239487232", 2)

If you want to react on some events the CmdParser event manager fires, use it like following

cmd.event.on('commandFailed', (errtype) => console.log(`Failed Command: ${errtype}`))

There are some default implemented commands:

Sends the user a list of commands via DM

Get the help message of a registered command

All changelogs (after version 0.3.0) you can find in the CHANGELOG.md.

• Add option + function to give guild owners higher perm lvl
• Method to register bot host with max perm lvl
• Guild specific prefixes
• Custom command types
• Aliases
• Permissions
• Detailed help command

new CmdParser(botinstance, prefix)

Returns CmdParser this

Some standardised enum like types for commands

• ADMIN: ADMIN
• GUILDADMIN: GUILDADMIN
• MODERATION: MODERATION
• FUN: FUN
• SETTING: SETTING
• CHAT: CHAT
• MISC: MISC

Some standardised enum like error codes for event emitter

• WRONG_INVOKE: 0
• NOT_PERMITTED: 1
• EXECUTION_ERROR: 2
• WRONG_CHANNEL: 3

Emitted when command was executed successfully

Emitted when command could not be parsed correctly

Emitted when command could not be written correctly into log file

Register commands with their properties

Returns CmdParser this

Define permission levels to specified roles

Returns CmdParser this

Edit some default options of command parser

Returns CmdParser this

Set the Discord account of the host of the bot for maximum permission

Returns CmdParser this

Set the specific prefixes for guils

Returns CmdParser this

Get the permission level of a member

Returns number Permission Level

Add some custom command types. In registration, they can used like the defualt types cmdParser.type.YOURTYPE or directly with the string "YOURTYPE". Keep in mind, that command types are always processed to uppercase, so also if you enter lowercase, it wil lautomatically converted to uppercase.

Returns CmdParser this

Parse message as command. Defaultly, the CmdParser creates a listener for messages in public text channels which listens to messages, so just use this if you want to parse commands for example in private chats.

Returns CmdParser this

Send a help message into a channel. If invoke is not given, sending full command list, else sending information about given command invoke

Returns Discord.Message Message sendt into channel