Skip to content

Configuration

Husko edited this page Nov 30, 2023 · 1 revision

Details on how to configure the Downloader.

Config Example

{
    "version": 1.4,
    "proxies": true,
    "checkForUpdates": true,
    "oneTimeDownload": true,
    "advancedMode": false,
    "user_credentials": {
        "e621": {
            "apiUser": "",
            "apiKey": ""
        },
        "e6ai": {
            "apiUser": "",
            "apiKey": ""
        },
        "e926": {
            "apiUser": "",
            "apiKey": ""
        },
        "furbooru": {
            "apiKey": ""
        },
        "github": {
            "apiKey": ""
        }
    },
    "blacklisted_tags": [
        "example1",
        "example2"
    ],
    "blacklisted_formats": [
        "example1",
        "example2"
    ]
}

Configuration Parameters

version

  • Description: Specifies the version of the configuration format.
  • Example: "version": 1.4

proxies

  • Description: Enables or disables the use of proxies.
  • Example: "proxies": true

checkForUpdates

  • Description: Enables or disables automatic updates checks.
  • Example: "checkForUpdates": true

oneTimeDownload

  • Description: Enables or disables one-time downloads.
  • Example: "oneTimeDownload": true

advancedMode

  • Description: Enables or disables advanced mode. If enabled the check of the config version will be skipped and requires the user to update it if necessary.
  • Example: "advancedMode": false

user_credentials

  • Description: Contains API credentials for various services.

    • e621: API credentials for e621.

      • "apiUser": API username for e621.
      • "apiKey": API key for e621.
      • Example: "user_credentials": { "e621": { "apiUser": "your_username", "apiKey": "your_api_key" } }
    • e6ai: API credentials for e6ai.

      • "apiUser": API username for e6ai.
      • "apiKey": API key for e6ai.
      • Example: "user_credentials": { "e6ai": { "apiUser": "your_username", "apiKey": "your_api_key" } }
    • e926: API credentials for e926.

      • "apiUser": API username for e926.
      • "apiKey": API key for e926.
      • Example: "user_credentials": { "e926": { "apiUser": "your_username", "apiKey": "your_api_key" } }
    • furbooru: API credentials for Furbooru.

      • "apiKey": API key for Furbooru.
      • Example: "user_credentials": { "furbooru": { "apiKey": "your_api_key" } }

blacklisted_tags

  • Description: Specifies a list of tags to be blacklisted.
  • Example: "blacklisted_tags": [ "vore", "feet" ]

blacklisted_formats

  • Description: Specifies a list of formats to be blacklisted.
  • Example: "blacklisted_formats": [ "mp4", "gif", "webp" ]