@gary50613/djs-command-handler

simple discord.js command handler

Usage no npm install needed!

<script type="module">
  import gary50613DjsCommandHandler from 'https://cdn.skypack.dev/@gary50613/djs-command-handler';
</script>

README

djs-command-handler

Simple command handler for discord.js

繁體中文

Install

run this in your terminal

npm i @gary50613/djs-command-handler

Test

npm i
npm test

✨ Features

  • easy to set up
  • works perfectly with discord.js
  • ratelimit support
  • commands group support

Usage

basic how to initialize with options

const CommandHandler = require('@gary50613/djs-command-handler')
const Discord = require('discord.js')

// import a command
const ping = require("./commands/ping")

const bot = new Discord.Client()
const commandHandler = new CommandHandler(bot, {
    prefix: "."
    // options
})

// register a command
commandHandler.commands.register(ping)

// or register multiple command at the same time
commandHandler.commands.register([ping, ..., ...])

// listen to event
commandHandler.on("dm", (m) => {
    m.channel.send("u can only use command in a guild!")
})

bot.login(process.env.TOKEN)

make a command

const Command = require("@gary50613/djs-command-handler").Command

class Ping extends Command {
    constructor() {
        super(
            "ping", // name
            "ping the bot", // description
            ".ping", // usage
            "general", // group
            ["pong"] // alias
        );
    }
    
    // execute function to call
    execute(bot, message, args, member, guild) {
        // just write like normal discord.js
        message.reply('pong!')
    }
}

module.exports = Ping

Event

type description parameter
dm user execute a command in dm Message
ratelimit user get ratelimited Message
execute command successfully executed Command, Message
error command execute error Error, Command, Message

Reference

options

{
    ratelimit: {
        enable: false, // whether enable ratelimit
        interval: 5000, // interval to limit
        bypass: {
            users: [], // specific users ID can bypass ratelimit 
            permissions: ["ADMINISTRATOR"], // specific perimissions FLAG can bypass ratelimit
            roles: [] // // specific roles ID can bypass ratelimit
        }
    },
    prefix: "PREFIX", // bot's prefix
    dm: false, // whether accept dm commands
    bot: false // whether accept bot execute command  
}

Author

🧑‍💻 Kane

❤️ Contributing

Feel free to open issue or join my discord server