https://github.com/arjunchib/disky
A discord bot framework
https://github.com/arjunchib/disky
bot discord discord-api discord-bot discord-js
Last synced: 2 months ago
JSON representation
A discord bot framework
- Host: GitHub
- URL: https://github.com/arjunchib/disky
- Owner: arjunchib
- Created: 2021-07-10T20:44:05.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-01-21T01:34:14.000Z (over 4 years ago)
- Last Synced: 2025-03-13T09:21:26.532Z (over 1 year ago)
- Topics: bot, discord, discord-api, discord-bot, discord-js
- Language: TypeScript
- Homepage:
- Size: 56.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Disky
A Discord bot framework using [Discord.js](https://discord.js.org/#/)
- 🤖 Development mode
- ♻️ Automatic command reloading
- 🖋 Typescript support
## Installation
```bash
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=
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](https://discordjs.guide/popular-topics/intents.html#privileged-intents) to enable in the Discord client (the GUILD intent is enabled by automatically)
```ts
// 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](https://discordjs.guide/interactions/replying-to-slash-commands.html#replying-to-slash-commands).
Use the `@slash` decorator to tell disky about the name, description, and arguments of the command.
```ts
// 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");
}
}
```