This repository provides examples and a step-by-step guide on how to create a simple Discord bot using discord.js.
Create a new Node.js project and install necessary dependencies.
$ npm init
$ npm install discord.js dotenv- Navigate to the Discord Developer Portal and create a new application.
- Optionally, set the application name, description, and avatar.
- Note down the "Application ID" (also known as "Client ID").
- In the Discord Developer Portal, select "Bot" from the left navigation and click "Add Bot".
- Set a name and icon for your bot.
- Note down the "Bot Token" (keep this secret).
Use the following URL to add the bot to your Discord server, replacing YOUR_APPLICATION_ID with your actual application ID:
https://discord.com/oauth2/authorize?client_id=YOUR_APPLICATION_ID&scope=bot
- Enable "Developer Mode" under the "Advanced" settings tab on your Discord client.
- Right-click on the server icon, and select "Copy ID" to get the server ID.
Create a .env file in your project root and add your client ID, server ID, and bot token:
CLIENTID=1234
SERVERID=1234
TOKEN=1234
These environment variables are used to keep sensitive data, like your bot token, out of your code. This is especially important if you're sharing your code with others or storing your code publicly on GitHub. (Notice how .env is included in .gitignore.)
- Go to your application page in the Discord developer portal.
- Navigate to "OAuth" -> "URL Generator".
- Check "application.commands".
- Open the URL that populates at the bottom and authorize the bot to access your server.
Create bot.js (or index.js) and paste this code:
const { Client, Events, GatewayIntentBits } = require('discord.js');
require('dotenv').config();
// Create a new client instance
const client = new Client({
intents: [GatewayIntentBits.Guilds],
});
// When the client is ready, run this code (only once)
client.once(Events.ClientReady, readyDiscord);
// Login to Discord with your client's token
client.login(process.env.TOKEN);
function readyDiscord() {
console.log('💖');
}Run to see if it works! (If you see the 💖 it's working!)
$ node bot.jsEach command should be handled in a separate JS file, there are many ways you can manage this, but I suggest putting them in a folder called commands:
const { SlashCommandBuilder } = require('discord.js');
module.exports = {
data: new SlashCommandBuilder().setName('choochoo').setDescription('Says choo choo back!'),
async execute(interaction) {
await interaction.reply('Choo Choo! 🚂');
},
};Create deploy-commands.js and copy the example code. Then run it!
node deploy-commands.jsYou only have to do this once. If you change the command (altering descriptions, changing options, etc.), then you do need to re-run deploy-commands.js.
You also need to handle the command in bot.js, add the equivalent code:
const choochoo = require('./commands/choochoo');
client.on('interactionCreate', async (interaction) => {
if (!interaction.isCommand()) return;
if (interaction.commandName === 'choochoo') {
await choochoo.execute(interaction);
}
});Then run the bot again!
node bot.jscommands/choochoo.js: Defines a simple slash command.index.js: Handles interactions with Discord and executes commands.deploy-commands.js: Script to register slash commands with Discord API.