Add Configuration
commit
b6c525cb76
1 changed files with 41 additions and 0 deletions
41
Configuration.md
Normal file
41
Configuration.md
Normal file
|
@ -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
|
Loading…
Reference in a new issue