📖 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

discord.ts-example (starter repo)

discord-music-bot from @oceanroleplay

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
• client.initApplicationPermissions to update discord application commands permissions
• 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.

📔 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
• @Permission
• @On
• @Once

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 {
  @Slash("hello")
  hello(interaction: CommandInteraction) {
    const helloBtn = new ButtonBuilder()
      .setLabel("Hello")
      .setEmoji("👋")
      .setStyle("PRIMARY")
      .setCustomId("hello-btn");

    const row =
      new ActionRowBuilder<MessageActionRowComponentBuilder>().addComponents(
        helloBtn
      );

    interaction.reply({
      content: "Say hello to bot",
      components: [row],
    });
  }

  @ButtonComponent("hello-btn")
  myBtn(interaction: ButtonInteraction) {
    interaction.reply(`👋 ${interaction.member}`);
  }
}

📟 @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) {
    await interaction.deferReply();

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

    // if value not found
    if (!roleValue)
      return await interaction.followUp("invalid role id, select again");
    await interaction.followUp(
      `you have selected role: ${
        roles.find((r) => r.value === roleValue).label
      }`
    );
    return;
  }

  @Slash("roles", { description: "role selector 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({
      content: "select your role!",
      components: [buttonRow],
    });
    return;
  }
}

📟 @ContextMenu

Create discord context menu options with ease!

@Discord()
class Example {
  @ContextMenu("MESSAGE", "message context")
  messageHandler(interaction: MessageContextMenuInteraction) {
    console.log("I am message");
  }

  @ContextMenu("USER", "user context")
  userHandler(interaction: UserContextMenuInteraction) {
    console.log("I am user");
  }
}

📟 @SimpleCommand

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

@Discord()
class Example {
  @SimpleCommand("perm-check", { aliases: ["p-test"] })
  @Permission(false)
  @Permission({
    id: "462341082919731200",
    type: "USER",
    permission: true,
  })
  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() {
    // ...
  }
}

⚔️ Guards

We implemented a guard system thats work pretty 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.