The bot is in a finished state (I think)

Author: Slingexe

README.md

@@ -1,16 +1,39 @@
 # hackmud-chat-client
-## Setup
-Create a discord bot using [Discord Developer Portal](https://discord.com/developers/)
-Create a discord server
+## First time setup
+Create a discord bot using [Discord Developer Portal](https://discord.com/developers/)  
+Create a discord server (Its not recommended to have this bot in a public server)  
 
-Copy (or rename) the example config "configex.json" to "config.json"
-Copy the bot's discord token to "DCTOKEN" (Application > Bot > Token)
-Copy the application's clientID to "DCCLIENTID" (Application > OAuth > ClientID)
-Copy the guildID to "DCGUILDID" (Turn on dev mode > Right Click guild > CopyID)
+### Bot Permissions
+**Make sure the bot has these permissons set, otherwise it will break!**  
+```
+    Privileged Gateway Intents
+    - Message Content Intent
 
-Run the BOT
+    Server Role Permissions
+    - View Channels
+    - Manage Channels
+    - Send Messages
+    - Add Reactions
+    - Manage Messages
+```
 
-In hackmud run the command chat_pass and copy the result
-In discord send /auth password:"pass"
-Once it says its successfully set the Token run /setup
-The guild you have setup should now have 2 categorys (chat and tell) with channels you have joined being populated under chat and filled with messages :D (If message history doesn't show up leave and rejoin the chat ingame then try again.)
+Copy (or rename) the example config "configex.json" to "config.json"  
+Copy the bot's discord token to "token" (Application > Bot > Token)  
+Copy the application's clientID to "clientId" (Application > OAuth > ClientID)  
+Copy the guildID to "guildId" (Turn on dev mode > Right Click guild > CopyID)  
+Run `node deploy-commands.js` so all the commands deploy instantly to your server  
+Run the BOT using `node index.js`  
+  
+In hackmud run the command chat_pass and copy the result  
+In discord send `/settings auth password:"pass"`  
+Once it says its successfully set the Token run `/settomgs setup` then `/client start`  
+The guild the bot is in should now have all of your users set as channels and it should start pulling messages.  
+  
+## Contributions
+All contributions are greatly appriciated! I am not great at coding so expect lots of spaghetti code.  
+
+
+Useful Links
+[Hackmud Chat API Documentation](https://hackmud.com/forums/general_discussion/chat_api_documentation)  
+[Discord ACSI Color Codes](https://gist.github.com/kkrypt0nn/a02506f3712ff2d1c8ca7c9e0aed7c06)  
+[Discord.JS Guide](https://discordjs.guide/)  

backend/pullInterval.js

@@ -0,0 +1,14 @@
+let chatPullInterval = null;
+
+module.exports = {
+    getChatPullInterval: () => chatPullInterval,
+    setChatPullInterval: (interval) => {
+        chatPullInterval = interval;
+    },
+    clearChatPullInterval: () => {
+        if (chatPullInterval) {
+            clearInterval(chatPullInterval);
+            chatPullInterval = null;
+        }
+    },
+};

commands/mud/auth.js

@@ -0,0 +1,250 @@
+const { SlashCommandBuilder } = require('discord.js');
+const fetch = require('node-fetch');
+const fs = require('node:fs');
+const { setChatPullInterval, clearChatPullInterval, getChatPullInterval } = require('./../../backend/pullInterval');
+const path = require('path');
+const { readFile } = require('fs/promises');
+
+// Full Hackmud-to-Discord color mapping //  = U+001B
+const hackmudToDiscordColors = {
+    'reset': '\', // Reset text formatting
+    '0': '', // Hackmud: #9B9B9B | Discord: Gray
+    '1': '', // Hackmud: #FFFFFF | Discord: White
+    '2': '', // Hackmud: #1EFF00 | Discord: Green
+    '3': '', // Hackmud: #0070DD | Discord: Blue
+    '4': '', // Hackmud: #B035EE | Discord: Pink
+    '5': '', // Hackmud: #FF8000 | Discord: Yellow
+    '6': '', // Hackmud: #FF8000 | Discord: Yellow
+    '7': '', // Hackmud: #FF8000 | Discord: Yellow
+    '8': '', // Hackmud: #FF8000 | Discord: Yellow
+    '9': '', // Hackmud: #FF8000 | Discord: Yellow
+    'a': '', // Hackmud: #000000 | Discord: Gray
+    'b': '', // Hackmud: #3F3F3F | Discord: Gray
+    'c': '', // Hackmud: #676767 | Discord: Gray
+    'd': '', // Hackmud: #7D0000 | Discord: Red
+    'e': '', // Hackmud: #8E3434 | Discord: Red
+    'f': '', // Hackmud: #A34F00 | Discord: Yellow
+    'g': '', // Hackmud: #725437 | Discord: Yellow
+    'h': '', // Hackmud: #A88600 | Discord: Yellow
+    'i': '', // Hackmud: #B2934A | Discord: Yellow
+    'j': '', // Hackmud: #939500 | Discord: Green
+    'k': '', // Hackmud: #495225 | Discord: Green
+    'l': '', // Hackmud: #299400 | Discord: Green
+    'm': '', // Hackmud: #23381B | Discord: Gray
+    'n': '', // Hackmud: #00535B | Discord: Cyan
+    'o': '', // Hackmud: #324A4C | Discord: Cyan
+    'p': '', // Hackmud: #0073A6 | Discord: Blue
+    'q': '', // Hackmud: #385A6C | Discord: Blue
+    'r': '', // Hackmud: #010067 | Discord: Blue
+    's': '', // Hackmud: #507AA1 | Discord: Blue
+    't': '', // Hackmud: #601C81 | Discord: Pink
+    'u': '', // Hackmud: #43314C | Discord: Gray
+    'v': '', // Hackmud: #8C0069 | Discord: Pink
+    'w': '', // Hackmud: #973984 | Discord: Pink
+    'x': '', // Hackmud: #880024 | Discord: Red
+    'y': '', // Hackmud: #762E4A | Discord: Red
+    'z': '', // Hackmud: #101215 | Discord: Gray
+    'A': '', // Hackmud: #FFFFFF | Discord: White
+    'B': '', // Hackmud: #CACACA | Discord: White
+    'C': '', // Hackmud: #9B9B9B | Discord: Gray
+    'D': '', // Hackmud: #FF0000 | Discord: Red
+    'E': '', // Hackmud: #FF8383 | Discord: Red
+    'F': '', // Hackmud: #FF8000 | Discord: Yellow
+    'G': '', // Hackmud: #F3AA6F | Discord: Yellow
+    'H': '', // Hackmud: #FBC803 | Discord: Yellow
+    'I': '', // Hackmud: #FFD863 | Discord: Yellow
+    'J': '', // Hackmud: #FFF404 | Discord: Yellow
+    'K': '', // Hackmud: #F3F998 | Discord: Green
+    'L': '', // Hackmud: #1EFF00 | Discord: Green
+    'M': '', // Hackmud: #B3FF9B | Discord: Green
+    'N': '', // Hackmud: #00FFFF | Discord: Cyan
+    'O': '', // Hackmud: #8FE6FF | Discord: Cyan
+    'P': '', // Hackmud: #0070DD | Discord: Blue
+    'Q': '', // Hackmud: #A4E3FF | Discord: Blue
+    'R': '', // Hackmud: #0000FF | Discord: Blue
+    'S': '', // Hackmud: #7AB2F4 | Discord: Blue
+    'T': '', // Hackmud: #B035EE | Discord: Pink
+    'U': '', // Hackmud: #E6C4FF | Discord: Pink
+    'V': '', // Hackmud: #FF00EC | Discord: Pink
+    'W': '', // Hackmud: #FF96E0 | Discord: Pink
+    'X': '', // Hackmud: #FF0070 | Discord: Red
+    'Y': '', // Hackmud: #FF6A98 | Discord: Red
+    'Z': '', // Hackmud: #0C112B | Discord: Gray
+};
+
+function Formatter(message) {
+    function convertHackmudColors(text) {
+        // Regex to detect backtick-wrapped strings with a leading color code
+        const regex = /`([a-zA-Z0-9])([^`]*)`/g;
+        return text.replace(regex, (match, code, content) => {
+            // Map the color code to the corresponding Discord color if it exists
+            const discordColor = hackmudToDiscordColors[code];
+            if (discordColor) {
+                return `${discordColor}${content}${hackmudToDiscordColors.reset}`;
+            }
+            // If no color is found, return the original match
+            return match;
+        });
+    }
+
+    // Extract timestamp and format it
+    const timestamp = new Date(message.t * 1000);
+    const hours = timestamp.getHours().toString().padStart(2, '0');
+    const minutes = timestamp.getMinutes().toString().padStart(2, '0');
+    const formattedTime = `${hours}${minutes}`;
+
+    // Format user, channel, and other elements
+    const formattedUser = `${message.from_user}`;
+    const formattedChnlBlue = `${message.channel}`;
+    const formattedChnlPink = `${message.channel}`;
+    const formattedTell = `tell`;
+    const messageBord = `:::`;
+
+    let formattedMessage = "";
+
+    // Apply color conversion to the message text
+    const convertedMessage = convertHackmudColors(message.msg);
+
+    if (message.is_join) {
+        formattedMessage = `\`\`\`ansi\n${formattedTime} ${formattedChnlBlue} ${formattedUser} ${messageBord} ${convertedMessage} ${messageBord}\n\`\`\``;
+    } else {
+        if (!message.channel) {
+            formattedMessage = `\`\`\`ansi\n${formattedTime} ${formattedTell} ${formattedUser} ${messageBord} ${convertedMessage} ${messageBord}\n\`\`\``;
+        } else {
+            formattedMessage = `\`\`\`ansi\n${formattedTime} ${formattedChnlPink} ${formattedUser} ${messageBord} ${convertedMessage} ${messageBord}\n\`\`\``;
+        }
+    }
+
+    return formattedMessage;
+}
+
+function NowToRubyTS() {
+    return Math.floor(Date.now() / 1000);
+}
+
+function fiveMinutesAgoToRubyTS() {
+    const fiveMinutesAgo = Date.now() - 5 * 60 * 1000;
+    return Math.floor(fiveMinutesAgo / 1000);
+}
+
+async function loadChannelMappings() {
+    const mapRaw = await readFile(path.resolve(__dirname, '../../channelMappings.json'), 'utf8');
+    return JSON.parse(mapRaw);
+}
+
+async function loadPullUsers() {
+    const configRaw = await readFile(path.resolve(__dirname, '../../config.json'), 'utf8');
+    const config = JSON.parse(configRaw);
+    return config.pullusers || [];
+}
+
+async function loadMudToken() {
+    const configRaw = await readFile(path.resolve(__dirname, '../../config.json'), 'utf8');
+    const config = JSON.parse(configRaw);
+    return config.mudtoken || [];
+}
+
+module.exports = {
+    category: 'mud',
+    data: new SlashCommandBuilder()
+	.setName('client')
+	.setDescription('Commands to manage the client')
+    .addSubcommand(subcommand =>
+		subcommand
+        .setName('start')
+        .setDescription('Starts the bot')
+    )
+    .addSubcommand(subcommand =>
+        subcommand
+        .setName('stop')
+        .setDescription('Stops the bot')
+    ),
+    async execute(interaction) {
+        const option = interaction.options.getSubcommand();
+        if (option === 'start') {
+            if (getChatPullInterval()) {
+                await interaction.reply('Chat pull loop is already running.');
+                return;
+            }
+    
+            await interaction.client.user.setStatus('online');
+            await interaction.client.user.setActivity('Listening for new messages...', { type: 'WATCHING' });
+    
+            await interaction.reply('Bot initialized. Listening for new messages...');
+    
+            let lastTimestamp = fiveMinutesAgoToRubyTS();
+    
+            async function fetchNewMessages() {
+                const channelMappings = await loadChannelMappings();
+                const pullusers = await loadPullUsers();
+                const mudtoken = await loadMudToken();
+
+                const apiUrl = 'https://www.hackmud.com/mobile/chats.json';
+                const payload = {
+                    chat_token: mudtoken,
+                    usernames: pullusers,
+                    after: lastTimestamp,
+                };
+    
+                try {
+                    const response = await fetch(apiUrl, {
+                        method: 'POST',
+                        headers: { 'Content-Type': 'application/json' },
+                        body: JSON.stringify(payload),
+                    });
+    
+                    const result = await response.json();
+    
+                    if (result.ok) {
+                        Object.entries(result.chats).forEach(([user, messages]) => {
+                            if (messages.length === 0) {
+                                //console.log(`No new messages for user: ${user}`);
+                            } else {
+                                messages.forEach(async (message) => {
+                                    const discordChannelId = channelMappings[user];
+    
+                                    if (discordChannelId) {
+                                        const formattedMessage = Formatter(message);
+    
+                                        // Fetch the Discord channel and send the message
+                                        const channel = interaction.client.channels.cache.get(discordChannelId);
+    
+                                        if (channel) {
+                                            const result = await channel.send(formattedMessage);
+                                            if (result.code === 50013) {
+                                                console.log(`No permission to send message in ${channel.name}, message not sent`);
+                                                return
+                                            }
+                                        }
+                                    }
+                                });
+                            }
+                        });
+    
+                        // Update the last timestamp
+                        lastTimestamp = NowToRubyTS();
+                    } else {
+                        console.error('Hackmud API error:', result.msg || 'Unknown error');
+                    }
+                } catch (error) {
+                    console.error('Error fetching messages:', error);
+                }
+            }
+    
+            const interval = setInterval(fetchNewMessages, 5000);
+            setChatPullInterval(interval);
+        }
+        if (option === 'stop') {
+            if (getChatPullInterval()) {
+                clearChatPullInterval();
+
+                await interaction.client.user.setStatus('idle');
+                await interaction.client.user.setActivity(null);
+
+                await interaction.reply('Chat pull loop has been stopped.');
+            } else {
+                await interaction.reply('The chat pull loop is not running.');
+            }
+        }
+    }
+}