From fce09e83eeb973445ed44c88456b77c921fef6ef Mon Sep 17 00:00:00 2001 From: Charles Ewert Date: Tue, 28 Mar 2023 23:59:40 -0400 Subject: [PATCH 01/12] Add build badge + rework readme --- DEVGUIDE.md | 2 +- README.md | 63 ++++++++++++++++++++++++++++------------------------- 2 files changed, 34 insertions(+), 31 deletions(-) diff --git a/DEVGUIDE.md b/DEVGUIDE.md index 4c7765ef..7531540a 100644 --- a/DEVGUIDE.md +++ b/DEVGUIDE.md @@ -27,7 +27,7 @@ Follow the steps below to install the app on your personal Roku device. This wil ## Developer Mode -Put your Roku device in [developer mode](https://blog.roku.com/developer/2016/02/04/developer-setup-guide). Write down your Roku device IP and the password you created, you will need these later. +Put your Roku device in [developer mode](https://blog.roku.com/developer/2016/02/04/developer-setup-guide). Write down your Roku device IP and the password you created - you will need these! ## Clone the GitHub Repo diff --git a/README.md b/README.md index f76a509b..41ea0902 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,42 @@ -

Jellyfin app for Roku

-

Part of the Jellyfin Project

-

-Logo banner -

- -GPL 2.0 License - - -Current Release - - -Translation status - -
- -Chat on Matrix - - -Join our Subreddit - -

+

Jellyfin Roku

+

Part of the Jellyfin Project

-The Jellyfin Roku App is a Jellyfin client for Roku Devices. This is still very much a work in progress, so we would encourage you to [get involved](#get_involved) if you can. +[![Logo Banner](https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true)](https://jellyfin.media) -## Getting Started +[![Build Status](https://img.shields.io/github/actions/workflow/status/jellyfin/jellyfin-roku/build-dev.yml?logo=github&branch=unstable)](https://github.com/jellyfin/jellyfin-roku/actions/workflows/build-dev.yml?query=branch%3Aunstable) +[![Current Release](https://img.shields.io/github/release/jellyfin/jellyfin-roku.svg)](https://github.com/jellyfin/jellyfin-roku/releases) +[![Translation Status](https://translate.jellyfin.org/widgets/jellyfin/-/jellyfin-roku/svg-badge.svg)](https://translate.jellyfin.org/projects/jellyfin/jellyfin-roku/?utm_source=widget) +[![Matrix](https://img.shields.io/matrix/jellyfin:matrix.org.svg?logo=matrix)](https://matrix.to/#/#jellyfin-dev-roku:matrix.org) +[![Reddit](https://img.shields.io/badge/reddit-r%2Fjellyfin-%23FF5700.svg "Join our Subreddit")](https://www.reddit.com/r/jellyfin) +[![License](https://img.shields.io/github/license/jellyfin/jellyfin-roku.svg)](LICENSE) -The channel is available on the [Roku Channel Store](https://channelstore.roku.com/details/cc5e559d08d9ec87c5f30dcebdeebc12/jellyfin). +The Jellyfin Roku App is a Jellyfin client for Roku Devices and is still very much a work in progress. Please get involved if you can! -## Getting Involved +## Install -No matter what your interests or skill are, you can help to make this client better for everyone by simply using the client and letting us know if you find a problem with it. Either give us a shout on [matrix](https://matrix.to/#/+jellyfin:matrix.org) or create a GitHub issue. +Download the latest release on the [Roku Channel Store](https://channelstore.roku.com/details/cc5e559d08d9ec87c5f30dcebdeebc12/jellyfin). -Feature requests are always welcome too, but please have a read though the existing issues to see if someone has already raised one for something similar. +## Get Involved -If you fancy some development, then read the [DEVGUIDE](DEVGUIDE.md) to find out the best ways to help. +No matter what your interests or skills are you can help make this client better for everyone by simply using the client and giving feedback to the developers when things break. [Create an issue](https://github.com/jellyfin/jellyfin-roku/issues/new/choose) here on GitHub or give us a shout on [matrix](https://matrix.to/#/#jellyfin-dev-roku:matrix.org). -As Roku have severely limited their Beta channel program, the best way to test pre-release versions is by following the [DEVGUIDE](DEVGUIDE.md) to install and test the latest changes. Feedback is always welcome. +## Feature Requests + +New feature requests are always welcome but before creating an issue please read though the [existing issues](https://github.com/jellyfin/jellyfin-roku/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to see if someone has already raised one for what you're looking for. + +## Beta Test + +To test the latest features before they get released: + +1. Put your Roku device in [developer mode](https://blog.roku.com/developer/2016/02/04/developer-setup-guide). Write down your Roku device IP and the password you created - you will need these! +2. Download the [latest build](https://github.com/jellyfin/jellyfin-roku/actions/workflows/build-dev.yml?query=branch%3Aunstable) from the unstable branch +3. Access your roku device by putting your Roku's IP from step 1 into a browser i.e. `http://192.168.1.2` +4. Log in with credentials from step 1 +5. Upload and install the zip file downloaded in step 2 + +> NOTE: The beta app will always be at the bottom of your Roku's channel list and it will *not* automatically update. + +## Advanced + +For more advanced deployment methods, access to crashlogs, or to learn how to setup a developer environment to write some code yourself please see the [DEVGUIDE](DEVGUIDE.md) From f5947f94908229722660a9c43de7eaf5196d0209 Mon Sep 17 00:00:00 2001 From: Charles Ewert Date: Wed, 29 Mar 2023 00:02:04 -0400 Subject: [PATCH 02/12] small fixes --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 41ea0902..ee2b23ec 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -

Jellyfin Roku

Part of the Jellyfin Project

@@ -39,4 +38,4 @@ To test the latest features before they get released: ## Advanced -For more advanced deployment methods, access to crashlogs, or to learn how to setup a developer environment to write some code yourself please see the [DEVGUIDE](DEVGUIDE.md) +For more advanced deployment methods, access to crash logs, or to learn how to setup a developer environment to write some code yourself please see the [DEVGUIDE](DEVGUIDE.md) From 96c331e3ef8d3dadcf369656f50795e11d7e7fe0 Mon Sep 17 00:00:00 2001 From: Charles Ewert Date: Wed, 29 Mar 2023 00:14:05 -0400 Subject: [PATCH 03/12] Make linter happy --- README.md | 10 +++++----- dictionary.txt | 1 + 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ee2b23ec..a4ce367f 100644 --- a/README.md +++ b/README.md @@ -29,13 +29,13 @@ New feature requests are always welcome but before creating an issue please read To test the latest features before they get released: 1. Put your Roku device in [developer mode](https://blog.roku.com/developer/2016/02/04/developer-setup-guide). Write down your Roku device IP and the password you created - you will need these! -2. Download the [latest build](https://github.com/jellyfin/jellyfin-roku/actions/workflows/build-dev.yml?query=branch%3Aunstable) from the unstable branch -3. Access your roku device by putting your Roku's IP from step 1 into a browser i.e. `http://192.168.1.2` -4. Log in with credentials from step 1 -5. Upload and install the zip file downloaded in step 2 +2. Download the [latest build](https://github.com/jellyfin/jellyfin-roku/actions/workflows/build-dev.yml?query=branch%3Aunstable) from the unstable branch. +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 beta app will always be at the bottom of your Roku's channel list and it will *not* automatically update. ## Advanced -For more advanced deployment methods, access to crash logs, or to learn how to setup a developer environment to write some code yourself please see the [DEVGUIDE](DEVGUIDE.md) +For more advanced deployment methods, access to crash logs, or to learn how to setup a developer environment to write some code yourself please see the [DEVGUIDE](DEVGUIDE.md). diff --git a/dictionary.txt b/dictionary.txt index 0b338857..8efe014b 100644 --- a/dictionary.txt +++ b/dictionary.txt @@ -3,6 +3,7 @@ VSCode BrightScript sideload Sideload +Reddit DEVGUIDE ing hardcode From 4f0407d9638b82b4a9754d0ea0eb4c1dd9321f5d Mon Sep 17 00:00:00 2001 From: Charles Ewert Date: Wed, 29 Mar 2023 08:46:05 -0400 Subject: [PATCH 04/12] Add back alt text to badge images --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a4ce367f..ec3ba43f 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@

Jellyfin Roku

Part of the Jellyfin Project

-[![Logo Banner](https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true)](https://jellyfin.media) +[![Logo Banner](https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true "Jellyfin")](https://jellyfin.media) -[![Build Status](https://img.shields.io/github/actions/workflow/status/jellyfin/jellyfin-roku/build-dev.yml?logo=github&branch=unstable)](https://github.com/jellyfin/jellyfin-roku/actions/workflows/build-dev.yml?query=branch%3Aunstable) -[![Current Release](https://img.shields.io/github/release/jellyfin/jellyfin-roku.svg)](https://github.com/jellyfin/jellyfin-roku/releases) -[![Translation Status](https://translate.jellyfin.org/widgets/jellyfin/-/jellyfin-roku/svg-badge.svg)](https://translate.jellyfin.org/projects/jellyfin/jellyfin-roku/?utm_source=widget) -[![Matrix](https://img.shields.io/matrix/jellyfin:matrix.org.svg?logo=matrix)](https://matrix.to/#/#jellyfin-dev-roku:matrix.org) +[![Build Status](https://img.shields.io/github/actions/workflow/status/jellyfin/jellyfin-roku/build-dev.yml?logo=github&branch=unstable "Build Status")](https://github.com/jellyfin/jellyfin-roku/actions/workflows/build-dev.yml?query=branch%3Aunstable) +[![Current Release](https://img.shields.io/github/release/jellyfin/jellyfin-roku.svg "Current Release")](https://github.com/jellyfin/jellyfin-roku/releases) +[![Translation Status](https://translate.jellyfin.org/widgets/jellyfin/-/jellyfin-roku/svg-badge.svg "Translation Status")](https://translate.jellyfin.org/projects/jellyfin/jellyfin-roku/?utm_source=widget) +[![Matrix](https://img.shields.io/matrix/jellyfin:matrix.org.svg?logo=matrix "Chat on Matrix")](https://matrix.to/#/#jellyfin-dev-roku:matrix.org) [![Reddit](https://img.shields.io/badge/reddit-r%2Fjellyfin-%23FF5700.svg "Join our Subreddit")](https://www.reddit.com/r/jellyfin) -[![License](https://img.shields.io/github/license/jellyfin/jellyfin-roku.svg)](LICENSE) +[![License](https://img.shields.io/github/license/jellyfin/jellyfin-roku.svg "GPL 2.0 License")](LICENSE) The Jellyfin Roku App is a Jellyfin client for Roku Devices and is still very much a work in progress. Please get involved if you can! @@ -20,10 +20,6 @@ Download the latest release on the [Roku Channel Store](https://channelstore.rok No matter what your interests or skills are you can help make this client better for everyone by simply using the client and giving feedback to the developers when things break. [Create an issue](https://github.com/jellyfin/jellyfin-roku/issues/new/choose) here on GitHub or give us a shout on [matrix](https://matrix.to/#/#jellyfin-dev-roku:matrix.org). -## Feature Requests - -New feature requests are always welcome but before creating an issue please read though the [existing issues](https://github.com/jellyfin/jellyfin-roku/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to see if someone has already raised one for what you're looking for. - ## Beta Test To test the latest features before they get released: @@ -39,3 +35,7 @@ To test the latest features before they get released: ## Advanced For more advanced deployment methods, access to crash logs, or to learn how to setup a developer environment to write some code yourself please see the [DEVGUIDE](DEVGUIDE.md). + +## Feature Requests + +New feature requests are always welcome but before creating an issue please read though the [existing issues](https://github.com/jellyfin/jellyfin-roku/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to see if someone has already raised one for what you're looking for. From 1d27541920e94f479d671d24f8251c93656552f6 Mon Sep 17 00:00:00 2001 From: Charles Ewert Date: Wed, 29 Mar 2023 08:51:33 -0400 Subject: [PATCH 05/12] Update badge icons --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ec3ba43f..e88f019c 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ [![Logo Banner](https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true "Jellyfin")](https://jellyfin.media) [![Build Status](https://img.shields.io/github/actions/workflow/status/jellyfin/jellyfin-roku/build-dev.yml?logo=github&branch=unstable "Build Status")](https://github.com/jellyfin/jellyfin-roku/actions/workflows/build-dev.yml?query=branch%3Aunstable) -[![Current Release](https://img.shields.io/github/release/jellyfin/jellyfin-roku.svg "Current Release")](https://github.com/jellyfin/jellyfin-roku/releases) +[![Current Release](https://img.shields.io/github/release/jellyfin/jellyfin-roku.svg?logo=github "Current Release")](https://github.com/jellyfin/jellyfin-roku/releases) [![Translation Status](https://translate.jellyfin.org/widgets/jellyfin/-/jellyfin-roku/svg-badge.svg "Translation Status")](https://translate.jellyfin.org/projects/jellyfin/jellyfin-roku/?utm_source=widget) [![Matrix](https://img.shields.io/matrix/jellyfin:matrix.org.svg?logo=matrix "Chat on Matrix")](https://matrix.to/#/#jellyfin-dev-roku:matrix.org) -[![Reddit](https://img.shields.io/badge/reddit-r%2Fjellyfin-%23FF5700.svg "Join our Subreddit")](https://www.reddit.com/r/jellyfin) +[![Reddit](https://img.shields.io/badge/reddit-r%2Fjellyfin-%23FF5700.svg?logo=reddit "Join our Subreddit")](https://www.reddit.com/r/jellyfin) [![License](https://img.shields.io/github/license/jellyfin/jellyfin-roku.svg "GPL 2.0 License")](LICENSE) The Jellyfin Roku App is a Jellyfin client for Roku Devices and is still very much a work in progress. Please get involved if you can! From f2d1efed222e9a6fe4c4e3f31bbada9efb993046 Mon Sep 17 00:00:00 2001 From: Charles Ewert Date: Wed, 29 Mar 2023 09:00:57 -0400 Subject: [PATCH 06/12] Clarify how to download latest release --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e88f019c..e62e60e7 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ No matter what your interests or skills are you can help make this client better To test the latest features before they get released: 1. Put your Roku device in [developer mode](https://blog.roku.com/developer/2016/02/04/developer-setup-guide). Write down your Roku device IP and the password you created - you will need these! -2. Download the [latest build](https://github.com/jellyfin/jellyfin-roku/actions/workflows/build-dev.yml?query=branch%3Aunstable) from the unstable branch. +2. Download the [latest build](https://github.com/jellyfin/jellyfin-roku/actions/workflows/build-dev.yml?query=branch%3Aunstable). Select the first item listed then click the link at the bottom of the page i.e. `Jellyfin-Roku-dev-d3352495c579f6adeca085cdbc137ac36e70d558`. 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. @@ -34,7 +34,7 @@ To test the latest features before they get released: ## Advanced -For more advanced deployment methods, access to crash logs, or to learn how to setup a developer environment to write some code yourself please see the [DEVGUIDE](DEVGUIDE.md). +For more advanced deployment methods, access to crash logs, or to learn how to setup a developer environment so you can write some code yourself please read the [DEVGUIDE](DEVGUIDE.md). ## Feature Requests From f475be619e628ba0887e6edf0352299fbf778fa1 Mon Sep 17 00:00:00 2001 From: Charles Ewert Date: Wed, 29 Mar 2023 13:16:38 -0400 Subject: [PATCH 07/12] fix syntax formatting --- DEVGUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEVGUIDE.md b/DEVGUIDE.md index 7531540a..62087919 100644 --- a/DEVGUIDE.md +++ b/DEVGUIDE.md @@ -71,7 +71,7 @@ That's it! VSCode will auto-package the project, sideload it to the specified de Out of the box, the BrightScript extension will prompt you to pick a Roku device (from devices found on your local network) and enter a password on every launch. If you'd prefer to hardcode this information rather than entering it every time, you can set these values in your VSCode user settings: -```js +```json { "brightscript.debug.host": "YOUR_ROKU_HOST_HERE", "brightscript.debug.password": "YOUR_ROKU_DEV_PASSWORD_HERE", From d40c8752aad7cf74d4b940446f156b114804ed80 Mon Sep 17 00:00:00 2001 From: Charles Ewert Date: Wed, 29 Mar 2023 18:46:01 -0400 Subject: [PATCH 08/12] Center jellyfin branding --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e62e60e7..e5ade5eb 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -

Jellyfin Roku

-

Part of the Jellyfin Project

+

Jellyfin Roku

+

Part of the Jellyfin Project

[![Logo Banner](https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true "Jellyfin")](https://jellyfin.media) From 75534c6c9043894429a02b450ef791ea8a397389 Mon Sep 17 00:00:00 2001 From: Charles Ewert Date: Sat, 8 Apr 2023 20:00:56 -0400 Subject: [PATCH 09/12] Fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e5ade5eb..bfcae75e 100644 --- a/README.md +++ b/README.md @@ -38,4 +38,4 @@ For more advanced deployment methods, access to crash logs, or to learn how to s ## Feature Requests -New feature requests are always welcome but before creating an issue please read though the [existing issues](https://github.com/jellyfin/jellyfin-roku/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to see if someone has already raised one for what you're looking for. +New feature requests are always welcome but before creating an issue please read through the [existing issues](https://github.com/jellyfin/jellyfin-roku/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to see if someone has already raised one for what you're looking for. From aa183802fb677904d461324d6ebc8332a04348a7 Mon Sep 17 00:00:00 2001 From: Charles Ewert Date: Sat, 8 Apr 2023 20:21:42 -0400 Subject: [PATCH 10/12] remove "work in progress" warning --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e5ade5eb..11eede07 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ [![Reddit](https://img.shields.io/badge/reddit-r%2Fjellyfin-%23FF5700.svg?logo=reddit "Join our Subreddit")](https://www.reddit.com/r/jellyfin) [![License](https://img.shields.io/github/license/jellyfin/jellyfin-roku.svg "GPL 2.0 License")](LICENSE) -The Jellyfin Roku App is a Jellyfin client for Roku Devices and is still very much a work in progress. Please get involved if you can! +Jellyfin Roku is the official Jellyfin client for Roku. Please get involved if you can! ## Install From cce0001075a367ac461d6a676038d18b4fa098e9 Mon Sep 17 00:00:00 2001 From: Charles Ewert Date: Sun, 9 Apr 2023 12:21:27 -0400 Subject: [PATCH 11/12] Update intro text --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 762718e4..9b001451 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ [![Reddit](https://img.shields.io/badge/reddit-r%2Fjellyfin-%23FF5700.svg?logo=reddit "Join our Subreddit")](https://www.reddit.com/r/jellyfin) [![License](https://img.shields.io/github/license/jellyfin/jellyfin-roku.svg "GPL 2.0 License")](LICENSE) -Jellyfin Roku is the official Jellyfin client for Roku. Please get involved if you can! +Jellyfin Roku is the official Jellyfin client for Roku devices. We welcome all contributions and pull requests! If you have a larger feature in mind please open an issue so we can discuss the implementation before you start. ## Install From 5174ad5816022c1f9582921fa592fc7c54a1cd0a Mon Sep 17 00:00:00 2001 From: Charles Ewert Date: Sun, 9 Apr 2023 12:58:50 -0400 Subject: [PATCH 12/12] Add feature request link to intro text --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b001451..5e42178b 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ [![Reddit](https://img.shields.io/badge/reddit-r%2Fjellyfin-%23FF5700.svg?logo=reddit "Join our Subreddit")](https://www.reddit.com/r/jellyfin) [![License](https://img.shields.io/github/license/jellyfin/jellyfin-roku.svg "GPL 2.0 License")](LICENSE) -Jellyfin Roku is the official Jellyfin client for Roku devices. We welcome all contributions and pull requests! If you have a larger feature in mind please open an issue so we can discuss the implementation before you start. +Jellyfin Roku is the official Jellyfin client for Roku devices. We welcome all contributions and pull requests! If you have a larger feature in mind please [open an issue](https://github.com/jellyfin/jellyfin-roku/issues/new?assignees=&labels=feature&template=feature_request.md&title=) so we can discuss the implementation before you start. ## Install