Skip to content

Latest commit

 

History

History
250 lines (197 loc) · 9.43 KB

creating-commands.mdx

File metadata and controls

250 lines (197 loc) · 9.43 KB
Raw
layout title category
../../layouts/SidebarLayout.astro
Creating commands
Creating your bot

import { CH } from '@code-hike/mdx/components'; import { Alert, DiscordMessages, DiscordMessage } from '@discordjs/ui'; import { DocsLink } from '../../components/DocsLink.jsx'; import { ResultingCode } from '../../components/ResultingCode.jsx';

Creating commands

This page is a follow-up and bases its code on [the previous page](/creating-your-bot/). Pong!

Discord allows developers to register slash commands, which provide users a first-class way of interacting directly with your application. Before being able to reply to a command, you must first register it.

Registering commands

This section will cover only the bare minimum to get you started, but you can refer to our in-depth page on registering slash commands for further details. It covers guild commands, global commands, options, option types, and choices.

Command deployment script

Create a deploy-commands.js file in your project directory. This file will be used to register and update the slash commands for your bot application.

Since commands only need to be registered once, and updated when the definition (description, options etc) is changed, it's not necessary to connect a whole client to the gateway or do this on every ready event. As such, a standalone script using the lighter REST manager is preferred.

Below is a deployment script you can use. Focus on these variables:

  • clientId: Your application's client id
  • guildId: Your development server's id
  • commands: An array of commands to register. The slash command builder from discord.js is used to build the data for your commands
In order to get your application's client id, go to [Discord Developer Portal](https://discord.com/developers/applications) and choose your application. Find the id under "Application ID" in General Information subpage. To get guild id, open Discord and go to your settings. On the "Advanced" page, turn on "Developer Mode". This will enable a "Copy ID" button in the context menu when you right-click on a server icon, a user's profile, etc.

<CH.Code client:load>

const { REST, SlashCommandBuilder, Routes } = require('discord.js');
const { clientId, guildId, token } = require('./config.json');

const commands = [
	new SlashCommandBuilder().setName('ping').setDescription('Replies with pong!'),
	new SlashCommandBuilder().setName('server').setDescription('Replies with server info!'),
	new SlashCommandBuilder().setName('user').setDescription('Replies with user info!'),
].map((command) => command.toJSON());

const rest = new REST({ version: '10' }).setToken(token);

rest
	.put(Routes.applicationGuildCommands(clientId, guildId), { body: commands })
	.then((data) => console.log(`Successfully registered ${data.length} application commands.`))
	.catch(console.error);
{
	"clientId": "123456789012345678",
	"guildId": "876543210987654321",
	"token": "your-token-goes-here"
}

</CH.Code>

Once you fill in these values, run node deploy-commands.js in your project directory to register your commands to a single guild. It's also possible to register commands globally.

You only need to run `node deploy-commands.js` once. You should only run it again if you add or edit existing commands.

Replying to commands

Once you've registered your commands, you can listen for interactions via in your index.js file.

You should first check if an interaction is a chat input command via .isChatInputCommand(), and then check the .commandName property to know which command it is. You can respond to interactions with .reply().

<CH.Code client:load>

client.once('ready', () => {
	console.log('Ready!');
});

client.on('interactionCreate', async (interaction) => {
	if (!interaction.isChatInputCommand()) return;
	const { commandName } = interaction;
	if (commandName === 'ping') {
		await interaction.reply('Pong!');
	} else if (commandName === 'server') {
		await interaction.reply('Server info.');
	} else if (commandName === 'user') {
		await interaction.reply('User info.');
	}
});
client.login(token);

</CH.Code>

Server info command

Note that servers are referred to as "guilds" in the Discord API and discord.js library. interaction.guild refers to the guild the interaction was sent in (a instance), which exposes properties such as .name or .memberCount.

<CH.Code client:load>

client.on('interactionCreate', async (interaction) => {
	if (!interaction.isChatInputCommand()) return;
	const { commandName } = interaction;
	if (commandName === 'ping') {
		await interaction.reply('Pong!');
	} else if (commandName === 'server') {
		await interaction.reply(`Server name: ${interaction.guild.name}\nTotal members: ${interaction.guild.memberCount}`);
	} else if (commandName === 'user') {
		await interaction.reply('User info.');
	}
});

</CH.Code>

Server name: discord.js Guide

Total members: 2

You could also display the date the server was created, or the server's verification level. You would do those in the same manner – use interaction.guild.createdAt or interaction.guild.verificationLevel, respectively.

Refer to the documentation for a list of all the available properties and methods!

User info command

A "user" refers to a Discord user. interaction.user refers to the user the interaction was sent by (a instance), which exposes properties such as .tag or .id.

<CH.Code client:load>

client.on('interactionCreate', async (interaction) => {
	if (!interaction.isChatInputCommand()) return;
	const { commandName } = interaction;
	if (commandName === 'ping') {
		await interaction.reply('Pong!');
	} else if (commandName === 'server') {
		await interaction.reply(`Server name: ${interaction.guild.name}\nTotal members: ${interaction.guild.memberCount}`);
	} else if (commandName === 'user') {
		await interaction.reply(`Your tag: ${interaction.user.tag}\nYour id: ${interaction.user.id}`);
	}
});

</CH.Code>

Your tag: User#0001

Your id: 123456789012345678

Refer to the documentation for a list of all the available properties and methods!

And there you have it!

The problem with if/else if

If you don't plan on making more than a couple commands, then using an if/else if chain is fine; however, this isn't always the case. Using a giant if/else if chain will only hinder your development process in the long run.

Here's a small list of reasons why you shouldn't do so:

  • Takes longer to find a piece of code you want;
  • Easier to fall victim to spaghetti code;
  • Difficult to maintain as it grows;
  • Difficult to debug;
  • Difficult to organize;
  • General bad practice.

Next, we'll be diving into something called a "command handler" – code that makes handling commands easier and much more efficient. This allows you to move your commands into individual files.

Resulting code