Mantle documentation
Mantle is a movie and TV client. It shows titles, finds ways to play them and keeps your library, lists and progress. Everything beyond its core comes from plugins. It runs as a Windows desktop app, as a web build that a browser runs on its own with no server (a phone's included), and as an Android app. These pages explain how to set it up and use it, and how to build it and how it fits together.
Guides
For people using Mantle.
| Page | What it covers |
|---|---|
| Getting started | Choosing a build, installing and updating the desktop app, the first run step by step, profiles and PINs, and tips. |
| Plugins | Turning plugins on, setting them up, signing in by code, installing from repositories and links, Stremio addons, priority and permissions. |
| Jellyfin | Connecting your own Jellyfin server, what appears where, playing its files and importing what you watched. |
| Real-Debrid and TorBox | Setting up the two debrid accounts, how sources are found and marked, and what happens while a release is fetched. |
| Sharing a setup | Picking which plugins, settings and lists to share, as a code or a file, what is never shared, and bringing someone else's in. |
| Your data | Where Mantle keeps what you made, moving it, backing it up and restoring it, and what happens when a file will not open. |
| Mantle Together | Your household's optional account: signing in, the recovery code, adding devices with or without the email, syncing profiles, what stays on one device, and what the service sees. |
| Friends and watch parties | Making friends, sharing a list, watching together in a party, and the links that carry invites. |
| Web and phone | The web build (Mantle in your browser), using Mantle from a phone, the Android app, the phone interface's gestures and security notes. |
For developers
| Page | What it covers |
|---|---|
| Building and testing | Every mk command, the toolchains, where outputs go, and what the tests run. |
| The Together service: backups, restores and alerts | For the maintainer: what production's backups can restore and how to try it, the uptime check and the limits to watch. |
| Releasing and hosting | For the maintainer: the channels and their services, the release key, tagging and publishing, the site, the homepage and the wiki. |
| Architecture | A map of the parts: the core, the server and its hosts, plugins, the frontend, sync, and how the desktop, web and Android builds share one core and one API. |
| Internals | The detail behind the map: measurements, workarounds and edge cases, part by part. |
| Writing plugins | The plugin author guide: the plugin object, what init adds, what functions take and return, the Lua sandbox and plugin tests. |
Other files
- Repository README: the project overview.
- Design reference: a clickable prototype of every screen. Open it in a browser.
This page is made from docs/README.md in the repository.