https://github.com/cornayy/ts-discord-bot-boilerplate

A boilerplate for a TypeScript Discord bot.
https://github.com/cornayy/ts-discord-bot-boilerplate

discord discord-api discord-bot discordjs nodejs typescript

Last synced: 2 months ago
JSON representation

A boilerplate for a TypeScript Discord bot.

• Host: GitHub
• URL: https://github.com/cornayy/ts-discord-bot-boilerplate
• Owner: Cornayy
• License: mit
• Created: 2020-03-10T19:58:28.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-06-27T07:48:44.000Z (over 2 years ago)
• Last Synced: 2023-03-03T08:11:13.695Z (almost 2 years ago)
• Topics: discord, discord-api, discord-bot, discordjs, nodejs, typescript
• Language: TypeScript
• Homepage:
• Size: 212 KB
• Stars: 17
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ts-discord-bot-boilerplate

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

## Usage

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

### Events

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](https://discord.js.org/#/docs/main/stable/class/Client).

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*

```typescript

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 {

        Logger.info('Execute an action when the Ready event is triggered');

    }

}

```

### Commands

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*

```typescript

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 {

        await super.respond(message.channel, 'Pong!');

    }

}

```

## Running

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.

## Documentation

During development, refer to the documentation served by [discord.js](https://discord.js.org/#/docs/main/stable/general/welcome).

## License

[MIT](LICENSE)