Kaleido/README.md
Elijah 64ad7b55cd
All checks were successful
Validate and publish Kaleido / android (push) Successful in 2m44s
Release Kaleido 0.2.0 with remote-ready search, quick actions, extras and playback settings
Fix the 0.1.11 audit findings: Search results were unreachable from the
text field, Back exited from Home rows, only the first version/part played,
a moved server was never re-discovered, chapter names were off by one,
menus opened away from the current choice, and focus restoration misfired.

Add long-press/Menu title actions, trailers and extras, voice and system
search, View all rows, a per-destination library choice, autoplay and
auto-skip settings, a separate remote quality, and subtitle size/style.

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

72 lines
5.2 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 pages list every episode with its synopsis.
- **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, season or whole show watched or unwatched from its information page. 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.1.8** 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 cinematic featured artwork and a Continue Watching row](docs/screenshots/home.webp)](docs/screenshots/home.webp)
| Movie discovery | TV discovery |
| --- | --- |
| [![Movies with focused backdrop artwork, audience ratings, and recently released posters](docs/screenshots/movies.webp)](docs/screenshots/movies.webp) | [![TV shows with next-episode thumbnails and newly added seasons](docs/screenshots/tv.webp)](docs/screenshots/tv.webp) |
| Movie information and cast | TV show information and seasons |
| --- | --- |
| [![Movie information with synopsis, ratings, watched controls and actor portraits](docs/screenshots/details.webp)](docs/screenshots/details.webp) | [![TV show information with a fitted poster, readable synopsis and Seasons first](docs/screenshots/show.webp)](docs/screenshots/show.webp) |
| Actor filmography | Settings |
| --- | --- |
| [![Actor page showing available movies and television series across Plex libraries](docs/screenshots/actors.webp)](docs/screenshots/actors.webp) | [![Settings category rail with playback quality and watched preferences](docs/screenshots/settings.webp)](docs/screenshots/settings.webp) |
| A–Z library | Cast and related shows |
| --- | --- |
| [![Movie library with a six-column poster grid, genre filters, and sorting](docs/screenshots/library.webp)](docs/screenshots/library.webp) | [![Show information with actor portraits and related series from Plex](docs/screenshots/related.webp)](docs/screenshots/related.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.