Before you continue

Assuming you've followed the guide so far, your project directory should look something like this:

discord-bot/
├── node_modules/
├── config.js
├── index.js
├── package-lock.json
└── package.json

Following this guide, create a src/ folder and move index.js and config.js into the new src/ folder.

Your new project directory should look something like this:

discord-bot/
├── node_modules/
├── src/
│   ├── config.js
│   └── index.js
├── package-lock.json
└── package.json

warning

⚠️ Please make sure to update your package.json file and edit the "main": "index.js" field to "main": "src/index.js".

---

info

ℹ️ This page requires you to have a valid main file.

warning

⚠️ Please make sure to select below the command creation "step" you need. The section below is divided into "Creating slash commands" and "Creating message commands".

Creating slash commands

tip

ℹ️ For fully functional slash commands, there are three important pieces of code that need to be written. They are:

1. The individual command files, containing their definitions and functionality.
2. The command handler, which dynamically reads the files and executes the commands.
3. The command deployment script, to register your slash commands with Discord so they appear in the interface.

These steps can be done in any order, but all are required before the commands are fully functional.

On this page, you'll complete Step 1. Make sure to also complete the other pages linked above!

Individual command files (slash commands)

Create a new folder inside the src/ folder, named commands and a subfolder named music inside it, which is where you'll store all of your music command files. You'll be using the SlashCommandBuilder class to construct the command definitions.

At a minimum, the definition of a event file must have only a name.

new SlashCommandBuilder()
    .setName("play")
    .setDescription("Play a song/playlist.")
    .addStringOption((option) => option.setName("query").setDescription("The search query for the song/playlist").setRequired(true)),

A slash command also requires a function to run when the command is used, to respond to the interaction. Using an interaction response method confirms to Discord that your bot successfully received the interaction, and has responded to the user. Discord enforces this to ensure that all slash commands provide a good user experience (UX). Failing to respond will cause Discord to show that the command failed, even if your bot is performing other actions as a result.

The simplest way to acknowledge and respond to an interaction is the interaction.reply() method. Other methods of replying are covered on the Response methods page later in this section.

async execute(client, interaction) {
    await interaction.reply('Playing your song/playlist!')
}

Put these two together by creating a play.js file in the src/commands/music folder for your first command. Inside this file, you're going to define and export two items.

• The data property, which will provide the command definition shown above for registering to Discord.
• The execute() method, which will contain the functionality to run from our event handler when the command is used.

These are placed inside module.exports so they can be read by other files; namely the command loader and command deployment scripts mentioned earlier.

src/commands/play.js

const { LoadTypes, StateTypes } = require("magmastream");
const { SlashCommandBuilder } = require("discord.js");

module.exports = {
    data: new SlashCommandBuilder()
        .setName("play")
        .setDescription("Play a song/playlist.")
        .addStringOption((option) => option.setName("query").setDescription("The search query for the song/playlist").setRequired(true)),

    async execute(client, interaction) {
        // Check if the user is in a voice channel
        if (!interaction.member.voice.channel) {
            return await interaction
                .reply("You need to be in a voice channel to use this command.")
                .catch((error) => console.log(`[ERROR] Failed to send message ${error.message} to channel: ${interaction.channel.id}`));
        }

        // Get the current player
        let player = client.manager.get(interaction.guild.id);

        // Check if the user is in the same voice channel as the bot
        if (player && interaction.member.voice.channel.id !== player.voiceChannelId) {
            return await interaction
                .reply("You need to be in the same voice channel as the bot to use this command.")
                .catch((error) => console.log(`[ERROR] Failed to send message ${error.message} to channel: ${interaction.channel.id}`));
        }

        // Defer the reply
        await interaction.deferReply().catch((error) => console.log(`[ERROR] Failed to defer message ${error.message} to channel: ${interaction.channel.id}`));

        // Get the search query
        const query = interaction.options.getString("query");

        // Search for the query
        let res = await client.manager.search(query, interaction.member.user);

        // Check if the search returned any results
        if (res.loadType === LoadTypes.Empty || res.loadType === LoadTypes.Error) {
            return await interaction
                .editReply("No results found.")
                .catch((error) => console.log(`[ERROR] Failed to send message ${error.message} to channel: ${interaction.channel.id}`));
        }

        // Create the player if it doesn't exist
        try {
            player = client.manager.create({
                guildId: interaction.guild.id,
                voiceChannel: interaction.member.voice.channel.id,
                textChannel: interaction.channel.id,
                selfDeafen: true,
                volume: 100,
            });
            // Connect to the voice channel if the player is not already connected
            if (player.state !== StateTypes.Connected) player.connect();
        } catch (error) {
            return await interaction
                .editReply(`An error occurred while creating the player: ${error.message}`)
                .catch((error) => console.log(`[ERROR] Failed to send message ${error.message} to channel: ${interaction.channel.id}`));
        }

        // Handle the search result
        switch (res.loadType) {
            case LoadTypes.Track:
            case LoadTypes.Search:
                // Add the track to the queue
                const track = res.tracks[0];
                player.queue.add(track);

                // Play the track if the queue is empty
                if (!player.playing && !player.paused && !player.queue.size) await player.play();

                // Reply with a success message
                await interaction
                    .editReply(`Successfully added \`${track.author} - ${track.title}\` to the queue.`)
                    .catch((error) => console.log(`[ERROR] Failed to send message ${error.message} to channel: ${interaction.channel.id}`));
                break;
            case LoadTypes.Playlist:
                // Add the playlist tracks to the queue
                res.tracks = res.playlist.tracks;

                player.queue.add(res.tracks);

                // Play the first track if the queue is empty
                if (!player.playing && !player.paused && player.queue.size === res.tracks.length) await player.play();

                // Reply with a success message
                await interaction
                    .editReply(`Successfully added \`${res.playlist.name}\` playlist with \`${res.tracks.length + 1} songs\` to the queue.`)
                    .catch((error) => console.log(`[ERROR] Failed to send message ${error.message} to channel: ${interaction.channel.id}`));
                break;
        }
    },
};

tip

ℹ️ module.exports is how you export data in Node.js so that you can require() it in other files.

That's it for your basic play command. Below is what your project directory should look like:

discord-bot/
├── node_modules/
├── src/
│   ├── commands/
│   │   └── play.js
│   ├── config.js/
│   └── index.js/
├── package-lock.json
└── package.json

Creating message commands

Next steps

You can implement additional commands by creating new files within a dedicated subfolder in the commands folder, but this one is the one we're going to use for the examples as we go on. For now let's move on to the code you'll need for command handling, to load the files and respond to incoming interactions.

Resulting code

If you want to compare your code to the final result after completing all the steps in this guide, you can review it on the GitHub repository here .