https://github.com/ayfri/basic-commandhandler

This is a simple Command Handler with modules.
https://github.com/ayfri/basic-commandhandler

bot command-handler discord-js

Last synced: 10 days ago
JSON representation

This is a simple Command Handler with modules.

• Host: GitHub
• URL: https://github.com/ayfri/basic-commandhandler
• Owner: Ayfri
• Created: 2020-01-15T15:47:19.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-18T06:39:38.000Z (5 months ago)
• Last Synced: 2024-10-12T09:22:49.016Z (26 days ago)
• Topics: bot, command-handler, discord-js
• Language: JavaScript
• Homepage:
• Size: 175 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://github.com/Advanced-Command-Handler/Advanced-Command-Handler).

## How to use it

Simply clone this repo.

```bash

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

```

Set the [configuration](#Configuration) and you're ready to go.

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

```bash

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

```js

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

```js

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. |