Vivid
Build, design and maintain Vivid.
Home · Documentation · Contributing · Releases
Guides for building Vivid, connecting media servers and maintaining the app on Apple devices. The mobile layout guide covers the current iPhone/iPad navigation, spotlight, saved lists, settings and validation limits.
| Guide | What it covers |
|---|---|
| Build and contribute | Xcode setup, local signing and validation |
| Server connections | Saved accounts, private iCloud sync and restore troubleshooting, deletion rules, profile PINs, plugins, MDBList completed-watch exports and watchlist sync and server integration status |
| App design | Shared appearance, downloads, components, accessibility and diagnostics reports |
| Apple TV browsing | Discovery spotlight, native catalog menus, detail pages, trailers, similarity, Settings and startup |
| Apple TV focus | Focus ownership and navigation rules |
| Playback | Lucid Engine on Apple TV, iPhone and iPad, compatible audio, embedded and OpenSubtitles tracks, chapters, controls, downloads, resume updates and verification |
| Branding | Vivid's silver logo, documentation headers and Apple app icons |
| Diagnostics relay | The Cloudflare Worker that receives reports sent from Settings → Diagnostics and emails them to the diagnostics inbox, with setup and tests |
| Releases | GitHub version rules, independent Apple build numbers, current distribution policy and historical build records |
| Device distribution | TestFlight distribution, signing checks and device coverage |
| Source licence and attribution | GPLv3, Apple distribution permission, Vivid attribution and third-party boundaries |
| Third-party libraries | FFmpeg, subtitle/font libraries, licences and exact source |
| Brand policy | Use of the Vivid name and logo |
Use App Design for shared appearance and startup, Server Connections for account and Home refresh behaviour, and Apple TV Focus for Home loading and focus boundaries. Other guides summarise or link to these details. Dated validation records apply to their stated revisions; current implementation descriptions do not extend that device coverage.
Vivid is the shared player core. Each server has a separate server core that supplies its connection, data and playback sources. Lucid Engine provides iOS and tvOS playback; the server cores are responsibility boundaries within the app, not separate provider packages.
| Core | Documentation |
|---|---|
| Vivid core | Shared player, controls and intro/recap/credits skipping |
| Player engine core | Lucid playback on iOS and tvOS, native dependencies, settings and verification |
| Silo server core | Current Silo connection and its boundary with the player |
| Emby server core | Emby implementation, provider boundaries and verification gaps |
| Jellyfin server core | Native connection and current verification limits |
Note
Silo, Emby and Jellyfin have separate native server cores on iPhone, iPad and Apple TV. Their guides distinguish implemented features, passed automated checks and remaining device-verification gaps. Use the source and resolved package revisions to check what a build implements.
Important
Keep documentation accurate as behaviour changes. Documentation edits do not require separate approval; visual design and publishing remain owner-controlled. See the documentation policy.