jf-roku/README.md
2019-10-04 00:34:57 -04:00

1.9 KiB

Jellyfin app for Roku

This app is not complete!

Currently, the data stored on your Roku device are server name, server port, user id, and some user preferences like movie sort order.

The format that is used to save those settings could change at any time and your data could be lost and you'd have to re-enter it.

Getting Started

Follow the steps below or checkout the Development Guide For New Devs

Developer Mode

Put your Roku device in developer mode

Clone the GitHub Repo

Copy all of the application files to a new folder and then change directories:

https://github.com/jellyfin/jellyfin-roku.git
cd jellyfin-roku

Login Details

Run the commands below - Replacing the IP and password (using the info from the first step)

export ROKU_DEV_TARGET=192.168.1.234
export ROKU_DEV_PASSWORD=aaaa

This will allow you to test your code without having to manually upload a .zip file every time

Download Images

Install these packages:

sudo apt-get install imagemagick wget make nodejs npm

Then run this script to download the images from the jellyfin-ux repo:

sh make_images.sh

Deploy

This packages up the application, sends it to your Roku, and launches the channel:

make install

Testing

Testing is done with the Rooibos library.

This works by including the tests in the deployment and then looking at telnet for the test results. To use the testing library you need to install rooibos-cli:

Run this in the root app directory:

npm install -g rooibos-cli

To deploy the application with tests:

make test

To see test results and crash reports:

telnet ${ROKU_DEV_TARGET} 8085

To exit telnet: CTRL + ] and then type quit + ENTER