easy-djs-bot

A simple module that simplify the DiscordJS coding.

About DiscordJS

discord.js is a powerful Node.js module that allows you to easily interact with the Discord API.

• Object-oriented
• Predictable abstractions
• Performant
• 100% coverage of the Discord API

Installation

Node.js 16.6.0 or newer is required.

npm install easy-djs-bot

Example usage

const bot = require('easy-djs-bot');

bot.setPrefix('!');
bot.setToken('PUT YOUR DISCORD BOT TOKEN HERE');

bot.setHelpCategory([
    {
        name: "🌀 Other",
        value: "All commands without category"
    },
    {
        name: "🚷 Admin",
        value: "Commands for Admins"
    }
])$

async function pingEvent(author, guild, channel, args) {
    bot.channel.send(channel.id, guild.id, `Pong again, __${author.username}__! Arguments: \`${args.join(' ; ')}*\``)
}

bot.createCommand({
  name: 'ping', // Name of the command (must be unique)
  reply: 'Pong!', // Set to false for no reponse
  category: "🌀 Other", // Must be a existant category (defined with the .setHelpCategory() function)
  ping: true, // Ping the user that used the command ?
  description: "Ping the bot!", // The description to see in the help command
  permissions: ['ADMINISTRATOR', 'MANAGE_GUILD', '...'], // For no permissions, just set permissions to false.
  execute: pingEvent // Set to false or put a function to execute when the command is executed
}, true); // Set to false for no prefix (only for this command)

bot.createCommand({
    name: "pause",
    reply: "The bot is now sleeping! Use the _!unpause_ command to unpause the bot",
    category: "🚷 Admin",
    ping: true,
    description: "Pause the bot.",
    permissions: ["ADMINISTRATOR"],
    execute: bot.pause
}, true);
bot.createCommand({
    name: "unpause",
    reply: "The bot is now unpaused!",
    category: "🚷 Admin",
    ping: true,
    description: "Unpause the bot.",
    permissions: ["ADMINISTRATOR"],
    execute: bot.unpause,
    ignorePause: true
}, true);

bot.waitForCommand() // Start the bot

Links

• GitHub
• NPM
• Discord

Help

If you the documentation throw an Error or an error has occured in your code and the documentation don't say what you need to do, you can report it in this github, send a Discord message on the Discord or send a mail to this email : [email protected]