command(gamification): add support for a custom level-up message

Allows admin to use `/config gamification` to set a custom level-up message for users. It supports some predefined tokens: %%level%%, %%date%% and %%time%%. Fixes: TheBastionBot#1081
cotton105 · Jan 12, 2025 · ecc3b05 · ecc3b05
1 parent cdaa78f
commit ecc3b05
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 1 deletion.
diff --git a/src/commands/config/gamification.ts b/src/commands/config/gamification.ts
@@ -26,6 +26,11 @@ class GamificationCommand extends Command {
                     description: "The channel where the level up messages will be sent.",
                     channel_types: [ ChannelType.GuildText ],
                 },
+                {
+                    type: ApplicationCommandOptionType.String,
+                    name: "message",
+                    description: "A custom message to send on level up. Supports tokens: %%level%%, %%date%%, %%time%%."
+                },
                 {
                     type: ApplicationCommandOptionType.Number,
                     name: "multiplier",
@@ -40,6 +45,7 @@ class GamificationCommand extends Command {
         await interaction.deferReply();
         const messages = interaction.options.getBoolean("messages");
         const channel = interaction.options.getChannel("channel");
+        const customMessage = interaction.options.getString("message");
         const multiplier = interaction.options.getNumber("multiplier");
 
         // check for premium membership
@@ -55,6 +61,7 @@ class GamificationCommand extends Command {
         guildDocument.gamification = messages || multiplier ? true : guildDocument.gamification ? undefined : true;
         guildDocument.gamificationMessages = typeof messages === "boolean" ? messages : guildDocument.gamificationMessages || undefined;
         guildDocument.gamificationChannel = channel?.id || undefined;
+        guildDocument.gamificationCustomMessage = customMessage || undefined;
         guildDocument.gamificationMultiplier = multiplier || guildDocument.gamificationMultiplier || undefined;
 
         await guildDocument.save();

diff --git a/src/listeners/messageCreate.ts b/src/listeners/messageCreate.ts
@@ -85,7 +85,23 @@ class MessageCreateListener extends Listener<"messageCreate"> {
 
             // achievement message
             if (guildDocument.gamificationMessages) {
-                const gamificationMessage = (message.client as Client).locales.getText(message.guild.preferredLocale, "leveledUp", { level: `Level ${ computedLevel }` });
+                let gamificationMessage = guildDocument.gamificationCustomMessage;
+                if (guildDocument.gamificationCustomMessage) {
+                    const now = new Date();
+                    const [year, month, day, hour, minute] = [
+                        () => now.getUTCFullYear().toString(),
+                        () => (now.getUTCMonth() + 1).toString().padStart(2, "0"),
+                        () => now.getUTCDate().toString(),
+                        () => now.getUTCHours().toString(),
+                        () => now.getUTCMinutes().toString()
+                    ];
+                    gamificationMessage = gamificationMessage
+                        .replaceAll(/%%level%%/g, `${computedLevel}`)
+                        .replaceAll(/%%date%%/g, `${year()}-${month()}-${day()}`)
+                        .replaceAll(/%%time%%/g, `${hour()}:${minute()}`)
+                } else {
+                    gamificationMessage = (message.client as Client).locales.getText(message.guild.preferredLocale, "leveledUp", { level: `Level ${ computedLevel }` });
+                }
 
                 if (guildDocument.gamificationChannel && message.guild.channels.cache.has(guildDocument.gamificationChannel)) {
                     (message.guild.channels.cache.get(guildDocument.gamificationChannel) as GuildTextBasedChannel)

diff --git a/src/models/Guild.ts b/src/models/Guild.ts
@@ -22,6 +22,7 @@ export interface Guild {
     musicRole?: string;
     // gamification
     gamification?: boolean;
+    gamificationCustomMessage?: string;
     gamificationMessages?: boolean;
     gamificationChannel?: string;
     gamificationMultiplier?: number;
@@ -110,6 +111,9 @@ export default mongoose.model<Guild & mongoose.Document>("Guild", new mongoose.S
     gamification: {
         type: Boolean,
     },
+    gamificationCustomMessage: {
+        type: String
+    },
     gamificationMessages: {
         type: Boolean,
     },