Kaleido/README.md
Elijah ca5f0e20e5
All checks were successful
Validate and publish Kaleido / android (push) Successful in 2m36s
Refresh README screenshots for Kaleido 0.6.0
Retake every screenshot on Android TV and add Home rows, a season page
and Categories.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-28 19:28:32 -07:00

80 lines
5.8 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
A Plex client for Android TV, designed for browsing from the couch. Kaleido puts your movies, shows and next episodes up front, with large artwork and controls that work with a remote.
**[Download the latest release](https://git.elijahkuntz.com/Elijah/Kaleido/releases/latest)** · Android TV 9 or newer · Requires a Plex Media Server
## What's in the app
### Find something to watch
- **Home** brings together featured titles, Plex recommendations and Continue Watching. Resume a movie or get back to your current series without digging through your library.
- **Movies** starts with recent releases and recommendations. **TV Shows** leads with your next episodes, new seasons and newly added episodes.
- **Library** gives you an A–Z poster grid with genre, watched-status and sorting controls. If you have more than one movie or TV library, choose which one each section shows.
- **Search** finds movies, shows, episodes and people across your libraries. Type with the remote or search by voice.
- **Title pages** include ratings, a synopsis, trailers and extras, and cast portraits with character names. Select an actor to see their available movies and shows. Series pages put seasons first. Season and episode pages show the episode you move to in the season row; select it, or Play, to watch.
- **Quick actions**: hold OK (or press Menu) on any title to play, start over, mark it watched, remove it from Continue Watching, or jump to its season or show.
### Watch the way you want
Original quality plays the source video where your TV supports it. You can also ask Plex to convert to 4K, 1080p, 720p or 480p, with a separate limit for remote connections away from home. Titles with several versions let you pick one.
Choose audio tracks, subtitles, playback speed and chapters from the player. Tap Left or Right to skip ten seconds, or hold to scrub through the timeline with thumbnail previews. Skip intros and credits with a button or automatically, and let the next episode start after a countdown you choose. Subtitle size and style are adjustable. Previews and skip markers appear when Plex supplies them; HDR and format support depend on your TV and server.
### Keep your place
Playback progress and watched status sync with Plex, so your place carries across clients. Mark a movie, episode, season or whole show watched or unwatched from its page or its quick actions. You can set the playback percentage that counts as watched, too.
Settings groups connection, playback, subtitles, interface and updates in one place. Navigation tap sounds can be turned on or off. The built-in updater checks for releases and downloads new versions without another manual sideload.
## Install
1. Download **Kaleido.apk** from the [latest release](https://git.elijahkuntz.com/Elijah/Kaleido/releases/latest) and install it on your Android TV.
2. Open Kaleido and enter the code at [plex.tv/link](https://plex.tv/link).
3. Choose your Plex server and start browsing.
A manual server URL and token connection is also available. For future updates, use **Settings → Updates**. Android will ask you to confirm the installation.
## Screenshots
Captured from Kaleido **0.6.0** running on Android TV with a live Plex library. Select a screenshot to view it at full resolution.
**Home** — a cinematic feature with playback actions and integrated Continue Watching.
[![Kaleido Home with a cinematic featured title, playback actions and Continue Watching](docs/screenshots/home.webp)](docs/screenshots/home.webp)
Moving into the rows compacts the feature into a preview of the focused card, with its artwork, ratings, cast and formats.
[![Home rows with a compact preview of the focused Continue Watching card](docs/screenshots/home-rows.webp)](docs/screenshots/home-rows.webp)
| Movie discovery | TV discovery |
| --- | --- |
| [![Movies with a preview of the focused poster, format badges and recently released titles](docs/screenshots/movies.webp)](docs/screenshots/movies.webp) | [![TV shows with a next-episode preview and wide episode thumbnails](docs/screenshots/tv.webp)](docs/screenshots/tv.webp) |
| Movie information and cast | TV show information and seasons |
| --- | --- |
| [![Movie information with title art, ratings, format badges, actions and cast](docs/screenshots/details.webp)](docs/screenshots/details.webp) | [![TV show information with Watch next, Shuffle episodes and seven seasons](docs/screenshots/show.webp)](docs/screenshots/show.webp) |
| Season episodes | Cast and related shows |
| --- | --- |
| [![Season page previewing the focused episode above the episode row](docs/screenshots/season.webp)](docs/screenshots/season.webp) | [![Show information with actor portraits and related series from Plex](docs/screenshots/related.webp)](docs/screenshots/related.webp) |
| A–Z library | Categories |
| --- | --- |
| [![Movie library with a six-column poster grid, genre filters, sorting and alphabet jumps](docs/screenshots/library.webp)](docs/screenshots/library.webp) | [![TV categories shown as artwork tiles for each genre](docs/screenshots/categories.webp)](docs/screenshots/categories.webp) |
| Actor filmography | Settings |
| --- | --- |
| [![Actor page showing available movies across Plex libraries](docs/screenshots/actors.webp)](docs/screenshots/actors.webp) | [![Interface settings with navigation sounds, theme music and the artwork colour wash](docs/screenshots/settings.webp)](docs/screenshots/settings.webp) |
## Build from source
Kaleido is written in Kotlin with Jetpack Compose and Media3. On Windows, the local toolchain can be set up with `scripts/bootstrap.py`, then built with:
```powershell
.\Build.ps1 -Release -Test
```
See the [development guide](docs/development.md) for setup and releases, the [design notes](docs/design-system.md), and [device testing](docs/runtime-verification.md).
Kaleido is in active development. It is an independent project and is not affiliated with Plex.