Introduction

Reciple is a discord.js command handler framework.

Reciple Modules

Reciple scans the directory assigned in reciple.yml under modules.modulesFolders property. modules.modulesFolders can be the path of the folder of modules or glob pattern

Folder Structure

Example Structure

# Modules config

modules:
  modulesFolders:
    - './modules' # Scans the modules folder for module files

# Dir structure

modules/
├─ Module1.js
├─ Module2.js

Example Structure with Glob patterns

# Modules config

modules:
  modulesFolders:
    - './modules' # Scans the modules folder for module files
    - './modules/*' # Scans the folders of modules folder for module files

# Dir structure

modules/
├─ moreModules/
│  ├─ Module1.js
│  ├─ Module2.js
├─ Module3.js
├─ Module4.js

Module Structure

Module files can be ES Modules or CommonJs.

Supported module file types

.js This can be an ESM or CJS
.mjs
.cjs

Module file structure

Property	type	Required	Description
`versions`	`string\|string[]`	`true`	The versions of the Reciple client that the module script is compatible with. The versions can be a string or an array of strings.
`commands`	`(AnyCommandBuilder\|AnyCommandData)[]]`	`false`	The commands that are defined by the module script.
`onStart`	`(client: RecipleClient, module: RecipleModule) => Awaitable<boolean>`	`true`	The function that is called when the module script is started. The function must return a boolean value or a promise that resolves to a boolean value. The boolean value indicates whether the module script was started successfully.
`onLoad`	`(client: RecipleClient, module: RecipleModule) => Awaitable<void>`	`false`	The function that is called when the module script is loaded.
`onUnload`	`(unloadData: RecipleModuleUnloadData) => Awaitable<void>`	`false`	The function that is called when the module script is unloaded.

ESM module example

// Usage without classes

export default {
    versions: '^7',
    onStart: async client => {
        return true;
    },
    onLoad: async client => {},
    onUnload: async ({ client }) => {}
};

// Usage with classes

export class MyModule {
    versions = '^7';
    commands = [];

    async onStart(client) {
        return true;
    }

    async onLoad(client) {}
    async onUnload(unloadData) {}
}

export default new MyModule();

CommonJS module example

// Usage without classes

module.exports = {
    versions: '^7',
    onStart: async client => {
        return true;
    },
    onLoad: async client => {},
    onUnload: async ({ client }) => {}
};

// Usage with classes

class MyModule {
    versions = '^7';
    commands = [];

    async onStart(client) {
        return true;
    }

    async onLoad(client) {}
    async onUnload(unloadData) {}
}

module.exports = new MyModule();

Reciple Commands

instead of importing builders from you'll need to import command builders from reciple or @reciple/client.

- const { SlashCommandBuilder, ContextMenuCommandBuilder } = require('discord.js');
- import { SlashCommandBuilder, ContextMenuCommandBuilder } from 'discord.js';
+ const { SlashCommandBuilder, ContextMenuCommandBuilder } = require('reciple');
+ import { SlashCommandBuilder, ContextMenuCommandBuilder } from 'reciple';

You can add your commands in the commands property of your module script.

export default {
    versions: '^7',
    commands: [
        new SlashCommandBuilder()
            .setName('ping')
            .setDescription('Just a ping command')
            .setExecute(async ({ interaction }) => {
                await interaction.reply('Pong');
            })
    ],
    onStart: async client => {
        return true;
    }
};

Interaction command execute params

Param	Type	Required	Description
`interaction`	`ChatInputCommandInteraction\|AnyContextMenuCommandInteraction`	`true`	The command interaction that triggers the command
`client`	`RecipleCommand`	`true`	The current bot client
`builder`	`AnySlashCommandBuilder\|ContextMenuCommandBuilder`	`true`	The builder of the executed command
`commandType`	`CommandType`	`true`	The type of executed command

Message command execute params

Param	Type	Required	Description
`message`	`Message`	`true`	The message that triggers the command
`client`	`RecipleCommand`	`true`	The current bot client
`builder`	`AnySlashCommandBuilder\|ContextMenuCommandBuilder`	`true`	The builder of the executed command
`commandType`	`CommandType`	`true`	The type of executed command
`options`	`MessageCommandOptionManager`	`true`	The parsed options passed to this command

Handling command execute errors

Command halt function can handle command cooldown and errors. Return true if the error or cooldown is handled.

new SlashCommandBuilder()
    .setName('ping')
    .setDescription('Just a ping command')
    .setExecute(async ({ interaction }) => {
        await interaction.reply('Pong');
    })
    .setHalt(async haltData => {
        switch (haltData.reason) {
            case CommandHaltReason.Cooldown:
                await haltData.executeData.interaction.followUp('You\'ve been cooled-down');
                return true;
            case CommandHaltReason.Error:
                await haltData.executeData.interaction.followUp('An error occured');
                return true;
        }

        // The rest is unhandled
    })

NotGhex/pong-mc