Spool providers

The catalogue Spool installs providers from. Spool reads two files from this repository's GitHub Pages site, https://spool-player.github.io/spool-providers/:

• official.json: first-party providers, checked at every launch
• index.json: everything, read when someone browses community providers or has one installed

Each entry names one release of one provider: its version, the archive's URL and its SHA-256. Spool installs a download only when it matches, so what you get is exactly what was reviewed here.

The official catalogue includes Jellyfin, Emby and Plex. Each provider keeps its server protocol, sign-in screens and playback-quality negotiation in its own MPL-2.0 repository under spool-player.

Publishing a provider

1. Build and release your provider (see the SDK in spool-player/spool, or start from spool-provider-example). Each release carries the .tar.zst package and its spool-provider.json:

   python3 sdk/spool-provider.py build .
   python3 sdk/spool-provider.py feed dist/<id>-<version>.tar.zst --url <where the release serves it>
   

2. Open a pull request here adding providers/<id>.json with that spool-provider.json, unchanged. The check downloads the package, compares it with the entry and runs the validation Spool runs before installing. A maintainer reviews the code.

3. For each new version, open a pull request updating the same file.

Until then, anyone can already install it in Spool from a link to its repository (Settings → Providers → Add from a link), and it will be kept up to date from its releases.

Ids starting with spool. are reserved for first-party providers, listed in official.txt. Those follow their own releases: a scheduled job (and each first-party release, through repository_dispatch) moves their entries to the latest verified release.

Maintaining

python3 tools/store.py check            # every entry: download, verify, validate
python3 tools/store.py bump             # first-party entries to their latest releases
python3 tools/store.py site _site       # what Pages serves

sdk/spool-provider.py is Spool's own validator, copied from spool-player/spool at the revision in sdk/REVISION. Needs Python 3.14 or the zstd command.