Get started with a new Discord bot using discord.js fast.

This section contains information about where to define new functionality for your Discord bot.

Trigger actions on a new event by adding a new file that has the same name as a specific event name defined in the event section of the documentation.

To properly initialize the event, this file has to be added to the event directory you specified in the configuration file of the bot: config.ts.

Example of Event: Ready

Ready.ts

import { Client } from '../Client';
import { Logger } from '../utils/Logger';
import { BotEvent } from '../types';

export default class Ready implements BotEvent {
    public client: Client;

    constructor(client: Client) {
        this.client = client;
    }

    public async run(): Promise<void> {
        Logger.info('Execute an action when the Ready event is triggered');
    }
}

Execute commands when a specific keyword including the command prefix has been sent in a Discord channel.

To properly initialize the command, this file has to be added to the command directory you specified in the configuration file of the bot: config.ts.

Example of Command: Ping

Ping.ts

import { Message } from 'discord.js';
import { Command } from '../Command';
import { BotClient } from '../types';

export default class Ping extends Command {
    constructor(client: BotClient) {
        super(client, {
            name: 'ping',
            description: 'Pings the bot.',
            category: 'Information',
            usage: client.settings.prefix.concat('ping'),
            cooldown: 1000,
            requiredPermissions: ['SEND_MESSAGES']
        });
    }

    public async run(message: Message): Promise<void> {
        await super.respond(message.channel, 'Pong!');
    }
}

To run the bot, first create an application on the Discord developer portal. Then copy the .env.example and rename it into .env. A proper .env file should look like this:

.env

BOT_TOKEN=RANDOMTOKENYOURECEIVEDFROMTHEDEVELOPERPORTAL

After everything is configured, you can run the bot locally by executing the npm start command.

During development, refer to the documentation served by discord.js.

MIT