decord v1.0.5

Decord

• What is decord?

Decord is a yet another frame-work for discord.js, this was inspired by discord-akairo

This in beta!!

Default / Built-in Commands

• help
• decode - Same as a help command

More Coming Soon

const { Client } = require("./index");
const path = require("path");
// client is extended from discord.client

const client = new Client({
  ownerID: ["241632903258177536"], // Add in your bot owners by IDs
  getPrefix: () => "d!", // Change the default prefix
  status: {
    type: "LISTENING",
    statuses: ["Decord official bot", "!help"],
  }, // Set the bot's status
}); // Obviously these client options are all optional if you want a regular bot with all default settings. The ownerID option is required if you want to have owner only commands.

client.registerCommands(path.join(__dirname, "./commands"), client); // register commands

client.registerDefaultCommands(client); // register the default commands

client.registerDefaultEvents(client); // register the default events decord provides

client.loadPlugins("./plugins", client); // load plugins if you have any

client.db("mongodb connection string here");

client.login("YOUR_TOKEN_HERE"); // login as usual

Methods

registerDefaultEvents(parameters) - Register the default events

Parameters: client - Your discord client ex: (client)

loadPlugins(parameters) - Load the plugins in a directory

Parameters : Path to your file, client - ex : ('./plugin', client)

registerCommands(parameters)

Events file

• This is how you events file should look like :

module.exports = {
    event: 'event_name',
     once: if event should be .on or .once
 execute(event_parameters, client) {

// code here

 }
};

Explanation

event - the event this should run, ex: ready once - set to true if its should be run on client.once execute - must be a function, where your code is,

parameters for execute are parameters for the event your listening for + client at the end

Example

• ready event

module.exports = {
  event: "ready",
  once: true,
  execute(client) {
    console.log(`Ready! Logged in as ${client.user.tag}`);
  },
};

Ignoring commands/events/plugins

• All the events to register a default event/ default command/command/event has a parameter named ignored${type}, you can use this to skip over events you don't need or, use it for debugging to see if a certain event is the issue without removing code or file

• As a example we here is how to disable a event (here built in ready)

client.registerDefaultEvents(client, [
    ready: false
])

Planned Features and commands

• load - Default Command
• Unload - Default Command
• Enable - Default Command
• Disable - Default Command

Current features

• Ability to set the bot owner
• Ability to set command permissions
• Ability to set cooldowns. NOTE: THE NUMBER MUST BE IN SECONDS. Ex: miliseconds: 3000, seconds: 3
• Ability to make a command guild only,
• Customizable Command Categories
• Default commands (Check the Default / built-in commands section for a list of built-in commands
• Command Aliases
• directory command option - required to work. Ex: dir: __dirname
• decord command
• eval subcommand for decord command
• reload subcommand for decord command
• execute subcommand for decord command
• MongoDB Support

Mongodb Setup

client.db("mongo connection string");

Additional information

Discord.js guide

discord.js documentation