saramaebee / discord-bot

The CodeSupport Discord Bot

CodeSupport Discord Bot

About

This repository contains the code for the CodeSupport Discord Bot. The project is written in TypeScript using the Discord.js module for interaction with the Discord API.

Setup

1. Navigate into the repository on your computer and run npm i
2. Build the source code with npm run build
3. Start the Discord bot with npm start
   • You will need to supply the DISCORD_TOKEN environment variable

If you would like to use a .env file for storing your environment variables please create it in the root of the project. If you would like to overwrite values in config.json to better suit your local environment create a file named config.dev.json with any values you would like to overwrite config.json with.

Structure

• All source code lives inside src/
• All tests live inside test/
• Any static assets (i.e. images) live inside assets/
• Commands live in src/commands/
• Event handlers live in src/event/handlers

Please name files (which aren't interfaces) with their type in, for example RuleCommand and RuleCommandTest. This helps make the file names more readable in your editor. Do not add a prefix or suffix of "I" or "Interface" to interfaces.

Creating Commands

1. To create a command, add a new file in src/commands named <CommandName>Command.ts
   • DiscordX is used to register the commands as slash commands using decorators
   • Commands should have the @Discord() decorator above the class name
2. The command should have an onInteract async function that is decorated using @Slash()
   • In @Slash()'s parameters you have to pass in the name of the command
   • You also need to pass in a desciption
   • The onInteract function expects a CommandInteraction parameter, used for replying to the user the called the function
   • If the command accepts arguments, add one or more parameters decorated by the @SlashOption() or @SlashChoice()
   • @SlashOption() requires a name which will be shown in the client to the user when filling in the parameters
   • @SlashChoice() offers a way to have a user select from a predefined set of values

Example Command

@Discord()
class CodeblockCommand {
    @Slash({ name: "example", description: "An example command!" })
    async onInteract(
        @SlashOption("year", { type: "NUMBER" }) year: number,
        interaction: CommandInteraction
    ): Promise<void> {
        const embed = new EmbedBuilder();

        embed.setTitle("Happy new year!");
        embed.setDescription(`Welcome to the year ${year}, may all your wishes come true!`);

        await interaction.reply({ embeds: [embed] });
    }
}

Creating Event Handlers

To create an event handler, create a new file in src/event/handlers named <HandlerName>Handler.ts. Event handlers should extend the EventHandler abstract and super the event constant they are triggered by. When an event handler is handled, it triggers the handle method. This method accepts any parameters that the event requires. Do not name event handlers after the event they handle, but what their functionality is (for example, AutomaticMemberRoleHandler not GuildMemberAddHandler.

Example Event Handler

class ExampleHandler extends EventHandler {
    constructor() {
        super(Events.MessageCreate);
    }

    async handle(message: Message): Promise<void> {
        await message.channel.send("Hello!");
    }
}

Tests

We are using Mocha with Sinon and Chai for our tests. All code should be tested, if you are unsure of how to test your code ask LamboCreeper#6510 on Discord.

Scripts

• To start the Discord bot use npm start
• To build the source code use npm run build
• To start the bot in developer mode (auto-reload + run) npm run dev
• To test the code use npm test
• To lint the code use npm run lint
• To get coverage stats use npm run coverage

Any Questions? Feel free to mention @LamboCreeper in the CodeSupport Discord.