oranged-api

This package is still under development. Not all features are done yet.

Table of Contents

• Installation
• Setup
• Creating a Feature
• Configuring a Feature
• Creating a Command
• Command Categories
• Command Initialization Method
• Argument Rules
• Per-server Command Prefixes
• Bot Owner Only Commands
• Guild Only Commands
• Custom Dynamic Help Menu
• Enable or Disable a Command
• Required Permissions
• Configurable Required Roles
• Command Cooldowns
  • Global Cooldowns
• Language Support
  • Language Configuration
  • Storing custom messages and translations
  • Loading message text
  • Global Syntax Errors
• Events
• Test Servers
• Support & Feature Requests

Installation

NPM

npm install oranged-commands

Setup

After you have installed OrangedCommands there is a simple setup process. You have the ability to pass in an options object to customize OrangedCommands:

const DiscordJS = require('discord.js')
const OrangedCommands = require('oranged-commands')
require('dotenv').config()

const client = new DiscordJS.Client({
  partials: ['MESSAGE', 'REACTION'],
})

client.on('ready', () => {
  // See the "Language Support" section of this documentation
  // An empty string = ignored
  const messagesPath = ''

  // Used to configure the database connection.
  // These are the default options but you can overwrite them
  const dbOptions = {
    keepAlive: true,
    useNewUrlParser: true,
    useUnifiedTopology: true,
    useFindAndModify: false,
  }

  // Initialize OrangedCommands with specific folders and MongoDB
  new OrangedCommands(client, {
    commandsDir: 'commands',
    featureDir: 'features',
    messagesPath,
    showWarns: false, // Show start up warnings
    dbOptions
  })
    // Set your MongoDB connection path
    .setMongoPath(process.env.MONGO_URL)
    // Set the default prefix for your bot, it is ! by default
    .setDefaultPrefix('!')
})

client.login(process.env.TOKEN)

Creating a Feature

Features are files that include code related to one specific feature of your bot. These often will include event handlers and other utility functions that collectively make up a single feature.

Here is a basic example that simply console logs each message sent:

// File name: "log-messages.js"
// Folder: "./features"

module.exports = (client, instance) => {
  client.on('message', (message) => {
    console.log(message.content)
  })
}

client is the Discord JS client for your bot.

instance is the OrangedCommands instance that contains some helper functions.

Each file inside of the "features" folder (or whatever you specified in "Setup") will be ran whenever your bot starts up.

Configuring a Feature

Often times you may want to only load a feature once your database is connected to. This is useful if you load data from your database when initializing your feature.

You can export a config object to delay loading of a feature until your database is connected, as well as specify displayName and dbName properties:

module.exports = (client, instance) => {
  console.log('something that requires a database connection')
}

module.exports.config = {
  displayName: 'Test', // Can be changed any time
  dbName: 'TEST', // Should be unique and NEVER be changed once set
  loadDBFirst: true, // Wait for the database connection to be present
}

loadDBFirst will make this feature only load once your bot has successfully connected to your database.

displayName is a name that will eventually be used in this package for enable/disable functionality. This is what users will see when interacting with your bot.

dbName is something that once set should NEVER be changed. This is what will be used to keep track of what features are enabled or disabled in each Discord server. Separating these two means you can rename what your user's see without breaking what servers have a feature enabled or disabled. This property should always be in upper case.

Creating a Command

Creating a command is simple using OrangedCommands:

Here's an example of a basic ping command:

// File name: "ping.js"
// Folder "./commands"

module.exports = {
  aliases: ['p'], // Optional
  callback: ({ message }) => {
    message.reply('pong')
  }
}

Running !ping or !p will execute this command and reply with "pong". The name of the file is included as a command alias by default.

You can also specify a name property for the command, as well as use a commands array for aliases:

// File name: "ping.js"
// Folder "./commands"

module.exports = {
  name: 'ping', // Optional
  commands: ['runping'], // Optional
  aliases: ['p'], // Optional
  callback: ({ message }) => {
    message.reply('pong')
  }
}

This will make !ping, !runping, and !p execute the command. There are various popular command formats. This approach of multiple options is meant to help support them out of the box without many changes on your part.

The callback function can also be named run or execute. This function has one object parameter with the following properties:

1. message: The standard Message object
2. args: An array of all arguments provided with the command
3. text: A string version of the args array
4. client: The Discord.JS client for your bot
5. prefix: The prefix for the server this command is being ran in, or "!" is one is not set
6. instance: The OrangedCommands instance which will contain some helper methods

Example:

// File name: "ping.js"
// Folder "./commands"

module.exports = {
  callback: ({ message, args, text, client, prefix, instance }) => {
    message.reply('pong')
  }
}

These properties are inside of an object so you can access any of them individually. For example if you need the instance then you won't need to access all previous parameters before accessing instance.

Command Categories

You can also specify an optional command category for each command:

// File name: "ping.js"
// Folder "./commands"

module.exports = {
  category: 'Fun',
  callback: ({ message }) => {
    message.reply('pong')
  }
}

This is most useful for a dynamic help menu. The default dynamic help menu uses category emojis to navigate between pages. You can set a category's emoji with the following method:

const DiscordJS = require('discord.js')
const OrangedCommands = require('oranged-commands')
require('dotenv').config()

const client = new DiscordJS.Client()

client.on('ready', () => {
  // Initialize OrangedCommands with specific folders and MongoDB
  new OrangedCommands(client, {
    commandsDir: 'commands',
    featureDir: 'features'
  })
    .setMongoPath(process.env.MONGO_URL)
    .setDefaultPrefix('?')
    // Set the category emoji by using it's settings:
    .setCategorySettings([
      {
        name: 'Fun',
        emoji: '🎮'
      },
      {
        name: 'Economy',
        emoji: '💸'
      },
      {
        // You can change the default emojis as well
        name: 'Configuration',
        emoji: '🚧',
        // You can also hide a category from the help menu
        // Admins bypass this
        hidden: true
      }
    ])
})

client.login(process.env.TOKEN)

The category name "Fun" must match the exact name specified in your commands, this is case sensitive.

Command Initialization Method

Some commands may require you to run code when they are loaded. This will often include create a basic listener, or fetching data from some source.

You can use the init() method within your command to handle this type of functionality:

// File name: "ping.js"
// Folder "./commands"

module.exports = {
  category: 'Fun',
  init: (client, instance) => {
    console.log('ran only one time when the bot starts up')
  },
  callback: ({ message }) => {
    message.reply('pong')
  }
}

client is the Discord JS client for your bot.

instance is the OrangedCommands instance that contains some helper functions.

Argument Rules

You can easily specify how many arguments are required as well as provide an error message per command. Let's say that you want the above "ping" command to never have any arguments. You can easily accomplish that with the following code:

// File name: "ping.js"
// Folder "./commands"

module.exports = {
  minArgs: 0,
  maxArgs: 0,
  syntaxError: 'Incorrect syntax! Use `{PREFIX}ping`',
  callback: ({ message }) => {
    message.reply('pong')
  }
}

Or let's say you wanted one argument of tagging a member, and no maximum number of arguments:

// File name: "ping.js"
// Folder "./commands"

module.exports = {
  minArgs: 1,
  maxArgs: -1, // -1 means no limit
  syntaxError: "Incorrect syntax! Use `{PREFIX}ping <Target user's @>`",
  callback: ({ message }) => {
    message.reply('pong')
  }
}

In either case the {PREFIX} will be replaced with the server's prefix. If the server prefix hasn't been set it will default to "!".

Per-Server Command Prefixes

This feature requires a database connection to be present.

Allowing server owners to configure your bot's prefix will help prevent prefix collisions with existing bots. There is a simple command for server owners to configure prefixes:

!prefix [NEW PREFIX]

The NEW PREFIX argument is optional, and omitting it will simply display the current prefix. By default OrangedCommands uses "!" as it's command prefix.

Bot Owner Only Commands

Sometimes you might want to make a command that only the bot owner will have access to. An example of this would be a status command that updates the "Playing" status of your bot. You can do so by first specifying your Discord ID:

const DiscordJS = require('discord.js')
const OrangedCommands = require('oranged-commands')
require('dotenv').config()

const client = new DiscordJS.Client({
  partials: ['MESSAGE', 'REACTION'],
})

client.on('ready', () => {
  new OrangedCommands(client, , {
    commandsDir: 'commands',
    featureDir: 'features'
  })
    // Use your own ID of course
    // If you have only 1 ID you can pass in a string instead of an array
    .setBotOwner(['722568849932943505', 'another id', 'another id'])
})

client.login(process.env.TOKEN)

After that you can specify a command to only work for owners like so:

// File name: "ping.js"
// Folder "./commands"

module.exports = {
  ownerOnly: true,
  callback: ({ message }) => {
    message.reply('pong')
  },
}

Guild Only Commands

Often times you will want to make a command only work within guilds and not within direct messages. You can easily do this by specifying "guildOnly" like so:

// File name: "ping.js"
// Folder "./commands"

module.exports = {
  guildOnly: true,
  callback: ({ message }) => {
    message.reply('pong')
  },
}

Custom Dynamic Help Menu

The OrangedCommands package ships with a dynamic help menu out of the box, however each help menu is different and your bot might require specific needs. You can overwrite the default help command by creating your own:

// Folder: "commands"
// File: "./help.js"

module.exports = {
  callback: ({ message, args, text, client, prefix, instance }) => {
    instance.commandHandler.commands.forEach((command) => {
      console.log(command)
    })
  }
}

This will log important information regarding each command. You can use this within a help command to display a meaningful dynamic help menu.

Enable or Disable a Command

This feature requires a database connection to be present.

Server owners might not want all commands your bot comes with. It's important to allow them to enable or disable each command, and OrangedCommands comes with this functionality out of the box.

Server owners can toggle a command with the following command:

!command <"enable" | "disable"> <Command Name>

Required Permissions

Sometimes you will want to require a Discord permission node before a user can run a command. An example could be an administrative command. Requiring "ADMINISTRATOR" will prevent people without that permission node from running the command. You can easily do that with the following syntax:

// File name: 'hi.js'
// Folder: './commands'

module.exports = {
  maxArgs: 0,
  requiredPermissions: ['ADMINISTRATOR'],
  callback: ({ message }) => {
    message.reply('hello')
  },
}

Whenever anyone runs that command that doesn't have the "ADMINISTRATOR" permission node, it will tell them they need it. Also if you spell a permission node incorrectly or not upper case it will automatically let you know when your bot starts up.

Configurable Required Roles

This feature requires a database connection to be present.

Server owners will often want some commands to only be accessible from users with a specific role. Server owners will have the option to require this for any command your bot provides using the following command:

!requiredRole <Command Name> <"none" | Tagged Role | Role ID string>

This will allow server owners to dynamically configure commands for their own server without you needing to change anything as the developer. This is ideal because each will have its own rank for some commands and features. Forcing that rank to be named something specific is constrictive and this option makes your bot more user friendly.

Using "none" will remove all required roles for that command.

Command Cooldowns

This feature might require a database connection to be present.

OrangedCommands makes it easy to provide per-user cooldowns. These will only affect users in the server where they ran the command, and not globally across multiple servers using your bot.

// File name: "ping.js"
// Folder "./commands"

module.exports = {
  cooldown: '60s',
  callback: ({ message }) => {
    message.reply('pong')
  }
}

The cooldown can be specified using the following format:

Character	Duration	Minimum	Maximum	Example
s	Seconds	1	60	30s
m	Minutes	1	60	10m
h	Hours	1	24	5h
d	Days	1	365	3d

For durations over 5 minutes a database connection is STRONGLY RECOMMENDED. Cooldowns with a duration larger than 5 minutes will automatically be updated to your database every 20 seconds. These durations will be loaded when your bot starts up, this ensures that restarts do not affect cooldowns.

Global Cooldowns

This feature might requires a database connection to be present.

Some use cases might require a global cooldown over all users for a specific server. This can be easily done with the following:

// File name: "ping.js"
// Folder "./commands"

module.exports = {
  globalCooldown: '10m',
  callback: ({ message }) => {
    message.reply('pong')
  }
}

The minimum duration is 1 minute for global cooldowns. For durations over 5 minutes a database connection is STRONGLY RECOMMENDED. Cooldowns with a duration larger than 5 minutes will automatically be updated to your database every 20 seconds. These durations will be loaded when your bot starts up, this ensures that restarts do not affect cooldowns.

For more examples of the cooldown format please see the chart at Command Cooldowns.

Language Support

Language Configuration

Server owners can configure what language messages are sent in, you can do so with this simple command:

!language [new language]

If server owners want to see what language is currently set they can simply omit the new language argument and run:

!language

Storing custom messages and translations

As the developer you can create a messages.json file that contains your own text and translations. There are two types of objects within this file: direct messages and embeds. Direct messages will be a single message in different languages, while embeds will contain different types of fields. An example of each:

Direct messages:

{
  "NEW_LANGUAGE": {
    "english": "Language set to {LANGUAGE}.",
    "spanish": "Idioma configurado en {LANGUAGE}."
  }
}

Embed:

{
  "HELP_MENU": {
    "TITLE": {
      "english": "Help Menu",
      "spanish": "Menú de ayuda"
    }
  }
}

You can find the default messages.json here: https://github.com/AlexzanderFlores/OrangedCommands/blob/main/src/messages.json. You will also need to define where your messages.json file lives in the OrangedCommands constructor like so:

// Assumes messages.json is in the same directory as this code's file
new OrangedCommands(client, , {
    commandsDir: 'commands',
    featureDir: 'features',
    messagesPath: 'messages.json'
  })

Loading message text

You should not load text from your messages.json file directly, instead there is a built-in function to ensure the correct language is returned. A simple example:

// messages.json
{
  "EXAMPLE": {
    "english": "An example message",
    "spanish": "Un mensaje de ejemplo"
  }
}

// File name: "example.js"
// Folder "./commands"

module.exports = {
  callback: ({ message, args, text, client, prefix, instance }) => {
    const { guild } = message
    message.reply(instance.messageHandler.get(guild, 'EXAMPLE'))
  },
}

If you ran the "!example" in a server it will reply with "An example message". If that server was configured to Spanish it will reply with "Un mensaje de ejemplo" instead.

You can set dynamic placeholders in your messages like so:

// messages.json
{
  "EXAMPLE": {
    "english": "An example message. {TEST}",
    "spanish": "Un mensaje de ejemplo. {TEST}"
  }
}

You can then dynamically insert values like so:

// File name: "example.js"
// Folder "./commands"

module.exports = {
  callback: ({ message, args, text, client, prefix, instance }) => {
    const { guild } = message
    message.reply(instance.messageHandler.get(guild, 'EXAMPLE', {
      TEST: 'hello world'
    }))
  },
}

Now running !ping will display "An example message. hello world".

Global Syntax Errors

In a lot of cases your syntax errors will be very similar. You can specify a global syntax error within your messages.json file like so:

{
  "SYNTAX_ERROR": {
    "english": "Incorrect usage! Please use \"{PREFIX}{COMMAND} {ARGUMENTS}\"",
    "spanish": "¡Uso incorrecto! Utilice \"{PREFIX} {COMMAND} {ARGUMENTS}\""
  },
}

The {PREFIX}, {COMMAND} and {ARGUMENTS} must always be in upper case. These will be replaced with the correct content when an error occurs. The {ARGUMENTS} variable must be specified in the command like so:

// File name: "ping.js"
// Folder "./commands"

module.exports = {
  minArgs: 1,
  maxArgs: -1, // -1 means no limit
  expectedArgs: "<Target user's @>",
  callback: ({ message }) => {
    message.reply('pong')
  }
}

A per-command syntax error message will always overwrite a global one for that specific command.

Events

This package includes some useful events. Here is an example of listening to all supported events:

const DiscordJS = require('discord.js')
const OrangedCommands = require('oranged-commands')
require('dotenv').config()

const client = new DiscordJS.Client()

client.on('ready', () => {
  const oc = new OrangedCommands(client, , {
    commandsDir: 'commands',
    featureDir: 'features'
  })
    .setMongoPath(process.env.MONGO_URL)
    .setDefaultPrefix('?')

  // Ran whenever a supported database connection is connected
  oc.on('databaseConnected', (connection, state) => {
    console.log('The state is', state)
  })

  // Ran when a server owner attempts to set a language that you have not supported yet
  oc.on('languageNotSupported', (message, lang) => {
    console.log('Attempted to set language to', lang)
  })
})

client.login(process.env.TOKEN)

Test Servers

You might not want a command or feature to work while it is still in development. You can specify a test server to prevent in-development code from working.

First you must specify test servers like so:

const DiscordJS = require('discord.js')
const OrangedCommands = require('oranged-commands')
require('dotenv').config()

const client = new DiscordJS.Client({
  partials: ['MESSAGE', 'REACTION'],
})

client.on('ready', () => {
  // Initialize OrangedCommands
  new OrangedCommands(client, {
    // Can be a single string as well
    testServers: ['747587598712569913'],
  })
})

client.login(process.env.TOKEN)

After that you can specify some features and commands as "testOnly" like so:

// File name: "ping.js"
// Folder "./commands"

module.exports = {
  testOnly: true, // Will now only work on test servers
  callback: ({ message }) => {
    message.reply('pong')
  }
}

// File name: "message-logger.js"
// Folder "./features"

module.exports = (client, instance, isEnabled) => {
  // Listen for messages
  client.on('message', (message) => {
    // Access the guild, required to see if this is enabled
    const { guild } = message

    // If the guild exists and we are enabled within this guild
    // Remove the guild checek if you want this to be enabled in DMs
    if (guild && isEnabled(guild.id)) {
      // If this is enabled then log the content to the console
      console.log(message.content)
    }
  })
}

module.exports.config = {
  displayName: 'Test',
  dbName: 'TEST',
  loadDBFirst: true,
  testOnly: true, // Will now only work on test servers
}

Support & Feature Requests

This package is looking for feedback and ideas to help cover more use cases. If you have any ideas feel free to share them within the "💡 ｜ suggestions" channel in the Oranged Discord Server.