Kaleido-Desktop/README.md
Elijah a38db53161
All checks were successful
Validate Kaleido Desktop / validate (push) Successful in 1m22s
Release Kaleido Desktop 0.1.0-beta.10
- Player controls centred under the timeline: previous episode, back 10 s,
  play/pause, forward 10 s, next episode; volume and time on the left.
- Previous episode button and Shift+P.
- Draggable miniplayer, kept inside the window and remembered.
- Fix the next-episode card's buttons and the skip button being covered by
  the player's title row, and skip buttons also pausing playback.
- Drop the "Highly rated"/"Recommended" label from the hero and restore the
  gap between its logo and the details line.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-04 16:33:34 -07:00

102 lines
5.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Kaleido for Desktop
A cinematic Plex client for the desktop, built in the same artwork-led style as
[Kaleido for Android TV](https://git.elijahkuntz.com/Elijah/Kaleido), and designed for
mouse and keyboard.
Kaleido runs on Windows and macOS (Apple silicon) with the same interface and features;
each release carries both, and installed copies update themselves. The interface and
nearly all of the native core are shared, and each platform's differences live in one
place (see [Architecture](docs/architecture.md)). Linux builds browse but don't play yet.
## What's in the app
### Browse
- **Home** features recently released, highly rated and recommended titles in a rotating
cinematic hero, with Continue Watching and your server's shelves beneath it.
- **Movies** and **TV Shows** each have **Discover**, **Library** and **Collections**.
Discover leads with Continue Watching (Next Episodes for TV), new seasons, recent
releases and Plex's recommendations. Library is the full catalog: a fast, virtualized
poster grid with search, server-provided filters (genre, year, decade, content rating,
resolution, HDR, Dolby Vision, Atmos, unwatched and more), every Plex sort, an A–Z jump
rail and three poster sizes. If you have several libraries of a kind, pick which one
each destination shows.
- **Search** finds movies, shows, episodes, people and collections, with recent searches.
- **Title pages** show clear-logo art over the title's backdrop with its colour wash,
Rotten Tomatoes and IMDb scores, 4K/HDR/Atmos badges, cast and crew (select a person
for their filmography in your library), trailers and extras, related titles and an
About panel with credits and media details. Shows list their seasons and episodes.
- Rest the pointer on a poster for a quick preview; right-click any title for actions.
### Watch
- Playback uses **mpv**, so original files play directly — HEVC, AV1, Dolby Vision,
TrueHD/Atmos, DTS-HD, PGS subtitles — with hardware decoding and HDR passthrough. Plex
conversion (4K/1080p/720p/480p) is available per network type or from the player.
- Audio and subtitle tracks, subtitle timing and size, speed, chapters and versions.
- Server preview thumbnails on the timeline, Skip Intro/Credits (button or automatic),
and a next-episode countdown.
- Progress, watched state and Now Playing sync with your Plex server.
### Manage
- Mark watched/unwatched, remove from Continue Watching, rate, add to collections and
playlists, play from the beginning or pick a version.
- For server owners: edit metadata (with field locks), change posters, backgrounds and
logos, refresh metadata, analyze, fix match, unmatch, split apart and delete.
### Downloads
- Download movies, episodes or whole seasons in original quality. Downloads pause,
resume (including after restarting) and play offline; artwork is kept for offline
browsing.
### Settings and server administration
- App settings for account and server, playback, audio and subtitles, interface,
downloads, keyboard shortcuts and updates.
- Plex server settings: a live **dashboard** (streams with stop-stream, bandwidth, CPU
and memory), activity and watch history, general, remote access, library, network,
transcoder, extras, scheduled tasks and DLNA settings, **library management** (scan,
refresh, analyze, empty trash, add/edit/delete with a server folder browser), devices,
troubleshooting (logs, database, clean bundles, optimize) and a live console.
Live TV/DVR and Plex's online catalog are intentionally not included.
## Keyboard
| Browsing | | Player | |
| --- | --- | --- | --- |
| Ctrl+K (⌘K) | Search | Space / K | Play/pause |
| Arrow keys | Move between titles | ← / → | Seek (Shift: 1 min) |
| Enter / Space | Open / play | ↑ / ↓, wheel | Volume |
| Menu or Shift+F10 | Title actions | F, double-click | Full screen |
| Alt+← (⌘[) / mouse back | Back | C | Next subtitle |
| / | Focus search | Shift+P / N | Previous / next episode |
| F11 (⌃⌘F) | Full screen | Esc | Exit full screen, then player |
Keys in brackets are the macOS equivalents.
## Build from source
Requirements: Node 22+, Rust (stable); on Windows the Visual Studio C++ build tools and
7-Zip, on macOS the Xcode command line tools and Homebrew.
```powershell
npm ci
.\scripts\fetch-libmpv.ps1 # libmpv for Windows into vendor/mpv/windows
npm run tauri dev # development app
.\scripts\build.ps1 # signed release installer (NSIS)
```
```bash
npm ci
sh scripts/fetch-libmpv.sh # libmpv and its libraries into vendor/mpv/macos
npm run tauri dev # development app
sh scripts/build.sh # .app, .dmg and the signed update archive
```
During development the app signs in automatically from an ignored `.env` in the
repository root (`PLEX_SERVER_URL`, `PLEX_TOKEN`). Release builds never read it.
`npm run dev` serves the interface alone in a browser for UI work (no playback or
downloads). `npm test` runs unit tests; `npm run typecheck` checks types.
Releases and the update feed are described in [docs/development.md](docs/development.md).
Kaleido is an independent project and is not affiliated with Plex. Video playback uses
libmpv (LGPL).