@ming-suhi/djs-commando

I. About

A discord.js extension for easily creating and managing your Discord Slash Commands. For an in-depth documentation visit the documentation website. Or join the support server to meet the developer. Please note that this package is not associated with discord.js.

II. Quick Start

A. Installing

Run npm install on the command line or terminal.

npm install @ming-suhi/djs-commando

B. Setting Environment

1. Create a .env file in the root directory

   COMMANDS_FOLDER =
   

2. Create a folder to hold command files. Store the folder path from main as COMMANDS_FOLDER.

C. Setting Handler

1. Require InteractionsHandler from @ming-suhi/djs-commando.

   const { InteractionsHandler } = require('@ming-suhi/djs-commando');

2. Create an instance of InteractionsHandler

   const handler = new InteractionsHandler();

D. Creating a Command

1. Create a file inside the commands folder.

2. Require Command.

   const { Command } = require('@ming-suhi/djs-commando');

3. Create a new class extending Command.

   const ping = new class extends Command {
     constructor() {
       super();
       // Properties here
     }
   }

4. Define class properties inside constructor. Refer to Discord Developer Portal for valid property values.

   this.name = "ping";
   this.description = "short description"; 

5. Create execute method which accepts one parameter. The parameter is an instance of Interaction class of discord.js, which is received during interactionCreate event of discord.js.

   async execute(interaction) {
     await interaction.reply("Pong");
   }

6. Export created class. If using typescript please also export as shown below.

   module.exports = ping;

E. Adding Command Options

1. Require the desired options.

const { StringField } = require('@ming-suhi/djs-commando');

2. Create instance, and extend classes for subcommand group and subcommand.

const message = new StringField('message', 'message to echo', true);

3. Pass options to super inside an array. Refer to documentation for the options that can be passed to command, subcommand group and subcommand.

const echo = new class extends Command {
  constructor(){
    super([message]);
    this.name = 'echo';
    this.description = 'echo a message';
  }
}

4. Additional Notes: If you have subcommands, make sure that only the top command is exported.

F. Synching Commands

It is suggested to sync commands on ready. Synching commands posts and updates commands, as well as deletes commands unexisting in the commands folder. Synching commands bulk updates commands and it is important to note that the recently posted commands cannot be immediately used/seen.

client.on('ready', async() => {
  handler.syncCommands(client);
});

G. Receiving Commands

This will find the matching command and execute it.

client.on('interactionCreate', async interaction => {
  await handler.handleInteraction(interaction);
});

III. Additional Feature: Event Handling

A. Setting Environment

1. Create a folder to hold event files. Store the folder path from main as EVENTS_FOLDER.

B. Setting Handler

1. Require EventsHandler from @ming-suhi/djs-commando.

   const { EventsHandler } = require('@ming-suhi/djs-commando');

2. Create an instance of InteractionsHandler

   const handler = new EventsHandler();

C. Creating Event Handler

1. Create a file inside the events folder. File name must be the same as event name.

2. Create object, set name property as the name of event

3. Set run as the function to run on event

4. Export event

   module.exports = {
     name: 'ready',
     run() {
       console.log('Ready!');
     }
   } 

D. Registering events

It is suggested to register events on ready.

handler.registerEvents(client);

IV. Additional Feature: Call context menu command using message reply

Context menu commands are not yet available on mobile, so a round-about for this is calling context menu commands through message reply. Just simply reply the command name or alias to the target message or user to call on the corresponding context menu command.

A. Creating onReply method

Create a onReply method for the command which accepts one parameter which is an instance of Message class of discord.js.

async onReply(message) {
  await message.channel.send("Pong");
}

B. Receiving commands

This will find the matching command and execute the onReply method.

client.on('messageCreate', async message => {
  await handler.handleMessage(message);
});

V. Contributing

A. Issues

This project uses GitHub Issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue.

For help and questions about using this project, please open a GitHub issue.

B. Pull requests

1. Fork the project.

2. Create a topic branch from master.

3. Make some commits to improve the project.

4. Push this branch to your GitHub project.

5. Open a Pull Request on GitHub.

6. Discuss, and optionally continue committing.

V. License

MIT © 明suhi