mirasaki / discord.js-bot-template

A template for discord.js v14. Always up-to-date, integrates the latest Discord API features, and actively maintained.

Hi there, I'm Mirasaki

💁‍♂️ About me

• 🇳🇱 I was born in the Netherlands, February 1998
• ☕ is the best thing ever made
• 🍵 is fine too, I guess
• 📖 I've got a dedicated book-display on my desk of books I know I will never read
• 🎵 My favorite band is Nightwish, and I listen to music all the time
• 🎸 Playing Clone Hero - a competitive rhythm game for the Desktop - is absolutely amazing
• 🧙 The Lord of the Rings, the Hobbit, and Game of Thrones. Enough said

📊 Github Stats

discord.js-bot-template's Issues

Adjust register listener logging

Instead of the individual logging, change it to one long ling using listeners.join(', ')

Example output:

[INFO] Registering 9 listeners: guildCreate, guildDelete, applicationCommandInteraction, autoCompleteInteraction, interactionCreate, messageComponentInteraction, modalSubmitInteraction, pingInteraction
[SUCCESS] Finished registering listeners

[BUG] - [09:04:47] [SYSERR] : Missing interaction listener for "info" (name for commands, customId for components - ignored if starts with "@")

[09:04:47] [SYSERR] : Missing interaction listener for "info" (name for commands, customId for components - ignored if starts with "@")

Feature: Prefix commands

Is your feature request related to a problem? Please describe.
Not Related to any Problem

Describe the solution you'd like
Support for Prefix Commands

missing @discordjs/rest

@discordjs/rest is missing from package file and therefor the client won't initialize after a clean install

update deprecated default_permission value in developer commands

ApplicationCommand API Data
default_permission will soon be deprecated. You can instead set default_member_permissions to "0" to disable the command for everyone except admins by default, and/or set dm_permission to false to disable globally-scoped commands inside of DMs with your app

[BUG] - No support for ChatInput and ContextMenu commands with same name

Describe the bug
Duplicate commands (same name between ChatInputCommands and User-/MessageContext commands) is not supported, and overwrites the initial declared command

To Reproduce
Steps to reproduce the behavior:

1. Create a ChatInputCommand named rank
2. Create a UserContextCommand named rank
3. Use /commands
4. See only the UserContextCommand being displayed

Expected behavior
Display of both/all commands

Screenshots
n/a

Desktop (please complete the following information):

• OS: [e.g. iOS] n/a
• Version [e.g. 22] n/a

Additional context
n/a

Add a showcase section in the project README.md

Add a section in the README dedicated to showcasing and linking projects using this template

Add DayZ Leaderboard Bot as the first to be using this template

[BUG] - Wrong command on Error while registering Discord commands

Describe the bug
If API command data validation doesn't pass, the bot would print out the wrong command data:

To Reproduce
Steps to reproduce the behavior:

1. Create a command OPTION description of over 100 characters
2. Restart

Expected behavior
Display correct command data

Screenshots

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Version [e.g. 22]

Additional context
Reported by Vasolix

Default DEBUG_INTERACTIONS in .env

Change the default to false so new users don't have a cluttered terminal/console

command documentation

include a simple html page that retrieves command data and builds a documentation page

feat: ComponentCommand `isUserComponent` option

Is your feature request related to a problem? Please describe.
ComponentCommand doesn't have a configurable option to determine if a component is meant for the user who initiated it, or available globally to everyone

Describe the solution you'd like
Add a configurable option to allow this functionality.

Describe alternatives you've considered

Additional context

/**
 * @typedef {BaseConfig} ComponentCommandConfig
 * @property {boolean} [isUserComponent = true] If true, the component is only available to the user who initiated it. If false, everyone can interact with the component
 */

/**
 * @extends {CommandBase}
 */
class ComponentCommand extends CommandBase {
  constructor (config) {
    super(config);
    /**
     * @property {boolean} global If true, the component is only available to the user who initiated it. If false, everyone can interact with the component
     */
    this.isUserComponent = 'isUserComponent' in config ? config.isUserComponent : true;
  }
}

And in interactionCreate.js:

// Check if the Component Command is meant for the member initiating it
  if (
    ( interaction.isButton()
    || interaction.isStringSelectMenu()
    || interaction.isMessageComponent() )
    && clientCmd.isUserComponent === true
  ) {
    const componentIsForMember = hasAccessToComponentCommand(interaction);
    if (!componentIsForMember) {
      interaction.reply({
        content: `${emojis.error} ${member}, this message component isn't meant for you.`,
        ephemeral: true
      });
      return;
    }
  }

HTML generator: white bar on some mobile devices

HTML command table generator mobile scrolling bug:

This happens on some mobile devices because of the bottom docked control bar (Samsung Galaxy S10+ Edge for example)

command cooldown types

Available types: member, channel, guild

apply throttleCommand() depending on cooldown type
default type: member (adjust in default command Class)
adjust the throttleCommand() call in src/listeners/interaction/applicationCommandInteraction.js:86
by assigning a unique identifier string and passing that as a parameter instead

[BUG] - CommandBase extension parameters

Describe the bug
IntelliSense autocomplete support isn't offered for the

@param {BaseConfig | APICommandConfig} config The full command configuration

parameter configuration,

To Reproduce
Open up VSCode, call new ChatInputCommand({ <<CURSOR HERE>> }) and press ctrl+space, APICommandConfig options are NOT displayed

Expected behavior
APICommandConfig parameters are displayed alongside BaseConfig parameters

Screenshots
For example, global is missing from autocomplete options

Desktop (please complete the following information):

• OS: Win11
• Browser: n/a
• Version: latest

Additional context
n/a

client activity currently doesn't accept strings

the current way of defining the client's activity only supports API ENUM values, not strings

Live demo

Host a live demo in the support server and invite users to come try it themselves

Support Context Menu's in the /help command

Is your feature request related to a problem? Please describe.
No information can currently be displayed for Context Menu commands.

Describe the solution you'd like
Include Context Menu commands in the /help information output. Having a description might also be included, have the normal description property in the Command data object, but remove that field when sending Interaction Command API data and include it in the /help command output

Describe alternatives you've considered
None

Additional context
n/a

required node version of v16 not specified in package.json

include

"engines": {
    "node": ">=16.10.0"
}

in package.json

[BUG] - Auto complete limited to 1 entry per command

Describe the bug
With the current implementation, a command can only have 1 auto complete enabled option

To Reproduce
Create a command with 2 auto-complete options and see them both do the same thing instead of their own dedicated handler

Expected behavior
Separate functionality for multiple auto complete options

Screenshots
If applicable, add screenshots to help explain your problem.

Additional context
in autoCompleteInteraction.js, autoCompleteQueryHandler should be defined by the option name, not the command name