An open API service indexing awesome lists of open source software.

https://github.com/cewert/jellyrock

A Jellyfin client for Roku devices
https://github.com/cewert/jellyrock

brighterscript brightscript jellyfin jellyfin-client jellyrock roku

Last synced: 15 days ago
JSON representation

A Jellyfin client for Roku devices

Awesome Lists containing this project

README

          

[![JellyRock](resources/branding/release/channel-poster_sd.png "Download JellyRock ")](https://channelstore.roku.com/details/232f9e82db11ce628e3fe7e01382a330:a85d6e9e520567806e8dae1c0cabadd5/jellyrock)

[![Current Release](https://img.shields.io/github/release/cewert/jellyrock.svg?logo=github "Current Release")](https://github.com/cewert/jellyrock/releases)
[![Build Status](https://img.shields.io/github/actions/workflow/status/cewert/jellyrock/build.yml?logo=github&branch=main "Build Status")](https://github.com/cewert/jellyrock/actions/workflows/build.yml?query=branch%3Amain)
[![Code Documentation](https://img.shields.io/badge/Code%20Documentation-purple)](https://cewert.github.io/jellyrock-code-docs/)
[![License](https://img.shields.io/github/license/cewert/jellyrock.svg "GPL 2.0 License")](LICENSE)

JellyRock is a Jellyfin client for Roku devices with a focus on stability and UX. Originally forked from jellyfin-roku [v2.2.5](https://github.com/jellyfin-archive/jellyfin-roku-legacy/releases/tag/v2.2.5).

## Changelog

All notable changes to this project are documented in [CHANGELOG.md](CHANGELOG.md).

## Install

JellyRock requires **Roku OS 11** or later.

### Using your Roku device

- Navigate to Home -> Search -> "JellyRock".

### Using your browser

- Visit the [Roku Channel Store](https://channelstore.roku.com/details/232f9e82db11ce628e3fe7e01382a330:a85d6e9e520567806e8dae1c0cabadd5/jellyrock) -> Add app -> Login. This will install JellyRock on **all** devices linked to your Roku account.

## Screenshots


User Select


Home


Library grid


On-Screen Display(OSD)


Trickplay

## Sideload / Beta Test

To run the latest version of JellyRock before it hits the Roku Channel Store:

1. Put your Roku device in [Developer Mode](docs/dev/developer-mode.md). Save your password!
2. Download the latest [build](https://github.com/cewert/jellyrock/actions/workflows/build.yml?query=branch%3Amain) created by GitHub Actions. Select the first item listed then click one of the links at the bottom of the page i.e. `JellyRock-prod-main-e34f4f169ff47531abd23ae3a11c102f6811f907`. This will download a zip file to your computer.
3. Put your Roku's IP from step 1 into a browser i.e. `http://192.168.1.2` and press enter.
4. Log in with credentials from step 1.
5. Upload and install the zip file downloaded in step 2.

> NOTE: The app will always be at the bottom of your Roku's channel list and it will *not* automatically update.

## Build

```bash
git clone https://github.com/cewert/jellyrock.git
cd jellyrock
npm install
# Note: If npm scripts are disabled, manually run `npm run ropm` to install dependencies
npm run build # OR npm run build:prod
```

## User Docs

- [App Settings](docs/user/app-settings.md)

## Dev Docs

- [Developer Mode](docs/dev/developer-mode.md)
- [Dev Guide](docs/dev/DEVGUIDE.md)
- [Logging](docs/dev/logging.md)
- [New User Setting](docs/dev/new-user-setting.md)
- [Registry Migrations](docs/dev/registry-migrations.md)
- [TDD Workflow](docs/dev/unit-tests-tdd.md)
- [Unit Tests](docs/dev/unit-tests.md)