Built-in help menu

Search…
Built-in help menu
WOKCommands comes with a built-in dynamic help menu that displays all of your commands. This way you don't have to worry about listings all of your commands for your user to know about. The default help menu looks like this:
Users can click on the reaction to view commands in that category like so:
Your bot will need access to the "MANAGE MESSAGES" permission to be able to remove reactions when switching between pages.
You can access all of your commands to create your own help menu like so:
JavaScript
TypeScript
help.js
module.exports = {
  callback: ({ instance }) => {
    instance.commandHandler.commands.forEach((command) => {
      console.log(command)
    })
  }
}
help.ts
import { ICommand } from 'wokcommands'
​
export default {
  callback: ({ instance }) => {
    instance.commandHandler.commands.forEach((command) => {
      console.log(command)
    })
  },
} as ICommand
You can also set the "Display Name" for your bot like so:
JavaScript
TypeScript
index.js
const DiscordJS = require('discord.js')
const WOKCommands = require('wokcommands')
const path = require('path')
​
const { Intents } = DiscordJS
​
const client = new DiscordJS.Client({
  // These intents are recommended for the built in help menu
  intents: [
    Intents.FLAGS.GUILDS,
    Intents.FLAGS.GUILD_MESSAGES,
    Intents.FLAGS.GUILD_MESSAGE_REACTIONS,
  ],
})
​
client.on('ready', () => {
  new WOKCommands(client, {
    // The name of the local folder for your command files
    commandsDir: path.join(__dirname, 'commands')
  })
    .setDisplayName('Bot demo')
})
​
client.login('YOUR TOKEN HERE')
index.ts
import DiscordJS, { Intents } from 'discord.js'
import WOKCommands from 'wokcommands'
import path from 'path'
​
const client = new DiscordJS.Client({
  // These intents are recommended for the built in help menu
  intents: [
    Intents.FLAGS.GUILDS,
    Intents.FLAGS.GUILD_MESSAGES,
    Intents.FLAGS.GUILD_MESSAGE_REACTIONS,
  ],
})
​
client.on('ready', () => {
  new WOKCommands(client, {
    // The name of the local folder for your command files
    commandsDir: path.join(__dirname, 'commands'),
    // Allow importing of .ts files if you are using ts-node
    typeScript: true,
  })
    .setDisplayName('Bot demo')
})
​
client.login('YOUR TOKEN HERE')
That will then make the title of the embed "Demo Bot Help Menu" like so:
Features - Previous
Configuring a feature
Next - Built-in commands and features
Enabling and disabling commands
Last modified 10mo ago
Copy link