-Optimized Docker image size from 1.5GB down to ~350MB

-Docker Detection for ENV Vars
-Updated Readme for Docker
-Updated how config vars are loaded for basically every script

Author: Slingexe

.dockerignore

@@ -0,0 +1,10 @@
+.github
+.gitignore
+.git
+README.md
+formatter-test-scripts
+Dockerfile
+.dockerignore
+package-lock.json
+channelMappings.json
+config.json

.gitignore

@@ -1,3 +1,4 @@
 config.json.bak
 node_modules
 channelMappings.json
+config.json

Dockerfile

@@ -1,8 +1,14 @@
-FROM node:latest
+FROM node:20-alpine AS builder
+WORKDIR /bot
+COPY package*.json ./
+RUN npm install --omit=dev
+
+FROM node:alpine
+WORKDIR /bot
+COPY --from=builder /bot/node_modules ./node_modules
+COPY . .
+RUN echo {} >> config.json
+RUN echo {} >> channelMappings.json
+
 
-RUN mkdir -p /usr/src/bot
-WORKDIR /usr/src/bot
-COPY package.json /usr/src/bot
-RUN npm install
-COPY . /usr/src/bot
 CMD ["node", "index.js"]

README.md

@@ -31,14 +31,12 @@ Run `/settings manage-users user:username pull:True` to enable pulling messages
 Once you have done all that you are now able to run `/client start` (Once you have done all the steps above the bot should pull messages on startup)
 The guild the bot is in should now have all of your users set as channels and it should start pulling messages.  
 
-## Running in a docker  
-Make sure you have docker installed `docker -v`  
-Download and open the root of the project source code  
-Make sure to fill out all the requied fields in the config.json file (copy or use configex.json as reference)  
-I recommend running `node deploy-commands.js` before building the docker  
-Run `docker build -t hackmud-chat-client .`  
-Start the docker `docker run hackmud-chat-client`  
-The bot should start fine and you can continue the normal setup process :D  
+# Docker  
+Download the latest release image from [Gitbub](https://github.com/Slingexe?tab=packages&repo_name=hackmud-chat-client) or [DockerHub](https://hub.docker.com/r/slingexe/hackmud-chat-client)  
+Run the docker with `docker run -e TOKEN=token -e CLIENTID=clientid -e GUILDID=guildid slingexe/hackmud-chat-client`  
+Pass the `-d` argument to run the docker in detached mode  
+The continue with the regular setup process  
+
 
 ## Usage  
 Type in the channels the bot created to send a message to hackmud  

backend/docker/dockerstartup.js

@@ -0,0 +1,46 @@
+const fs = require('fs')
+const { readFile } = require('fs/promises');
+const path = require('path');
+const isDocker = require('is-docker')
+
+const env = process.env
+console.log(env)
+
+const configPath = path.resolve(__dirname, '../../config.json')
+
+async function dockerstartup() {
+    if (env.CODESPACE == 1) { // I have this since I use GitHub Codespaces and its a docker container itself :P
+        console.log("Codespace ENV Variable found. \n Not running dockerstartup");
+    }
+    else if (isDocker()) {
+        console.log('Running inside a Docker container');
+        const configRaw = await readFile(configPath, 'utf8');
+        let config
+        if (configRaw) {
+            config = JSON.parse(configRaw);
+        } else {
+            config = {}
+        }
+
+        if (env.TOKEN) {
+            config.token = env.TOKEN
+            console.log(`Found TOKEN: ${env.TOKEN}`)
+        } else {console.log("env.TOKEN not found")}
+        if (env.CLIENTID) {
+            config.clientId = env.CLIENTID
+            console.log(`Found CLIENTID: ${env.CLIENTID}`)
+        } else {console.log("env.CLIENTID not found")}
+        if (env.GUILDID) {
+            config.guildId = env.GUILDID
+            console.log(`Found GUILDID: ${env.GUILDID}`)
+        } else {console.log("env.GUILDID not found")}
+
+        fs.writeFileSync(configPath, JSON.stringify(config, null, 4));
+
+        require("./../../deploy-commands.js")
+    } else {
+        console.log("Not running inside a dockers")
+    }
+}
+
+module.exports.dockerstartup = dockerstartup;

backend/fetchNewMessages.js

@@ -1,5 +1,4 @@
-const { readFile } = require('fs/promises');
-const path = require('node:path');
+const { loadConfigVar, loadChnlMap } = require('./../backend/loadvar.js');
 
 // Full Hackmud-to-Discord color mapping //  = U+001B
 const hackmudToDiscordColors = {
@@ -143,29 +142,12 @@ function fiveMinutesAgoToRubyTS() {
     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 || [];
-}
-
 let lastTimestamp = fiveMinutesAgoToRubyTS();
 
 async function fetchNewMessages(client) {
-    const channelMappings = await loadChannelMappings();
-    const pullusers = await loadPullUsers();
-    const mudtoken = await loadMudToken();
+    const channelMappings = await loadChnlMap
+    const pullusers = await loadConfigVar("pullusers");
+    const mudtoken = await loadConfigVar("mudtoken")
     const apiUrl = 'https://www.hackmud.com/mobile/chats.json';
     const payload = {
         chat_token: mudtoken,

backend/fix.js

@@ -0,0 +1,26 @@
+const fs = require('fs')
+const { readFile } = require('fs/promises');
+const path = require('path');
+
+const configPath = path.resolve(__dirname, '../../config.json')
+const cmPath = path.resolve(__dirname, '../../channelmappings.json')
+
+async function fix() {
+    try {
+        await readFile(configPath, 'utf8');
+    } catch(error) {
+        let config = { "token":"", "clientId":"", "guildId":"" }
+        fs.writeFileSync(configPath, JSON.stringify(config, null, 4));
+        console.log("Could not find config.json, created file with defaults")
+    }
+    
+    try {
+        await readFile(cmPath, 'utf8');
+    } catch(error) {
+        let cm = {}
+        fs.writeFileSync(cmPath, JSON.stringify(cm, null, 4));
+        console.log("Could not find channelmappings.json, created file with defaults")
+    }
+}
+
+module.exports.fix = fix;

backend/loadvar.js

@@ -0,0 +1,45 @@
+const fs = require('fs');
+const { readFile } = require('fs/promises');
+const path = require('path');
+
+const configPath = path.resolve(__dirname, './../config.json');
+const channelMappingsPath = path.resolve(__dirname, './../channelMappings.json');
+
+// Ensure config.json exists
+if (!fs.existsSync(configPath)) {
+    const defaultConfig = { "token": "", "clientId": "", "guildId": "" };
+    fs.writeFileSync(configPath, JSON.stringify(defaultConfig, null, 4));
+    console.log("Could not find config.json, created file with defaults");
+}
+
+// Ensure channelMappings.json exists
+if (!fs.existsSync(channelMappingsPath)) {
+    fs.writeFileSync(channelMappingsPath, JSON.stringify({}, null, 4));
+    console.log("Could not find channelMappings.json, created file with defaults");
+}
+
+async function loadConfigVar(key) {
+    try {
+        const configRaw = await readFile(configPath, 'utf8');
+        const config = JSON.parse(configRaw);
+        return config[key] ?? null; // Return null if key doesn't exist
+    } catch (error) {
+        console.error(`Error loading config variable "${key}":`, error.message);
+        return null;
+    }
+}
+
+async function loadChnlMap() {
+    try {
+        const mapRaw = await readFile(channelMappingsPath, 'utf8');
+        return JSON.parse(mapRaw);
+    } catch (error) {
+        console.error("Error loading channel mappings:", error.message);
+        return false;
+    }
+}
+
+module.exports = {
+    loadConfigVar,
+    loadChnlMap
+};

upd.js backend/upd.jsupd.js renamed to backend/upd.js

@@ -1,5 +1,5 @@
 var checkUpdate = require('check-update-github');
-var pkg = require('./package.json');
+var pkg = require('../package.json');
 
 checkUpdate({
     name: pkg.name, 
@@ -10,6 +10,4 @@ checkUpdate({
     if(!err){
         console.log(defaultMessage);
     }
-});
-
-module.exports.checkUpdate = checkUpdate
+});

commands/mud/settings.js

@@ -1,16 +1,10 @@
 const { SlashCommandBuilder, MessageFlags } = require('discord.js');
+const { loadConfigVar, loadChnlMap } = require('./../../backend/loadvar.js');
 const fetch = require('node-fetch');
 const fs = require('node:fs');
 const path = require('path');
-const { readFile } = require('fs/promises');
 const configPath = path.resolve(__dirname, '../../config.json');
 
-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',
@@ -107,7 +101,7 @@ module.exports = {
             }
         }
         if (option === 'setup') {
-            const mudtoken = await loadMudToken();
+            const mudtoken = await loadConfigVar("mudtoken");
             if (!mudtoken || mudtoken === '') {
                 await interaction.reply({content: 'No chat token for the mud has been found. Please run /settings auth.', flags: MessageFlags.Ephemeral });
                 return;