depot-guides/README.md

depot-guides

TRaSH-Guides-style guide data for Depot — custom formats, quality definitions and quality profiles for a games pipeline, in the exact repo layout guide-sync tools already speak, so Depot gets its guide synced the same way Radarr and Sonarr get theirs.

How it plugs in

Depot ≥ 0.167.0 answers the Radarr v3 API on its normal port (customformat, qualityprofile, qualitydefinition — the guide-sync surface; Prowlarr's indexer surface lives untouched beside it). Point Recyclarr at this repo and at Depot:

# settings.yml — add this repo as a guide source (the official guides stay for your real arrs)
resource_providers:
  - name: depot-guides
    type: trash-guides
    clone_url: https://git.arch.fyi/flan/depot-guides.git
    reference: main

# configs/depot.yml — Depot poses as a Radarr instance
radarr:
  depot:
    base_url: https://YOUR-DEPOT:8760
    api_key: YOUR-DEPOT-API-TOKEN
    quality_definition:
      type: depot
    quality_profiles:
      - trash_id: 5ade0fbd9afd4f1346029d08c55b7029   # Deck Ready
      - trash_id: af01d5fa4d56625bc1e6fb51579cd8b7   # Archival
      - trash_id: ab10102c6bdbbec1fc5613f98bb1f0dd   # Console Verified

That's the whole configuration: each profile's formatItems pulls every custom format in this repo along with it, priced by the profile's score set.

What the mapping means

• Qualities are platform slugs (pc, switch, wii, …) — platform desirability is a game's quality axis. Size bands ride the Radarr min/max fields as plain GB (games have no minutes-of-runtime for Radarr's MB/min to divide over).
• Custom formats score the kind and provenance of a release (repacker, scene group, DRM-free, verified dump set, region), grounded in the release grammar games trackers actually emit. Junk (rip portals, online-fix swaps, foreign-only repacks) scores low enough that a profile minimum refuses it.
• Score sets: default (Deck-first), archival (clean files; repacks score down), console (verified dumps gate entry).
• Regex dialect is Python re (Depot's matcher), not .NET — this guide feeds Depot even though it travels over the Radarr-shaped protocol.

Editing

tools/gen.py is the single source of truth — edit the catalog there and run python3 tools/gen.py from the repo root; it rewrites docs/json/depot/** and metadata.json deterministically (trash_ids are md5 of stable slugs and never churn).