Mirrors/itch-dl
2
0
Fork 0
mirror of https://github.com/DragoonAethis/itch-dl.git synced 2025-02-01 22:32:37 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Configuration Files (markdown)

Ryszard Knop 2025-01-31 23:59:03 +01:00
parent 3dd230e636
commit e18081acc3
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Configuration-Files.md

@ -1,10 +1,10 @@
Some itch-dl settings can be saved permanently. The configuration file lives in: Some itch-dl settings can be saved permanently. The main configuration file lives in:
- Windows: `C:/Users/<username>/AppData/Roaming/itch-dl/config.json` - Windows: `C:/Users/<username>/AppData/Roaming/itch-dl/config.json`
- macOS: `~/Library/Application Support/itch-dl/config.json` - macOS: `~/Library/Application Support/itch-dl/config.json`
- Linux: `~/.config/itch-dl/config.json` (respects `XDG_CONFIG_HOME` if set) - Linux: `~/.config/itch-dl/config.json` (respects `XDG_CONFIG_HOME` if set)
The `config.json` file is a JSON file with the following structure (make sure your file does **NOT** have comments): The `config.json` file has the following structure (everything except the `api_key` is optional, make sure your file does **NOT** have comments):
```json ```json
{ {
@ -48,4 +48,9 @@ Profiles are an easy way to switch between multiple configs - for example, if yo
- Create `<name>.json` files within that `profiles` directory. Their format is the same as the main `config.json` file. - Create `<name>.json` files within that `profiles` directory. Their format is the same as the main `config.json` file.
- When running itch-dl, use the `--profile <name>` argument to load a specified profile. - When running itch-dl, use the `--profile <name>` argument to load a specified profile.
The main `config.json` file is always loaded first, if it exists - the profile overrides values from the main config file.
## Load Order
- The main `config.json` file is loaded first, if it exists.
- The profile config overrides values from the main config file, if it exists.
- Command line arguments override both of the above.