From 50db1fd0c522b74586ff599457d522fdf3be748a Mon Sep 17 00:00:00 2001 From: Dragoon Aethis Date: Sun, 12 Jun 2022 14:31:03 +0200 Subject: [PATCH] Initial config docs --- Configuration-Files.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 Configuration-Files.md diff --git a/Configuration-Files.md b/Configuration-Files.md new file mode 100644 index 0000000..2986f0a --- /dev/null +++ b/Configuration-Files.md @@ -0,0 +1,24 @@ +Some itch-dl settings can be saved permanently. The configuration file lives in: + +- Windows: `C:/Users//AppData/Roaming/itch-dl/config.json` +- macOS: `~/Library/Application Support/itch-dl/config.json` +- 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): + +```json +{ + // itch.io API key + "api_key": "UeqKR3nBrVCxM32qt....Ga0FH2TwwbDPIDhseFZ" +} +``` + +## Profiles + +Profiles are an easy way to switch between multiple configs - for example, if you have multiple accounts (main/developer/~~horny~~) and you'd like to easily switch the API key used for downloading a given title. By default, no profile is loaded. + +- Create a `profiles` directory next to the `config.json` file. +- Create `.json` files within that `profiles` directory. Their format is the same as the main `config.json` file. +- When running itch-dl, use the `--profile ` 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. \ No newline at end of file