diff --git a/docs/core/config/launchers.md b/docs/core/config/launchers.md index bc14fb2..be2b6b4 100644 --- a/docs/core/config/launchers.md +++ b/docs/core/config/launchers.md @@ -289,6 +289,20 @@ Override the default installation directory for this launcher. Only supported by Override the default server URL for this launcher. Only supported by some launchers and refers to an API base address. +#### client + +| Key | Type | Default | +| ------ | ------ | ------- | +| client | string | | + +Name of the player a [media server](../../features/launchers.md#media-servers) launcher plays on. Used by the `Jellyfin` and `Plex` launcher groups. When it's not set and exactly one player is available, Core uses that player. + +```toml +[[launchers.default]] +launcher = "Plex" +client = "Plex HTPC" +``` + #### action | Key | Type | Default | diff --git a/docs/features/launchers.md b/docs/features/launchers.md index d7e7a34..1584a58 100644 --- a/docs/features/launchers.md +++ b/docs/features/launchers.md @@ -21,12 +21,12 @@ Use your platform guide for exact setup, supported systems, and launcher limitat | Platform | Launcher integrations | | -------- | --------------------- | | [MiSTer FPGA](../platforms/mister/launchers.md) | MiSTer cores, AO486, ScummVM, video, and scripts | -| [Windows](../platforms/windows/launchers.md) | Steam, LaunchBox/Big Box, RetroBat, Flashpoint, Kodi, executables, and scripts | -| [Linux](../platforms/linux/launchers.md) | Steam, Lutris, Heroic, RetroArch, standalone emulators, EmuDeck, RetroDECK, Bottles, Faugus, Moonlight, Kodi, browser URLs, and scripts | -| [SteamOS](../platforms/steamos/launchers.md) | Steam, native emulators, RetroArch, EmuDeck, RetroDECK, Bottles, Faugus, Moonlight, Kodi, and scripts | -| [Bazzite](../platforms/bazzite.mdx#launchers) | Steam, Lutris, Heroic, standalone emulators, EmuDeck, RetroDECK, Bottles, Faugus, Moonlight, Kodi, browser URLs, and scripts | -| [ChimeraOS](../platforms/chimeraos.mdx#launchers) | Steam, ChimeraGOG, standalone emulators, EmuDeck, RetroDECK, Bottles, Faugus, Moonlight, Kodi, and scripts | -| [Batocera](../platforms/batocera/launchers.md) | EmulationStation, Kodi, and scripts | +| [Windows](../platforms/windows/launchers.md) | Steam, LaunchBox/Big Box, RetroBat, Flashpoint, Kodi, Jellyfin, Plex, executables, and scripts | +| [Linux](../platforms/linux/launchers.md) | Steam, Lutris, Heroic, RetroArch, standalone emulators, EmuDeck, RetroDECK, Bottles, Faugus, Moonlight, Kodi, Jellyfin, Plex, browser URLs, and scripts | +| [SteamOS](../platforms/steamos/launchers.md) | Steam, native emulators, RetroArch, EmuDeck, RetroDECK, Bottles, Faugus, Moonlight, Kodi, Jellyfin, Plex, and scripts | +| [Bazzite](../platforms/bazzite.mdx#launchers) | Steam, Lutris, Heroic, standalone emulators, EmuDeck, RetroDECK, Bottles, Faugus, Moonlight, Kodi, Jellyfin, Plex, browser URLs, and scripts | +| [ChimeraOS](../platforms/chimeraos.mdx#launchers) | Steam, ChimeraGOG, standalone emulators, EmuDeck, RetroDECK, Bottles, Faugus, Moonlight, Kodi, Jellyfin, Plex, and scripts | +| [Batocera](../platforms/batocera/launchers.md) | EmulationStation, Kodi, Jellyfin, Plex, and scripts | For an emulator or media app without a built-in integration, write a [custom launcher](./custom-launchers.md). @@ -42,6 +42,48 @@ The one place this shows through is the token value. A launchable is identified A custom launcher can expose a command as a virtual system on any Core platform; see [command launchables](./custom-launchers.md#command-launchables). For MiSTer cores that launch without media, use the [`mister_core` backend](../platforms/mister/launchers.md#add-your-own-other-core). +## Media servers + +Core can index the library of a [Jellyfin](https://jellyfin.org/) or [Plex](https://www.plex.tv/) server and play its movies, TV shows, and music on a player you choose, such as a TV or a computer running the server's app. The server and player can be anywhere on your network; Core only needs to reach them. Media servers are supported on Windows, Linux, SteamOS, Bazzite, ChimeraOS, LibreELEC, and Batocera. + +### Linking a server + +Link Core to your server from the terminal UI under **Settings > Media servers**: + +- **Plex:** choose **Link Plex**, then open [plex.tv/link](https://plex.tv/link) and enter the code shown. If your account owns more than one server, set **Server address** to the one you want first. Servers shared with you by someone else can't be linked. +- **Jellyfin:** set **Server address**, such as `http://192.168.1.10:8096`, then choose **Link Jellyfin**. In a Jellyfin app signed in as your user, open **Quick Connect** and enter the code shown. Quick Connect must be turned on in the Jellyfin dashboard. + +Linking saves the server address in `config.toml` and the access token in `auth.toml`. Update the [media database](./scraping.md#updating-the-media-database) afterwards to index the library. + +### Choosing a player + +Set [`client`](../core/config/launchers.md#client) to the name of the player that should play your media: + +```toml +[[launchers.default]] +launcher = "Jellyfin" +client = "Living Room TV" +``` + +Use `launcher = "Plex"` for Plex. For Jellyfin, `client` matches the device name, app name, or device ID of a Jellyfin app that is open and signed in. For Plex, it matches the player's name as shown in Plex. If `client` isn't set and exactly one player is available, Core uses it. When a launch fails because the player can't be found, the error lists the players Core can see. + +Plex plays on players that accept remote control, such as Plex HTPC and Plexamp, and on Chromecast and Google TV devices on the same network. Recent Plex apps for Android TV, Apple TV, iOS, and Android no longer accept remote control from other apps, and Roku and Fire TV can't be reached. On a Google TV, Core reaches Plex through Cast. + +### Library media + +Both servers use the same system IDs as Kodi's library: + +| System ID | Jellyfin launcher | Plex launcher | Plays | +|-----------|-------------------|---------------|-------| +| `Movie` | `JellyfinMovie` | `PlexMovie` | The movie | +| `TVEpisode` | `JellyfinTVEpisode` | `PlexTVEpisode` | The episode | +| `TVShow` | `JellyfinTVShow` | `PlexTVShow` | Every episode from the first | +| `MusicTrack` | `JellyfinSong` | `PlexSong` | The song | +| `MusicAlbum` | `JellyfinAlbum` | `PlexAlbum` | Every track on the album | +| `MusicArtist` | `JellyfinArtist` | `PlexArtist` | Every song by the artist | + +Movie, show, and episode tokens also store the IMDb, TMDB, or TVDB IDs the server reports, so a token keeps working after the server rebuilds its library and assigns new item IDs. Kodi movie, episode, and show tokens do the same. + ## Launcher controls Launcher controls send actions to the launcher handling the currently active media. Use them for actions like pause, stop, save state, load state, fast forward, rewind, or next and previous track. @@ -90,6 +132,7 @@ Built-in launcher support currently includes: | Batocera EmulationStation launchers | `save_state`, `load_state`, `toggle_menu`, `toggle_pause`, `reset`, `fast_forward`, `rewind`, `next` (next disc), `stop`, as far as the running emulator supports them | | RePlayOS launchers | `save_state`, `load_state`, `reset`, `stop`. Needs [net control](../platforms/replayos.md#launcher-controls) turned on | | Kodi launchers: `KodiLocalVideo`, `KodiMovie`, `KodiTVEpisode`, `KodiLocalAudio`, `KodiAlbum`, `KodiArtist`, `KodiTVShow`, `KodiSong` | `toggle_pause`, `pause`, `resume`, `stop`, `fast_forward`, `rewind`, `next`, `previous` | +| Jellyfin and Plex launchers, see [media servers](#media-servers) | `toggle_pause`, `pause`, `resume`, `stop`, `fast_forward`, `rewind`, `next`, `previous` | | Built-in RetroArch launchers on Linux and SteamOS, including EmuDeck | `save_state`, `load_state`, `toggle_menu`, `toggle_pause`, `pause`, `resume`, `reset`, `fast_forward`, `rewind`, `stop`, plus `toggle_tray`, `next`, and `previous` for swapping discs in a loaded multi-disc game | | Native audio launcher (`Audio` system, see [Audio Playback](./audio.md)) | `toggle_pause`, `pause`, `resume`, `stop`, `fast_forward`, `rewind` | | Custom launchers | Whatever is defined in the launcher's `controls` table | diff --git a/docs/platforms/batocera/launchers.md b/docs/platforms/batocera/launchers.md index cdc0d72..6b51a8f 100644 --- a/docs/platforms/batocera/launchers.md +++ b/docs/platforms/batocera/launchers.md @@ -220,7 +220,7 @@ launcher = "Kodi" server_url = "http://localhost:8080" ``` -If Kodi requires authentication, add credentials to `auth.toml`: +Kodi 19 and later require a username and password for the web server. Set both in Kodi under **Settings > Services > Control**, then add them to `auth.toml` under the same URL and restart Core: ```toml ["http://localhost:8080"] diff --git a/docs/platforms/libreelec.md b/docs/platforms/libreelec.md index 2914c92..b3fd436 100644 --- a/docs/platforms/libreelec.md +++ b/docs/platforms/libreelec.md @@ -44,9 +44,19 @@ Enable Kodi remote control for Zaparoo to work: 2. Change view setting to at least "Standard" 3. Open the Control page 4. Enable "Allow remote control via HTTP" -5. Set a blank password +5. Set a username and password. Kodi 19 and later will not accept a blank password. 6. Enable "Allow remote control from applications on this system" +Then give Core the same username and password in `/storage/.config/zaparoo/auth.toml`, keyed by Kodi's address: + +```toml title="auth.toml" +["http://localhost:8080"] +username = "kodi" +password = "your_password" +``` + +Restart Core after editing `auth.toml`. If Core runs on a different machine from Kodi, also enable "Allow remote control from applications on other systems" and use Kodi's network address instead of `localhost`. + ### Adding to Startup Add to `/storage/.config/autostart.sh`: diff --git a/docs/platforms/linux/launchers.md b/docs/platforms/linux/launchers.md index db232d7..c0336a8 100644 --- a/docs/platforms/linux/launchers.md +++ b/docs/platforms/linux/launchers.md @@ -233,7 +233,7 @@ launcher = "Kodi" server_url = "http://localhost:8080" ``` -If Kodi requires authentication, add credentials to `auth.toml`: +Kodi 19 and later require a username and password for the web server. Set both in Kodi under **Settings > Services > Control**, then add them to `auth.toml` under the same URL and restart Core: ```toml ["http://localhost:8080"] diff --git a/docs/platforms/windows/launchers.md b/docs/platforms/windows/launchers.md index 1e71c23..70d60db 100644 --- a/docs/platforms/windows/launchers.md +++ b/docs/platforms/windows/launchers.md @@ -227,7 +227,7 @@ launcher = "Kodi" server_url = "http://192.168.1.100:8080" ``` -If Kodi requires authentication, add credentials to `auth.toml`: +Kodi 19 and later require a username and password for the web server. Set both in Kodi under **Settings > Services > Control**, then add them to `auth.toml` under the same URL and restart Core: ```toml title="auth.toml" ["http://192.168.1.100:8080"] diff --git a/versioned_docs/version-2.22.1/platforms/batocera/launchers.md b/versioned_docs/version-2.22.1/platforms/batocera/launchers.md index cdc0d72..6b51a8f 100644 --- a/versioned_docs/version-2.22.1/platforms/batocera/launchers.md +++ b/versioned_docs/version-2.22.1/platforms/batocera/launchers.md @@ -220,7 +220,7 @@ launcher = "Kodi" server_url = "http://localhost:8080" ``` -If Kodi requires authentication, add credentials to `auth.toml`: +Kodi 19 and later require a username and password for the web server. Set both in Kodi under **Settings > Services > Control**, then add them to `auth.toml` under the same URL and restart Core: ```toml ["http://localhost:8080"] diff --git a/versioned_docs/version-2.22.1/platforms/libreelec.md b/versioned_docs/version-2.22.1/platforms/libreelec.md index 2914c92..b3fd436 100644 --- a/versioned_docs/version-2.22.1/platforms/libreelec.md +++ b/versioned_docs/version-2.22.1/platforms/libreelec.md @@ -44,9 +44,19 @@ Enable Kodi remote control for Zaparoo to work: 2. Change view setting to at least "Standard" 3. Open the Control page 4. Enable "Allow remote control via HTTP" -5. Set a blank password +5. Set a username and password. Kodi 19 and later will not accept a blank password. 6. Enable "Allow remote control from applications on this system" +Then give Core the same username and password in `/storage/.config/zaparoo/auth.toml`, keyed by Kodi's address: + +```toml title="auth.toml" +["http://localhost:8080"] +username = "kodi" +password = "your_password" +``` + +Restart Core after editing `auth.toml`. If Core runs on a different machine from Kodi, also enable "Allow remote control from applications on other systems" and use Kodi's network address instead of `localhost`. + ### Adding to Startup Add to `/storage/.config/autostart.sh`: diff --git a/versioned_docs/version-2.22.1/platforms/linux/launchers.md b/versioned_docs/version-2.22.1/platforms/linux/launchers.md index db232d7..c0336a8 100644 --- a/versioned_docs/version-2.22.1/platforms/linux/launchers.md +++ b/versioned_docs/version-2.22.1/platforms/linux/launchers.md @@ -233,7 +233,7 @@ launcher = "Kodi" server_url = "http://localhost:8080" ``` -If Kodi requires authentication, add credentials to `auth.toml`: +Kodi 19 and later require a username and password for the web server. Set both in Kodi under **Settings > Services > Control**, then add them to `auth.toml` under the same URL and restart Core: ```toml ["http://localhost:8080"] diff --git a/versioned_docs/version-2.22.1/platforms/windows/launchers.md b/versioned_docs/version-2.22.1/platforms/windows/launchers.md index 1e71c23..70d60db 100644 --- a/versioned_docs/version-2.22.1/platforms/windows/launchers.md +++ b/versioned_docs/version-2.22.1/platforms/windows/launchers.md @@ -227,7 +227,7 @@ launcher = "Kodi" server_url = "http://192.168.1.100:8080" ``` -If Kodi requires authentication, add credentials to `auth.toml`: +Kodi 19 and later require a username and password for the web server. Set both in Kodi under **Settings > Services > Control**, then add them to `auth.toml` under the same URL and restart Core: ```toml title="auth.toml" ["http://192.168.1.100:8080"]