Skip to content

Preset Configuration

Husko edited this page Apr 12, 2024 · 3 revisions

Details on how to make a website Preset.

Preset Example

{
    "identifier": "husko.template",
    "name": "Template",
    "author": "Husko",
    "description": "This is a Template Preset",
    "version": "1.0.0",
    "site-url": "https://github.com/husko/mul-tor/presets/template.json",
    "source-url": "https://f95zone.to/threads/approved-file-hosts-updated-2022-08-08.3432/",
    "repo-url": "https://github.com/husko/mul-tor",
    "sites": [
        "Example1",
        "Example2",
        "Example3"
    ],
    "link-format": "[URL='{file_url}']{site_name}[/URL]"
}

Preset Configuration

identifier

  • Description: The name of the preset and should be unique. It consists of author.preset_name.
  • Example: "identifier": "husko.template"

name

  • Description: The visible name of the preset in the Tool.
  • Example: "name": "Template"

author

  • Description: The author of the preset.
  • Example: "author": "Husko"

description

  • Description: The description of the preset.
  • Example: "description": "This is a Template Preset"

version

  • Description: The version of the preset. Used to check for updates using the Repo URL.
  • Example: "version": "1.0.0"

site-url

  • Description: The URL of the site that the preset is made for.
  • Example: "site-url": "https://github.com/husko/mul-tor/presets/template.json"

source-url

  • Description: The URL of the forum post with the list of approved hosts.
  • Example: "source-url": "https://f95zone.to/threads/approved-file-hosts-updated-2022-08-08.3432/"

repo-url

  • Description: The URL where the preset is hosted.
  • Example: "repo-url": "https://github.com/husko/mul-tor"

sites

  • Description: The list of sites that are whitelisted/should be auto-loaded for the target website.
  • Example:
    "sites": [
        "Example1",
        "Example2",
        "Example3"
    ]

link-format

  • Description: The format of the links that are generated. It should make the process of sharing links easier.
  • Example: "link-format": "[URL='{file_url}']{site_name}[/URL]"
  • Available: status, file_name, file_url, site, date_and_time