Skip to content

Latest commit

 

History

History
108 lines (83 loc) · 3.53 KB

CONTRIBUTING.md

File metadata and controls

108 lines (83 loc) · 3.53 KB
Raw

Contributing

Table of Contents

Pre-requisite knowledge

Contributing to this bot does not require much understanding of TypeScript, but some may be useful. Coming from JS or Python shouldn't be much of a concern for implementing commands.

Resources

.env and its options

Available settings 
DISCORD_TOKEN=abcdefgh
DISCORD_APP_ID=12345
DISCORD_GUILD_ID=12345
DISCORD_PREFIX=?
TZ=Europe/Oslo
NODE_ENV=production
RANDOM_ORG_KEY=abcdefgh
UIB_OPENDATA_API_KEY=abcdefgh
GIPHY_API_KEY=abcdefgh
  1. DISCORD_TOKEN: The token used by the bot to connect to the Discord API.
  2. DISCORD_APP_ID: The application ID for your bot.
  3. DISCORD_GUILD_ID: ID of the guild the bot is deployed against.
  4. DISCORD_PREFIX: Legacy for old !help style commands
  5. TZ: Timezone for the bot, used to display correct dates etc
  6. NODE_ENV: Should be set to PRODUCTION when deploying, can be ignored otherwise
  7. RANDOM_ORG_KEY: API key used to get random number, can be omitted
  8. UIB_OPENDATA_API_KEY: API key used to get UiB information, can be omitted
  9. GIPHY_API_KEY: API key used to get GIFs from Giphy, can be omitted

The only required options are the three first, the rest can be ignored unless you are working on that feature/need it to run.

Creating a new command

To create a new command you can copy one of the existing ones that matches what you want to do from the src/commands directory, for example the InsultCommand has some simple code for an optional argument that targets a user or otherwise randomly selects a member of the guild you're in while the MeowCommand is a very simple command that simply replies Meow! when invoked.

The commands themselves are created by extending an abstract class called SlashCommandHandler:

export interface SlashCommand {
  builder: SlashCommandData;
  handle(interaction: CommandInteraction, client: DiscordClient): Promise<void>;
  toJSON(): CommandData;
  getName(): string;
}

export abstract class SlashCommandHandler implements SlashCommand {
  public abstract builder: SlashCommandData;
  public abstract handle(interaction: CommandInteraction, client: DiscordClient): Promise<void>;

  getName(): string {
    return this.builder.name.toLowerCase();
  }

  public toJSON(): CommandData {
    return this.builder.toJSON();
  }
}

Your command only has to implement the builder field and the handle method, the rest are automatically inherited by extending the class. If your command does not need to interact with the DiscordClient you can add an underscore to the variable name _client to tell TypeScript and ESLint to ignore the variable.

The implementation for the MeowCommand is then simply

export default class MeowCommand extends SlashCommandHandler {
  builder = new SlashCommandBuilder().setName("meow").setDescription("Replies with a meaw, kitty cat");

  handle(interaction: CommandInteraction, _client: DiscordClient): Promise<void> {
    return interaction.reply("Meow!");
  }
}

Note that the command has to be the default export from the file and it has to extend the SlashCommandHandler due to how it is loaded via the client itself.