disky v0.2.1

Disky

A Discord bot framework using Discord.js

• 🤖 Development mode
• ♻️ Automatic command reloading
• 🖋 Typescript support

Installation

npm install disky

Get Started

Add discord config to .env file

Variables set in .env file are automatically loaded and injected into process.env:

BOT_TOKEN=<DISCORD_BOT_TOKEN>
GUILD_ID=<DISCORD_GUILD_ID>

Add diskyrc.ts config file

• token - Discord bot token
• guildId - Guild ID can be set to only load commands for a single guild (useful for dev/staging environemnts)
• intents - Intents to enable in the Discord client (the GUILD intent is enabled by automatically)

// diskyrc.ts

import { Intents } from "discord.js";
import { ClientOptions } from "disky";

export const options: ClientOptions = {
  token: process.env.BOT_TOKEN,
  guildId: process.env.GUILD_ID,
  intents: [Intents.FLAGS.GUILD_VOICE_STATES],
};

Add commands to src/commands

Commands have a run function that gets called whenever a slash command is triggered. The interaction is passed via run and is used to repond to the action. Discord.js has a good guide on how to reply to slash commands.

Use the @slash decorator to tell disky about the name, description, and arguments of the command.

// src/commands/ping.ts

import { Command, CommandContext, slash } from "disky";

@slash({
  name: "ping",
  description: "Responds with pong",
})
export default class PingCommand extends Command {
  async run({ interaction }: CommandContext) {
    await interaction.reply("pong");
  }
}