flan
7802c2c5b5
The layout here is theirs and the idea of scoring releases by named custom formats is theirs; the content is not, and could not be -- their guides describe movies and TV, where quality is a resolution and a bitrate over a runtime, and a game release has neither. Borrowing the layout without saying so invites the reading that this is their work, or a fork of it. It is neither, and the people who did originate it should not have to guess which.
67 lines
3.2 KiB
Markdown
67 lines
3.2 KiB
Markdown
# depot-guides
|
|
|
|
Guide data for [Depot](https://github.com/sudolulo/depot) — custom formats, quality definitions and
|
|
quality profiles for a *games* pipeline, distributed in the repo layout guide-sync tools already
|
|
speak, so Depot gets its guide synced the same way Radarr and Sonarr get theirs.
|
|
|
|
> **Not affiliated with the TRaSH Guides.** This repository borrows their *layout* so that
|
|
> Recyclarr and similar tools work against Depot without modification, and it borrows the idea of
|
|
> scoring releases by named custom formats — both of which that project originated and deserves the
|
|
> credit for. It contains **none of their content**, and none of it would transfer if it did: their
|
|
> guides are written for movies and TV, where quality means a resolution and a bitrate over a
|
|
> runtime. A game release has no runtime, and its quality axis is which platform the release is
|
|
> for. Every definition here is written from scratch for games. For movies and TV, go to the real
|
|
> thing: <https://trash-guides.info>.
|
|
|
|
## 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:
|
|
|
|
```yaml
|
|
# 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://github.com/sudolulo/depot-guides.git
|
|
reference: main
|
|
```
|
|
|
|
```yaml
|
|
# 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).
|