Skip to content

Configuration Files

Dragoon Aethis edited this page Jun 12, 2022 · 3 revisions

Some itch-dl settings can be saved permanently. The configuration file lives in:

  • Windows: C:/Users/<username>/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):

{
    // itch.io API key - https://github.com/DragoonAethis/itch-dl/wiki/API-Keys
    "api_key": "UeqKR3nBrVCxM32qt....Ga0FH2TwwbDPIDhseFZ",

    // User agent to send with itch.io requests (defaults to "itch-dl/{version} python-requests/{version}")
    "user_agent": "Mozilla/5.0 (X11; Linux x86_64; rv:101.0) Gecko/20100101 Firefox/101.0"
}

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 <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.

The main config.json file is always loaded first, if it exists - the profile overrides values from the main config file.

Clone this wiki locally