Go to file

Neil Burrows 60df11d51c Move content into Roku Safe Zones		2020-06-25 11:37:18 +01:00
.github	Adding github stuff and images	2019-04-28 15:49:11 -04:00
components	Move content into Roku Safe Zones	2020-06-25 11:37:18 +01:00
images	Updated design and functionality of ItemGrid for Movies	2020-06-10 17:43:32 +01:00
locale	Translated using Weblate (German)	2020-06-22 05:29:37 -04:00
source	Merge pull request #213 from neilsb/collections	2020-06-17 22:17:21 -04:00
tests	Changes	2019-07-07 17:50:19 -04:00
.gitignore	Add .vscode and logs to git ignore	2020-03-18 09:17:16 +00:00
app.mk	Fix 'ends at ' and remove SPDX license headers	2020-05-08 21:26:45 -04:00
DEVGUIDE.md	npm init and modify app.mk to use local packages instead of global.	2019-09-08 22:02:09 -05:00
LICENSE	Generate some images	2019-01-29 23:10:51 -06:00
Makefile	Removed image script from deploy scripts	2019-10-07 15:02:04 -05:00
manifest	Correct screensaver entry in manifest	2020-05-13 12:21:30 -04:00
package-lock.json	npm init and modify app.mk to use local packages instead of global.	2019-09-08 22:02:09 -05:00
package.json	Change license to GPLv2	2020-02-24 12:45:21 -05:00
README.md	Adds Link To Jellyfin BETA App	2020-04-29 22:05:34 -05:00

README.md

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

You can install the Jellyfin BETA Roku App by clicking here

Developing The Jellyfin Roku App

Follow the steps below to install the app on your personal Roku device for development.

Developer Mode

Put your Roku device in developer mode. Write down your Roku device IP and the password you created, you will need these later.

Clone the GitHub Repo

Navigate to where you'd like to install the app then copy the application files:

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

Open up the new folder:

cd jellyfin-roku

Install Necessary Packages

sudo apt-get install wget make

Run this command - replacing the IP and password with your Roku device IP and dev password from the first step:

export ROKU_DEV_TARGET=192.168.1.234
export ROKU_DEV_PASSWORD=password

Normally you would have to open up your browser and upload a .zip file containing the app code. These commands enable the app to be zipped up and installed on the Roku automatically which is essential for developers and makes it easy to upgrade in the future for users.

Deploy

Package up the application, send it to your Roku, and launch the channel:

make install

Note: You only have to run this command once if you are not a developer. The Jellyfin channel will still be installed after rebooting your Roku device.

Bug/Crash Reports

Did the app crash? Find a nasty bug? Use the this command to view the error log and report it to the developers:

telnet ${ROKU_DEV_TARGET} 8085

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

Upgrade

Navigate to the folder where you installed the app then upgrade the code to the latest version:

git pull

Deploy the app:

make install

Developer Setup

Read below and also checkout the Development Guide For New Devs

Workflow

Modify code -> make install -> Use Roku remote to test changes -> telnet ${ROKU_DEV_TARGET} 8085 -> CTRL + ] -> quit + ENTER

Unfortunately there is no debuger. You will need to use telnet to see log statements, warnings, and error reports. You won't always need to telnet into your device but the workflow above is typical when you are new to Brightscript or are working on tricky code.

Testing

Testing is done with the Rooibos library. This works by including tests in the deployment and then looking at telnet for the test results.

Install necessary packages:

sudo apt-get install nodejs npm

Install rooibos-cli:

npm install -g rooibos-cli

Deploy the application with tests:

make test

View test results:

telnet ${ROKU_DEV_TARGET} 8085