Plex plugin scaffold for Retreivr-backed music search and acquisition.
This repo is an early scaffold, not a fully verified Plex integration.
Important constraint:
- Plex deprecated the traditional plugin/channel ecosystem years ago.
- That means less native UI reach, less predictable install behavior, and a generally weaker extension model than Jellyfin.
What still transfers well from the Jellyfin work:
- Retreivr API contract usage
- backend health/status checks
- MusicBrainz-backed artist/album/track search through Retreivr
- track enqueue and full-album enqueue actions
- release packaging and operator docs
What does not transfer as cleanly:
- rich native homepage UI integration
- modern first-class plugin catalog distribution
- deep playback and library-surface injection
This plugin depends on a running Retreivr server.
Fastest setup path:
- Retreivr core repo:
https://github.com/sudoStacks/retreivr - release asset:
retreivr-docker-starter-<tag>.zip
For most installs, both the Resolution API and Retreivr Core base URL should point to the same Retreivr server root:
http://RETREIVR_HOST:8000
This scaffold currently targets:
- backend status view
- Retreivr UI URL display
- artist search
- album drilldown
- track drilldown
- track enqueue
- full album enqueue
RetreivrPlex.bundle/- manual-install Plex bundle scaffold
docs/- setup and roadmap notes
.github/workflows/release.yml- tagged release packaging for the
.bundlezip
- tagged release packaging for the
The expected install artifact is:
RetreivrPlex.bundle.zipRetreivrPlex.bundle-v<tag>.zip
After packaging, the extracted RetreivrPlex.bundle directory should be placed into the Plex plug-ins directory on the Plex server host.
- tagged releases matching
v*package the bundle - no per-push CI is required
Release notes and tag flow:
This scaffold was generated in an environment without a Plex runtime, so it is source-prepared but not runtime-validated yet.