User vs Server Preferences (#80)

* Update: Server vs User prefs

* Add: User vs Server Prefs

* Update: version increment

* Fix: src and tests added to validation range

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Bug Report for Fixes/Improvements
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest Features
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+## Issue
+A clear and concise description of what the problem/feature is.
+
+## Solution
+* Provide steps or ideals to how to implement or investigate this new feature.
+
+## References
+* Provide additional context and external references here

.github/pull_request_template.md

@@ -0,0 +1,17 @@
+## Steps to Creating a Pull Request
+* Assign yourself as the **Assignee**
+* Allow one of the Code Owners/Maintainers review the changes proposed by the Pull Request.
+* Provide appropriate labels as necessary
+
+> [!TIP]
+> `enchancement` for new features, `documentation` for modifications to the docs, `performance` for performance related changes, and so on.
+
+* Provide a description of the work that has been done.
+    * It is nice to know what was added, removed, modified, and with screenshots of those changes.
+
+> [!TIP]
+> You can have them under **Added**, **Removed**, **Updates**, and **Screenshots** if any (**Changes** could also be used).
+
+## After the Pull Request is Opened
+* One the Pull Request has been created, please add any Issue(s) that are being addressed by this change (if any).
+* If the reviewer(s) mention any changes or open threads for questions, please resolve those as soon as you can.

.github/workflows/build.yml

@@ -6,6 +6,8 @@ on:
       - master
     paths:
       - '/'
+      - 'src/**'
+      - 'tests/**'
       - '!docs/**'
       - '!imgs/**'
       - '!.github/**'

.github/workflows/test.yml

@@ -6,6 +6,8 @@ on:
       - master
     paths:
       - '/'
+      - 'src/**'
+      - 'tests/**'
       - '!docs/**'
       - '!imgs/**'
       - '!.github/**'

README.md

@@ -20,8 +20,11 @@ The project aims to:
   * [x] Slash Commands Compatible
   * [x] Generated Token Length Handling for >2000
     * [x] Token Length Handling of any message size
-  * [ ] External WebUI Integration
+  * [ ] User vs. Server Preferences
+  * [ ] Redis Caching
   * [x] Administrator Role Compatible
+  * [ ] Multi-User Chat Generation (Multiple users chatting at the same time)
+  * [ ] Automatic and Manual model pulling through the Discord client
 * [ ] Allow others to create their own models personalized for their own servers!
   * [ ] Documentation on creating your own LLM
   * [ ] Documentation on web scrapping and cleaning
@@ -33,25 +36,21 @@ The project aims to:
 * Please refer to the docs for bot setup.
     * [Local Machine Setup](./docs/setup-local.md)
     * [Docker Setup for Servers and Local Machines](./docs/setup-docker.md)
+        * Nvidia is recommended for now, but support for other GPUs should be development.
         * Local use is not recommended.
-
-> [!NOTE]
-> These guides assume you already know how to setup a bot account for discord. Documentation will be added later.
+    * [Creating a Discord App](./docs/setup-discord-app.md)
 
 ## Resources
 * [NodeJS](https://nodejs.org/en)
-    * This project uses `v20.10.0+` (npm `10.2.5`). Consider using [nvm](https://github.com/nvm-sh/nvm) for multiple NodeJS versions.
-        * To run dev in `ts-node`, using `v18.18.2` is recommended. 
+    * This project runs on `lts\hydrogen`.
+        * To run dev in `ts-node`/`nodemon`, using `v18.18.2` is recommended. 
         * To run dev with `tsx`, you can use `v20.10.0` or earlier.
     * This project supports any NodeJS version above `16.x.x` to only allow ESModules.
-* [Ollama](https://ollama.ai/)
+* [Ollama](https://ollama.com/)
     * [Ollama Docker Image](https://hub.docker.com/r/ollama/ollama)
 
-> [!NOTE]
-> For Nvidia GPU setup, **install** `nvidia container toolkit/runtime` then **configure** it with Docker to utilize Nvidia driver.
-
 > [!CAUTION]
-> `v18.X.X` or `lts/hydrogen` will not run properly for `npm run dev-mon`.
+> `v18.X.X` or `lts/hydrogen` will not run properly for `npm run dev-mon`. It is recommended to just use `npm run dev-tsx` for development. The nodemon version will likely be removed in a future update.
 
 * [Discord Developer Portal](https://discord.com/developers/docs/intro)
 * [Discord.js Docs](https://discord.js.org/docs/packages/discord.js/main)

docker-compose.yml

@@ -8,7 +8,7 @@ services:
     build: ./                     # find docker file in designated path
     container_name: discord
     restart: always               # rebuild container always
-    image: discord/bot:0.5.2
+    image: discord/bot:0.5.4
     environment:
       CLIENT_TOKEN: ${CLIENT_TOKEN}
       GUILD_ID: ${GUILD_ID}

docs/setup-discord-app.md

@@ -0,0 +1,47 @@
+## Discord App/Bot Setup
+* Refer to the [Discord Developers](https://discord.com/build/app-developers) tab on their site.
+* Click on **Getting Started** and it may prompt you to log in. Do that.
+* You should see this upon logging in.
+
+![First App!](../imgs/tutorial/discord-dev.png)
+
+* Click on **Create App**, you should not be prompted to create an App with a name. If you are apart of a team, you may choose to create it for your team or for yourself.
+
+![App Create Modal](../imgs/tutorial/create-app.png)
+
+* Great! Not you should have your App created. It should bring you to a page like this.
+
+![Created App](../imgs/tutorial/created-app.png)
+
+* From here, you will need you App's token, navigate to the **Bot** tab and click **Reset Token** to generate a new token to interact with you bot.
+* The following app will not exist, usage of this token will be pointless as this is a guide.
+
+![Token](../imgs/tutorial/token.png)
+
+* You will also need your App's **Client ID**, navigate to **OAuth2** and copy your id.
+
+![Client Id](../imgs/tutorial/client-id.png)
+
+* That should be all of the environment variables needed from Discord, now we need this app on your server.
+* Navigate to **Installation** and Copy the provided **Install Link** to allow your App to your server.
+* You should set the **Guild Install** permissions as you like, for this purpose we will allow admin priviledges for now. Ensure the **bot** scope is added to do this.
+
+![Scope](../imgs/tutorial/scope.png)
+![Invite Link](../imgs/tutorial/invite.png)
+
+* Notice that your App's **Client Id** is apart of the **Install Link**.
+* Paste this link in a web browser and you should see something like this.
+
+![Server Invite Initial](../imgs/tutorial/server-invite-1.png)
+
+* Click **Add to Server** and you should see this.
+
+![Server Invite Auth](../imgs/tutorial/server-invite-2-auth.png)
+
+* Choose a server to add the App to, then click **Continue** then **Authorize**. You should see this after that.
+
+![Invite Success](../imgs/tutorial/server-invite-3.png)
+
+* Congratulations! You should now see you App on your server!
+
+![Its Alive!](../imgs/tutorial/bot-in-server.png)

docs/setup-docker.md

@@ -47,6 +47,7 @@ sudo systemctl restart docker
     * `DISCORD_IP = 172.18.0.3`
     * `SUBNET_ADDRESS = 172.18.0.0`
     * Don't understand any of this? watch a Networking video to understand subnetting.
+    * You also need all environment variables shown in [`.env.sample`](../.env.sample)
 * You will need a model in the container for this to work properly, on Docker Desktop go to the `Containers` tab, select the `ollama` container, and select `Exec` to run as root on your container. Now, run `ollama pull [model name]` to get your model.
     * For Linux Servers, you need another shell to pull the model, or if you run `docker compose build && docker compose up -d`, then it will run in the background to keep your shell. Run `docker exec -it ollama bash` to get into the container and run the samme pull command above.
 * Otherwise, there is no need to install any npm packages for this, you just need to run `npm run start` to pull the containers and spin them up.
@@ -54,6 +55,7 @@ sudo systemctl restart docker
     * `docker compose stop`
     * `docker compose rm`
     * `docker ps` to check if containers have been removed.
+    * This may not work if the nvidia installation was done incorrectly. If this is the case, please utilize the [Manual "Clean-up"](#manual-run-with-docker) shown below.
 * You can also use `npm run clean` to clean up the containers and remove the network to address a possible `Address already in use` problem.
 
 ## Manual Run (with Docker)

docs/setup-local.md

@@ -1,19 +1,24 @@
 ## Ollama Setup
 * Go to Ollama's [Linux download page](https://ollama.ai/download/linux) and run the simple curl command they provide. The command should be `curl https://ollama.ai/install.sh | sh`.
-* Now the the following commands in separate terminals to test out how it works!
+* Since Ollama will run as a systemd service, there is no need to run `ollama serve` unless you disable it. If you do disable it or have an older `ollama` version, do the following:
     * In terminal 1 -> `ollama serve` to setup ollama
     * In terminal 2 -> `ollama run [model name]`, for example `ollama run llama2`
         * The models can vary as you can create your own model. You can also view ollama's [library](https://ollama.ai/library) of models.
-    * If there are any issues running ollama because of missing LLMs, run `ollama pull [model name]` as it will pull the model if Ollama has it in their library.
+* Otherwise, if you have the latest `ollama`, you can just run `ollama run [model name]` rather than running this in 2 terminals.
+* If there are any issues running ollama because of missing LLMs, run `ollama pull [model name]` as it will pull the model if Ollama has it in their library.
     * This can also be done in [wsl](https://learn.microsoft.com/en-us/windows/wsl/install) for Windows machines.
+    * This should also not be a problem is a future feature that allows for pulling of models via discord client. For now, they must be pulled manually.
 * You can now interact with the model you just ran (it might take a second to startup).
     * Response time varies with processing power!
 
 ## To Run Locally (without Docker)
 * Run `npm install` to install the npm packages.
 * Ensure that your [.env](../.env.sample) file's `OLLAMA_IP` is `127.0.0.1` to work properly.
+    * You only need your `CLIENT_TOKEN`, `GUILD_ID`, `MODEL`, `CLIENT_UID`, `OLLAMA_IP`, `OLLAMA_PORT`.
+    * The ollama ip and port should just use it's defaults by nature. If not, utilize `OLLAMA_IP = 127.0.0.1` and `OLLAMA_PORT = 11434`.
 * Now, you can run the bot by running `npm run client` which will build and run the decompiled typescript and run the setup for ollama.
     * **IMPORTANT**: This must be ran in the wsl/Linux instance to work properly! Using Command Prompt/Powershell/Git Bash/etc. will not work on Windows (at least in my experience).
     * Refer to the [resources](../README.md#resources) on what node version to use.
-* Open up a separate terminal/shell (you will need wsl for this if on windows) and run `ollama serve` to startup ollama.
+* If you are using wsl, open up a separate terminal/shell to startup the ollama service. Again, if you are running an older ollama, you must run `ollama serve` in that shell.
+    * If you are on an actual Linux machine/VM there is no need for another terminal (unless you have an older ollama version).
     * If you do not have a model, you will need to run `ollama pull [model name]` in a separate terminal to get it.

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "discord-ollama",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "discord-ollama",
-      "version": "0.5.2",
+      "version": "0.5.4",
       "license": "ISC",
       "dependencies": {
         "discord.js": "^14.15.3",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-ollama",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "description": "Ollama Integration into discord",
   "main": "build/index.js",
   "exports": "./build/index.js",

src/commands/capacity.ts

@@ -23,7 +23,7 @@ export const Capacity: SlashCommand = {
         if (!channel || channel.type !== (ChannelType.PublicThread && ChannelType.GuildText)) return
 
         // set state of bot chat features
-        openConfig('config.json', interaction.commandName, interaction.options.get('context-capacity')?.value)
+        openConfig(`${interaction.client.user.username}-config.json`, interaction.commandName, interaction.options.get('context-capacity')?.value)
 
         interaction.reply({
             content: `Message History Capacity has been set to \`${interaction.options.get('context-capacity')?.value}\``,

src/commands/channelToggle.ts

@@ -24,7 +24,7 @@ export const ChannelToggle: SlashCommand = {
 
 
         // set state of bot channel preferences
-        openConfig('config.json', interaction.commandName, interaction.options.get('toggle-channel')?.value)
+        openConfig(`${interaction.guildId}-config.json`, interaction.commandName, interaction.options.get('toggle-channel')?.value)
 
         interaction.reply({
             content: `Channel Preferences have for Regular Channels set to \`${interaction.options.get('toggle-channel')?.value}\``,

src/commands/disable.ts

@@ -32,7 +32,7 @@ export const Disable: SlashCommand = {
         }
 
         // set state of bot chat features
-        openConfig('config.json', interaction.commandName, interaction.options.get('enabled')?.value)
+        openConfig(`${interaction.guildId}-config.json`, interaction.commandName, interaction.options.get('enabled')?.value)
 
         interaction.reply({
             content: `Chat features has been \`${interaction.options.get('enabled')?.value ?  "enabled" : "disabled" }\``,

src/commands/messageStream.ts

@@ -23,7 +23,7 @@ export const MessageStream: SlashCommand = {
         if (!channel || channel.type !== (ChannelType.PublicThread && ChannelType.GuildText)) return
 
         // save value to json and write to it
-        openConfig('config.json', interaction.commandName, interaction.options.get('stream')?.value)
+        openConfig(`${interaction.client.user.username}-config.json`, interaction.commandName, interaction.options.get('stream')?.value)
 
         interaction.reply({
             content: `Message streaming preferences set to: \`${interaction.options.get('stream')?.value}\``,

src/commands/messageStyle.ts

@@ -23,7 +23,7 @@ export const MessageStyle: SlashCommand = {
         if (!channel || channel.type !== (ChannelType.PublicThread && ChannelType.GuildText)) return
 
         // set the message style
-        openConfig('config.json', interaction.commandName, interaction.options.get('embed')?.value)
+        openConfig(`${interaction.client.user.username}-config.json`, interaction.commandName, interaction.options.get('embed')?.value)
 
         interaction.reply({
             content: `Message style preferences for embed set to: \`${interaction.options.get('embed')?.value}\``,

src/events/messageCreate.ts

@@ -1,30 +1,38 @@
 import { embedMessage, event, Events, normalMessage, UserMessage } from '../utils/index.js'
-import { Configuration, getChannelInfo, getConfig, getThread, openChannelInfo, openConfig, openThreadInfo } from '../utils/jsonHandler.js'
+import { getChannelInfo, getServerConfig, getThread, getUserConfig, openChannelInfo, openConfig, openThreadInfo, ServerConfig, UserConfig } from '../utils/jsonHandler.js'
 import { clean } from '../utils/mentionClean.js'
 import { TextChannel, ThreadChannel } from 'discord.js'
 
 /** 
  * Max Message length for free users is 2000 characters (bot or not).
+ * Bot supports infinite lengths for normal messages.
+ * 
  * @param message the message received from the channel
  */
 export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama, client }, message) => {
     log(`Message \"${clean(message.content)}\" from ${message.author.tag} in channel/thread ${message.channelId}.`)
 
     // Do not respond if bot talks in the chat
-    if (message.author.tag === message.client.user.tag) return
+    if (message.author.username === message.client.user.username) return
 
     // Only respond if message mentions the bot
     if (!message.mentions.has(tokens.clientUid)) return
 
+    // default stream to false
     let shouldStream = false
-
-    // Try to query and send embed     
+ 
     try {
-        const config: Configuration = await new Promise((resolve, reject) => {
-            getConfig('config.json', (config) => {
+        // Retrieve Server/Guild Preferences
+        const serverConfig: ServerConfig = await new Promise((resolve, reject) => {
+            getServerConfig(`${message.guildId}-config.json`, (config) => {
                 // check if config.json exists
                 if (config === undefined) {
-                    reject(new Error('No Configuration is set up.\n\nCreating \`config.json\` with \`message-style\` set as \`false\` for regular messages.\nPlease try chatting again.'))
+                    // Allowing chat options to be available
+                    openConfig(`${message.guildId}-config.json`, 'toggle-chat', true)
+
+                    // default to channel scope chats
+                    openConfig(`${message.guildId}-config.json`, 'channel-toggle', true)
+                    reject(new Error('No Server Preferences is set up.\n\nCreating default server preferences file...\nPlease try chatting again.'))
                     return
                 }
 
@@ -38,10 +46,23 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
                 if (config.options['channel-toggle']) {
                     openChannelInfo(message.channelId,
                         message.channel as TextChannel, 
-                        message.author.tag
+                        message.author.username
                     )
                 }
 
+                resolve(config)
+            })
+        })
+
+        // Retrieve User Preferences
+        const userConfig: UserConfig = await new Promise((resolve, reject) => {
+            getUserConfig(`${message.author.username}-config.json`, (config) => {
+                if (config === undefined) {
+                    openConfig(`${message.author.username}-config.json`, 'message-style', false)
+                    reject(new Error('No User Preferences is set up.\n\nCreating preferences file with \`message-style\` set as \`false\` for regular messages.\nPlease try chatting again.'))
+                    return
+                }
+    
                 // check if there is a set capacity in config
                 if (typeof config.options['modify-capacity'] !== 'number')
                     log(`Capacity is undefined, using default capacity of ${msgHist.capacity}.`)
@@ -51,23 +72,25 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
                     log(`New Capacity found. Setting Context Capacity to ${config.options['modify-capacity']}.`)
                     msgHist.capacity = config.options['modify-capacity']
                 }
-
+    
                 // set stream state
                 shouldStream = config.options['message-stream'] as boolean || false
-
+    
                 resolve(config)
             })
         })
 
+        
+
         // need new check for "open/active" threads/channels here!
         const chatMessages: UserMessage[] = await new Promise((resolve) => {
             // set new queue to modify
-            if (config.options['channel-toggle']) {
-                getChannelInfo(`${message.channelId}-${message.author.tag}.json`, (channelInfo) => {
+            if (serverConfig.options['channel-toggle']) {
+                getChannelInfo(`${message.channelId}-${message.author.username}.json`, (channelInfo) => {
                     if (channelInfo?.messages)
                         resolve(channelInfo.messages)
                     else
-                        log(`Channel ${message.channel}-${message.author.tag} does not exist.`)
+                        log(`Channel ${message.channel}-${message.author.username} does not exist.`)
                 })
             } else {
                 getThread(`${message.channelId}.json`, (threadInfo) => {
@@ -95,7 +118,7 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
         })
         
         // undefined or false, use normal, otherwise use embed
-        if (config.options['message-style'])
+        if (userConfig.options['message-style'])
             response = await embedMessage(message, ollama, tokens, msgHist, shouldStream)
         else
             response = await normalMessage(message, ollama, tokens, msgHist, shouldStream)
@@ -113,7 +136,7 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
         })
 
         // only update the json on success
-        if (config.options['channel-toggle']) {
+        if (serverConfig.options['channel-toggle']) {
             openChannelInfo(message.channelId, 
                 message.channel as TextChannel, 
                 message.author.tag, 
@@ -127,7 +150,6 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
         }
     } catch (error: any) {
         msgHist.pop() // remove message because of failure
-        openConfig('config.json', 'message-style', false)
         message.reply(`**Error Occurred:**\n\n**Reason:** *${error.message}*`)
     }
 })

src/utils/jsonHandler.ts

@@ -3,15 +3,39 @@ import { UserMessage } from './events.js'
 import fs from 'fs'
 import path from 'path'
 
+export interface UserConfiguration {
+    'message-stream'?: boolean,
+    'message-style'?: boolean,
+    'modify-capacity': number
+}
+
+export interface ServerConfiguration {
+    'toggle-chat'?: boolean,
+    'channel-toggle'?: boolean
+}
+
+/**
+ * Parent Configuration interface
+ * 
+ * @see ServerConfiguration server settings per guild
+ * @see UserConfiguration user configurations (only for the user for any server)
+ */
 export interface Configuration {
     readonly name: string
-    options: {
-        'message-stream'?: boolean,
-        'message-style'?: boolean,
-        'toggle-chat'?: boolean,
-        'modify-capacity'?: number,
-        'channel-toggle'?: boolean
-    }
+    options: UserConfiguration | ServerConfiguration
+}
+
+/**
+ * User config to use outside of this file
+ */
+export interface UserConfig {
+    readonly name: string
+    options: UserConfiguration
+}
+
+export interface ServerConfig {
+    readonly name: string
+    options: ServerConfiguration
 }
 
 export interface Thread {
@@ -27,6 +51,14 @@ export interface Channel {
     messages: UserMessage[]
 }
 
+function isUserConfigurationKey(key: string): key is keyof UserConfiguration {
+    return ['message-stream', 'message-style', 'modify-capacity'].includes(key);
+}
+
+function isServerConfigurationKey(key: string): key is keyof ServerConfiguration {
+    return ['toggle-chat', 'channel-toggle'].includes(key);
+}
+
 /**
  * Method to open a file in the working directory and modify/create it
  * 
@@ -34,27 +66,34 @@ export interface Channel {
  * @param key key value to access
  * @param value new value to assign
  */
+// add type of change (server, user)
 export function openConfig(filename: string, key: string, value: any) {
+    const fullFileName = `data/${filename}`
+    
     // check if the file exists, if not then make the config file
-    if (fs.existsSync(filename)) {
-        fs.readFile(filename, 'utf8', (error, data) => {
+    if (fs.existsSync(fullFileName)) {
+        fs.readFile(fullFileName, 'utf8', (error, data) => {
             if (error)
                 console.log(`[Error: openConfig] Incorrect file format`)
             else {
                 const object = JSON.parse(data)
                 object['options'][key] = value
-                fs.writeFileSync(filename, JSON.stringify(object, null, 2))
+                fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
             }
         })
     } else { // work on dynamic file creation
-        const object: Configuration = JSON.parse('{ \"name\": \"Discord Ollama Confirgurations\" }')
+        let object: Configuration
+        if (isServerConfigurationKey(key))
+            object = JSON.parse('{ \"name\": \"Server Confirgurations\" }')
+        else
+            object = JSON.parse('{ \"name\": \"User Confirgurations\" }')
 
         // set standard information for config file and options
         object['options'] = {
             [key]: value
         }
 
-        fs.writeFileSync(filename, JSON.stringify(object, null, 2))
+        fs.writeFileSync(`data/${filename}`, JSON.stringify(object, null, 2))
         console.log(`[Util: openConfig] Created '${filename}' in working directory`)
     }
 }
@@ -65,10 +104,35 @@ export function openConfig(filename: string, key: string, value: any) {
  * @param filename name of the configuration file to get
  * @param callback function to allow a promise from getting the config
  */
-export async function getConfig(filename: string, callback: (config: Configuration | undefined) => void): Promise<void> {
+export async function getServerConfig(filename: string, callback: (config: ServerConfig | undefined) => void): Promise<void> {
+    const fullFileName = `data/${filename}`
+
     // attempt to read the file and get the configuration
-    if (fs.existsSync(filename)) {
-        fs.readFile(filename, 'utf8', (error, data) => {
+    if (fs.existsSync(fullFileName)) {
+        fs.readFile(fullFileName, 'utf8', (error, data) => {
+            if (error) {
+                callback(undefined) 
+                return // something went wrong... stop
+            }
+            callback(JSON.parse(data))
+        })
+    } else {
+        callback(undefined) // file not found
+    }
+}
+
+/**
+ * Method to obtain the configurations of the message chat/thread
+ * 
+ * @param filename name of the configuration file to get
+ * @param callback function to allow a promise from getting the config
+ */
+export async function getUserConfig(filename: string, callback: (config: UserConfig | undefined) => void): Promise<void> {
+    const fullFileName = `data/${filename}`
+
+    // attempt to read the file and get the configuration
+    if (fs.existsSync(fullFileName)) {
+        fs.readFile(fullFileName, 'utf8', (error, data) => {
             if (error) {
                 callback(undefined) 
                 return // something went wrong... stop