Discord-Bot-Template

This template is used in all of my bots, it is lightweight, performant and simple to use. This has been based on the Discord.js NodeJS framework.

Getting Started

To get started simply enter your configuration into the JSON file location at references/configuration.json

Creating Commands

Setting Command Options

To create a command simply clone the commands/template.js rename it to the name of the command (not necessary but nice for organisational reasons), once that is completed you can modify the configuration found here.

command_model({
    name: "template",
    enabled: false,
    aliases: ["level"],
    description: "You can remove this template, it is just for demonstration purposes",
});

None of these options are necessary except for the command name, as they all default to these values.

"help": {
    "name": null,
    "description": null,
    "usage": [],
    "aliases": [],
}
"config": {
    "enabled": true,
    "permissionsBot": [],
    "permissionsUser": [],
    "guildOnly": false,
    "developerOnly": false,
}

Retrieving Command Options

All of these command options are retrievable from the this object within any of the command functions described below, an example of how to use this is also shown below for people new to Javascript.

command.run = async function (client, message) {
    console.log(this.help.name); // will retrieve the name of the command from the command options.
}

Using Command Functions

You can choose to include any of these within the configuration of the command, apart from the command options you can also set the functions that will run when specific conditions are met. This system is reliable and simple for you to customise.

command.run = async function(client, message) {
    // will be run when a command is triggered
};
// insert how to handle, otherwise bot will just ignore command
command.insufficentBot = async function (client, message, name) {
    // can customise what happens when missing permission
};
// insert how to handle, otherwise bot will just ignore command
command.insufficentUser = async function (client, message, name) {
    // can customise what happens when missing permission
};
// insert how to handle, otherwise bot will just ignore command
command.insufficentGuild = async function (client, message) {
    // can customise what happens when guildOnly and command is triggered not in a guild
};
// insert how to handle, otherwise bot will just ignore command
command.insufficentDeveloper = async function (client, message) {
    // can customise what happens when developerOnly and command is triggered but user is not developer
}

Adding Events

You can modify existing events and create new ones by following the pattern within events/ready.js, there is a simple function that passes in the client and then within that function you can designate what events you'd like to use as you normally would according to the Discord.js v13 docs.

Accessing Arguments

Arguments are split by ' ', you can access the array of arguments by calling message.args.