discordx

Create a discord bot with TypeScript and Decorators!

📖 Introduction

This module is an extension of discord.js, so the internal behavior (methods, properties, ...) is the same.

This library allows you to use TypeScript decorators on discord.js, it simplifies your code and improves the readability!

This repository is a fork of OwenCalvin/discord.ts from @OwenCalvin, which is no longer actively maintained.

💻 Installation

Version 16.6.0 or newer of Node.js is required

npm install discordx
yarn add discordx

installation guide

one-click installation

📜 Documentation

discord-ts.js.org

Tutorials (dev.to)

🤖 Bot Examples

discordx-templates (starter repo)

music bot (ytdl)

lavalink bot

Shana from @VictoriqueMoe

💡 Why discordx?

With discordx, we intend to provide the latest up-to-date package to easily build feature-rich bots with multi-bot compatibility, simple commands, pagination, music, and much more. Updated daily with discord.js changes.

Try discordx now with CodeSandbox

If you have any issues or feature requests, Please open an issue at Github or join discord server

🆕 Features

• Support multiple bots in a single nodejs instance (@Bot)
• @SimpleCommand to use old fashioned command, such as !hello world
• @SimpleCommandOption parse and define command options like @SlashOption
• client.initApplicationCommands to create/update/remove discord application commands
• Handler for all discord interactions (slash/button/menu/context)
• Support TSyringe and TypeDI
• Support ECMAScript

🧮 Packages

Here are more packages from us to extend the functionality of your Discord bot.

Package	Description
create-discordx	Create discordx (discord.ts) apps with one command
discordx	Create a discord bot with TypeScript and Decorators!
@discordx/changelog	Changelog generator, written in TypeScript with Node.js
@discordx/di	Dependency injection service with TSyringe support
@discordx/importer	Import solution for ESM and CJS
@discordx/internal	discord.ts internal methods, can be used for external projects
@discordx/koa	Create rest api server with Typescript and Decorators
@discordx/lava-player	Create lavalink player
@discordx/lava-queue	Create queue system for lavalink player
@discordx/music	Create discord music player easily
@discordx/pagination	Add pagination to your discord bot
@discordx/socket.io	Create socket.io server with Typescript and Decorators
@discordx/utilities	Create own group with @Category and guards
discord-spams	Tiny but powerful discord spam protection library

📔 Decorators

There is a whole system that allows you to implement complex slash/simple commands and handle interactions like button, select-menu, context-menu etc.

General

• @Discord
• @Guard
• @Guild
• @Bot
• @On
• @Once
• @Once
• @Reaction

Commands

• @Slash
• @SlashChoice
• @SlashGroup
• @SlashOption
• @SimpleCommand
• @SimpleCommandOption

GUI Interactions

• @ButtonComponent
• @ContextMenu
• @ModalComponent
• @SelectMenuComponent

📟 @Slash

Discord has it's own command system now, you can simply declare commands and use Slash commands this way

import { Discord, Slash } from "discordx";
import { CommandInteraction } from "discord.js";

@Discord()
class Example {
  @Slash("hello")
  private hello(
    @SlashOption("text")
    text: string,
    interaction: CommandInteraction
  ) {
    // ...
  }
}

📟 @ButtonComponent

Create discord button handler with ease!

@Discord()
class Example {
  @ButtonComponent("hello")
  handler(interaction: ButtonInteraction): void {
    interaction.reply(":wave:");
  }

  @Slash()
  hello(interaction: CommandInteraction): void {
    const btn = new ButtonBuilder()
      .setLabel("Hello")
      .setStyle(ButtonStyle.Primary)
      .setCustomId("hello");

    const buttonRow =
      new ActionRowBuilder<MessageActionRowComponentBuilder>().addComponents(
        btn
      );

    interaction.reply({
      components: [buttonRow],
    });
  }
}

📟 @SelectMenuComponent

Create discord select menu handler with ease!

const roles = [
  { label: "Principal", value: "principal" },
  { label: "Teacher", value: "teacher" },
  { label: "Student", value: "student" },
];

@Discord()
class Example {
  @SelectMenuComponent("role-menu")
  async handle(interaction: SelectMenuInteraction): Promise<unknown> {
    await interaction.deferReply();

    // extract selected value by member
    const roleValue = interaction.values?.[0];

    // if value not found
    if (!roleValue) {
      return interaction.followUp("invalid role id, select again");
    }

    interaction.followUp(
      `you have selected role: ${
        roles.find((r) => r.value === roleValue)?.label ?? "unknown"
      }`
    );
    return;
  }

  @Slash("my-roles", { description: "roles menu" })
  async myRoles(interaction: CommandInteraction): Promise<unknown> {
    await interaction.deferReply();

    // create menu for roles
    const menu = new SelectMenuBuilder()
      .addOptions(roles)
      .setCustomId("role-menu");

    // create a row for message actions
    const buttonRow =
      new ActionRowBuilder<MessageActionRowComponentBuilder>().addComponents(
        menu
      );

    // send it
    interaction.editReply({
      components: [buttonRow],
      content: "select your role!",
    });
    return;
  }
}

📟 @ContextMenu

Create discord context menu options with ease!

@Discord()
class Example {
  @ContextMenu(ApplicationCommandType.Message, "Hello from discord.ts")
  messageHandler(interaction: MessageContextMenuCommandInteraction): void {
    console.log("I am message");
    interaction.reply("message interaction works");
  }

  @ContextMenu(ApplicationCommandType.User, "Hello from discord.ts")
  userHandler(interaction: UserContextMenuCommandInteraction): void {
    console.log(`Selected user: ${interaction.targetId}`);
    interaction.reply("user interaction works");
  }
}

📟 @ModalComponent

Create discord modal with ease!

@Discord()
class Example {
  @Slash("modal")
  attachment(interaction: CommandInteraction): void {
    // Create the modal
    const modal = new ModalBuilder()
      .setTitle("My Awesome Form")
      .setCustomId("AwesomeForm");

    // Create text input fields
    const tvShowInputComponent = new TextInputBuilder()
      .setCustomId("tvField")
      .setLabel("Favorite TV show")
      .setStyle(TextInputStyle.Short);

    const haikuInputComponent = new TextInputBuilder()
      .setCustomId("haikuField")
      .setLabel("Write down your favorite haiku")
      .setStyle(TextInputStyle.Paragraph);

    const row1 = new ActionRowBuilder<TextInputBuilder>().addComponents(
      tvShowInputComponent
    );

    const row2 = new ActionRowBuilder<TextInputBuilder>().addComponents(
      haikuInputComponent
    );

    // Add action rows to form
    modal.addComponents(row1, row2);

    // --- snip ---

    // Present the modal to the user
    interaction.showModal(modal);
  }

  @ModalComponent("AwesomeForm")
  async handle(interaction: ModalSubmitInteraction): Promise<void> {
    const [favTVShow, favHaiku] = ["tvField", "haikuField"].map((id) =>
      interaction.fields.getTextInputValue(id)
    );

    await interaction.reply(
      `Favorite TV Show: ${favTVShow}, Favorite haiku: ${favHaiku}`
    );

    return;
  }
}

📟 @SimpleCommand

Create a simple command handler for messages using @SimpleCommand. Example !hello world

@Discord()
class Example {
  @SimpleCommand("perm-check", { aliases: ["p-test"] })
  permFunc(command: SimpleCommandMessage) {
    command.message.reply("access granted");
  }
}

💡@On / @Once

We can declare methods that will be executed whenever a Discord event is triggered.

Our methods must be decorated with the @On(event: string) or @Once(event: string) decorator.

That's simple, when the event is triggered, the method is called:

import { Discord, On, Once } from "discordx";

@Discord()
class Example {
  @On("messageCreate")
  private onMessage() {
    // ...
  }

  @Once("messageDelete")
  private onMessageDelete() {
    // ...
  }
}

💡@Reaction

Create a reaction handler for messages using @Reaction.

@Discord()
class Example {
  @Reaction("⭐", { remove: false })
  async starReaction(reaction: MessageReaction, user: User): Promise<void> {
    await reaction.message.reply(`Received a ${reaction.emoji} from ${user}`);
  }

  @Reaction("📌", { aliases: ["📍", "custom_emoji"] })
  async pin(reaction: MessageReaction): Promise<void> {
    await reaction.message.pin();
  }
}

⚔️ Guards

We implemented a guard system that functions like the Koa middleware system

You can use functions that are executed before your event to determine if it's executed. For example, if you want to apply a prefix to the messages, you can simply use the @Guard decorator.

The order of execution of the guards is done according to their position in the list, so they will be executed in order (from top to bottom).

Guards can be set for @Slash, @On, @Once, @Discord and globally.

import { Discord, On, Client, Guard } from "discordx";
import { NotBot } from "./NotBot";
import { Prefix } from "./Prefix";

@Discord()
class Example {
  @On("messageCreate")
  @Guard(
    NotBot // You can use multiple guard functions, they are executed in the same order!
  )
  onMessage([message]: ArgsOf<"messageCreate">) {
    switch (message.content.toLowerCase()) {
      case "hello":
        message.reply("Hello!");
        break;
      default:
        message.reply("Command not found");
        break;
    }
  }
}

☎️ Need help?

• Check frequently asked questions
• Check examples
• Ask in discord server

Thank you

Show your support for discordx by giving us a star on github.