Handle guild-specific commands

D4isDAVID · Sep 10, 2024 · 1d47233 · 1d47233
1 parent b9450af
commit 1d47233
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 11 deletions.
diff --git a/discordbot.cfg b/discordbot.cfg
@@ -6,3 +6,6 @@
 
 # The bot token to use for Discord API authentication.
 set discordbot:botToken "YOUR_BOT_TOKEN_HERE"
+
+# The ID of the Discord server to use for server-specific commands.
+set discordbot:guildId "YOUR_SERVER_ID_HERE"
diff --git a/server/components/core/interaction-handler.ts b/server/components/core/interaction-handler.ts
@@ -3,6 +3,7 @@ import {
     GatewayDispatchEvents,
     InteractionType,
 } from '@discordjs/core';
+import { guildId } from '../../utils/env.js';
 import { interactions, statefuls } from '../loader.js';
 import { GatewayEvent } from '../types.js';
 
@@ -30,6 +31,12 @@ export const interactionHandler = {
                         `Command not defined for ${interaction.data.name}.`,
                     );
 
+                if (
+                    command.guildSpecific &&
+                    (!guildId || interaction.guild_id !== guildId)
+                )
+                    return;
+
                 if (
                     interaction.type === InteractionType.ApplicationCommand &&
                     (command.data.type ?? ApplicationCommandType.ChatInput) ===

diff --git a/server/components/loader.ts b/server/components/loader.ts
@@ -1,5 +1,8 @@
 import { Collection } from '@discordjs/collection';
-import { RESTPutAPIApplicationCommandsJSONBody } from '@discordjs/core';
+import {
+    RESTPutAPIApplicationCommandsJSONBody,
+    RESTPutAPIApplicationGuildCommandsJSONBody,
+} from '@discordjs/core';
 import EventEmitter from 'node:events';
 import { inspect } from 'node:util';
 import { client, gateway, rest } from '../utils/env.js';
@@ -21,7 +24,9 @@ export const interactions = {
     modals: new Collection<string, Modal>(),
 };
 
-export const commands: RESTPutAPIApplicationCommandsJSONBody = [];
+export const globalCommands: RESTPutAPIApplicationCommandsJSONBody = [];
+export const guildSpecificCommands: RESTPutAPIApplicationGuildCommandsJSONBody =
+    [];
 
 export const statefuls = {
     messageComponents: [],
@@ -58,7 +63,9 @@ function loadComponent({
 
     componentCommands?.map((command) => {
         interactions.commands.set(command.data.name, command);
-        commands.push(command.data);
+        (command.guildSpecific ? guildSpecificCommands : globalCommands).push(
+            command.data,
+        );
     });
     messageComponents?.map((messageComponent) => {
         const customId = messageComponent.data.custom_id;

diff --git a/server/components/types.d.ts b/server/components/types.d.ts
@@ -85,6 +85,9 @@ export type InteractionExecuteArgs<T extends APIInteraction> =
 
 export interface IInteraction<T extends APIInteraction> {
     readonly data: InteractionData<T>;
+    readonly guildSpecific?: T extends APIApplicationCommandInteraction
+        ? boolean
+        : never;
     readonly execute: (props: InteractionExecuteArgs<T>) => Awaitable<void>;
     readonly autocomplete?: T extends APIChatInputApplicationCommandInteraction
         ? (

diff --git a/server/index.ts b/server/index.ts
@@ -1,30 +1,51 @@
 import { setTimeout } from 'node:timers/promises';
 import { inspect } from 'node:util';
-import { commands, loadComponents } from './components/loader.js';
-import { api, botToken, gateway } from './utils/env.js';
+import {
+    globalCommands,
+    guildSpecificCommands,
+    loadComponents,
+} from './components/loader.js';
+import { api, botToken, gateway, guildId } from './utils/env.js';
 
 (async () => {
-    await setTimeout(0);
+    await setTimeout(0); // avoids console messages possibly conflicting with annoying experimental warning
 
     if (!botToken) {
         console.log(
-            '^1[ERROR] Please provide a bot token with the ^3discordbot:botToken ^1convar and restart the resource.^7',
+            '^1Please provide a bot token with the ^3discordbot:botToken ^1convar and restart the resource^7',
         );
         return;
     }
+    if (!guildId) {
+        console.log(
+            "^3Server-specific commands won't work because the ^5discordbot:guildId ^3convar wasn't specified^7",
+        );
+    }
 
     loadComponents();
 
     const app = await api.oauth2.getCurrentBotApplicationInformation();
     RegisterCommand(
-        'discordbot:deploy',
+        'discordbot:deployCommands',
         async () => {
-            const result =
+            const global =
                 await api.applicationCommands.bulkOverwriteGlobalCommands(
                     app.id,
-                    commands,
+                    globalCommands,
                 );
-            console.log(`Successfully deployed ${result.length} command(s)!`);
+
+            let guildSpecific = null;
+            if (guildId)
+                guildSpecific =
+                    await api.applicationCommands.bulkOverwriteGuildCommands(
+                        app.id,
+                        guildId,
+                        guildSpecificCommands,
+                    );
+
+            console.log(
+                `Successfully deployed ${global.length} global command(s)${guildSpecific ? ` and ${guildSpecific.length} server-specific command(s)` : ''}!`,
+            );
         },
         true,
     );

diff --git a/server/utils/env.ts b/server/utils/env.ts
@@ -3,6 +3,7 @@ import { REST } from '@discordjs/rest';
 import { WebSocketManager } from '@discordjs/ws';
 
 export const botToken = GetConvar('discordbot:botToken', '');
+export const guildId = GetConvar('discordbot:guildId', '');
 
 export const rest = new REST({ version: '10' }).setToken(botToken);
 export const gateway = new WebSocketManager({