From b6c525cb76dc65f6ec0c7ee02bac0f1e5f5e7d38 Mon Sep 17 00:00:00 2001
From: Toastie <toastie@dragonschildstudios.com>
Date: Mon, 13 Jan 2025 12:02:59 +0000
Subject: [PATCH] Add Configuration

---
 Configuration.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 Configuration.md

diff --git a/Configuration.md b/Configuration.md
new file mode 100644
index 0000000..f6bab20
--- /dev/null
+++ b/Configuration.md
@@ -0,0 +1,41 @@
+## Settings File
+
+EllieHub saves user preferences and metadata about bot instances in a file called `config.json`. This file is often located at:
+- `C:\Users\username\AppData\Roaming\EllieHub` on Windows.
+- `/home/username/.config/EllieHub` on Linux.
+- `/Users/username/EllieHub` on macOS.
+
+Dependencies will also be stored in the same location.
+
+### Default Values
+
+When EllieHub is executed for the first time, it creates a `config.json` file with the following values:
+
+```json
+{
+  "BotsDirectoryUri": "C:\\Users\\user\\Documents\\EllieHubDebug\\Bots",
+  "BotsBackupDirectoryUri": "C:\\Users\\user\\Documents\\EllieHubDebug\\Backups",
+  "LogsDirectoryUri": "C:\\Users\\user\\Documents\\EllieHubDebug\\Logs",
+  "Theme": 0,
+  "AutomaticUpdates": true,
+  "MinimizeToTray": true,
+  "LogMaxSizeMb": 0.5,
+  "WindowSize": {
+    "Width": 885,
+    "Height": 570
+  },
+  "BotEntries": {}
+}
+```
+
+Out of these, only `AutomaticUpdates` is not configurable from the UI. If you don't want EllieHub to update itself, set the value for `AutomaticUpdates` to `false`.
+
+The initial values for `BotsDirectoryUri`, `BotsBackupDirectoryUri`, and `LogsDirectoryUri` will vary according to the operating system you're using.
+
+## Automatic Updates
+
+By default, EllieHub will attempt to update itself by checking the [releases page][EllieHubReleases] for the latest version and comparing it to its own version. If you wish to stop this behavior, set the `AutomaticUpdates` in the `config.json` file to `false`.
+
+Additionally, EllieHub will never try to update itself if it has no write permission to the directory it is currently located in.
+
+[EllieHubReleases]: https://toastielab.dev/EllieBotDevs/EllieHub/releases/latest
\ No newline at end of file