/Basic-CommandHandler

This is a simple Command Handler with modules.

Primary LanguageJavaScript

Basic CommandHandler

This is a simple Command Handler using module.exports for a configuration, run function and help module for a help command auto-generated.

I'd advice you to know JavaScript and Node.js before using it.
You'll understand that this Command Handler is very basic and for a big projet you should probably use a better one.
I can recommend you the other one I've made : Advanced Command Handler.

How to use it

Simply clone this repo.

git clone https://github.com/Ayfri/Basic-CommandHandler

Set the configuration and you're ready to go.

If you want to use Discord.js v12, use this command instead.

git clone -b v12 https://github.com/Ayfri/Basic-CommandHandler

It will clone the v12 branch of this repo.

Configuration

To start the bot you have to start with NodeJS the main.js file. If you want the bot to be sharded, start with le index.js file. There is a configuration file, informations/config.json. In owners you have to add your ID (in a String).

Templates

Command

module.exports.run = async (client, message, args) => {
	// Code goes here.
};

module.exports.config = {
	category: '',
	name: __filename.slice(__dirname.length + 1, __filename.length - 3),
	aliases: [],
	serverForced: false,
};

module.exports.help = {
	description: '',
	syntax: ``,
	examples: ``,
};

The name of the command is the name of the file. All the props in the modules are required.

Event

module.exports = async (client, event, args) => {
	// Code goes here.
};

Features

There are already managed categories :

  • not-ready : Like owner category.
  • owner : Owners only (configuration).
  • administration : Only users that have the ADMINISTRATOR permission.
  • moderation : Only users that have the KICK_MEMBERS permission.

The client object has added methods and props like :

Field name Description
commands Enmap Object.
writeFile( Path, JSObject ) Safely save your JSObject in a JSON.