Skip to content

Commit

Permalink
fixup! devguide: regroup install deps
Browse files Browse the repository at this point in the history
  • Loading branch information
@tharvik
tharvik committed Oct 11, 2023
1 parent e6a8e2a commit a9bd316
Showing 1 changed file with 38 additions and 49 deletions.
87 changes: 38 additions & 49 deletions DEVGUIDE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,18 @@ Follow the steps below to install the app on your personal Roku device. This wil
- [Install VSCode](#install-vscode)
- [Usage](#usage)
- [Hardcoding Roku Information](#hardcoding-roku-information)
- [Method 2: Sideload to Roku Device Manually](#method-2-sideload-to-roku-device-manually)
- [Method 3: Direct load to Roku Device](#method-3-direct-load-to-roku-device)
- [Login Details](#login-details)
- [Deploy](#deploy)
- [Bug/Crash Reports](#bugcrash-reports)
- [Upgrade](#upgrade)
- [Command Line Workflow](#command-line-workflow)
- [Method 2: Command Line](#method-2-command-line)
- [Workflow](#method-2-workflow)
- [Install Dependencies](#method-2-install-dependencies)
- [Deploy](#method-2-deploy)
- [Bug/Crash Reports](#method-2-bugcrash-reports)
- [Committing](#committing)
- [(Optional) Update Images](#optional-update-images)
- [Adding a User Setting](#adding-a-user-setting)
- [The order of any particular menu is as follows](#the-order-of-any-particular-menu-is-as-follows)
- [When giving your setting a name](#when-giving-your-setting-a-name)
- [When giving your setting a description](#when-giving-your-setting-a-description)
- [**Remember to add all new strings to locale/en\_US/translations.ts**](#remember-to-add-all-new-strings-to-localeen_ustranslationsts)
- [**Remember to add all new strings to locale/en_US/translations.ts**](#remember-to-add-all-new-strings-to-localeen_ustranslationsts)

## Developer Mode

Expand All @@ -45,12 +43,12 @@ cd jellyfin-roku

## Install Dependencies

You'll need [`npm`](https://github.com/npm/cli), [`make`](https://www.gnu.org/software/make) and [`curl`](https://curl.se).
You'll need [`npm`](https://nodejs.org), the default package manager for NodeJS.

For Debian or Ubuntu, install it via:

```bash
sudo apt-get install npm make curl
sudo apt-get install npm
```

Then, use `npm` to install more dependencies
Expand Down Expand Up @@ -83,27 +81,42 @@ Out of the box, the BrightScript extension will prompt you to pick a Roku device

```json
{
"brightscript.debug.host": "YOUR_ROKU_HOST_HERE",
"brightscript.debug.password": "YOUR_ROKU_DEV_PASSWORD_HERE",
"brightscript.debug.host": "YOUR_ROKU_HOST_HERE",
"brightscript.debug.password": "YOUR_ROKU_DEV_PASSWORD_HERE"
}
```

Example:
![image](https://user-images.githubusercontent.com/2544493/170485209-0dbe6787-8026-47e7-9095-1df96cda8a0a.png)

## Method 2: Sideload to Roku Device Manually
## Method 2: Command Line

### Workflow

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

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.

### Install Dependencies

You'll need [`make`](https://www.gnu.org/software/make) and [`curl`](https://curl.se).

For Debian or Ubuntu, install it via:

```bash
sudo apt-get install make curl
```

Build the package

```bash
make build-dev
```

This will create a zip in `out/jellyfin-roku.zip`. Login to your Roku's device in your browser and upload the zip file then run install.

## Method 3: Direct load to Roku Device
This will create a zip in `out/jellyfin-roku.zip`, that you can upload on your Roku's device via your browser.
Or you can continue with the next steps to do it via the command line.

### Login Details
### Deploy

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

Expand All @@ -112,19 +125,15 @@ 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:

```bash
make build-dev install
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
### Bug/Crash Reports

Did the app crash? Find a nasty bug? Use this command to view the error log and [report it to the developers](https://github.com/jellyfin/jellyfin-roku/issues):

Expand All @@ -134,45 +143,25 @@ telnet ${ROKU_DEV_TARGET} 8085

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

If you setup `ROKU_DEV_TARGET` as in [Method 3](#method-3-direct-load-to-roku-device), you can also take a screenshot of the app
You can also take a screenshot of the app to augment the bug report.

```bash
make screenshot
```

## Upgrade

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

```bash
git pull
```

Deploy the app:

```bash
make build-dev install
```

## Command Line Workflow

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

Unfortunately there is no debugger. 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.

## Committing

Before committing your code, please run:

```bash
make format lint
npm run lint
```

This will format your code and run the CI checks locally to ensure you will pass the CI tests.
And fix any encountered issue.

## (Optional) Update Images

This repo already contains all necessary images for the app. This script only needs to be run when the [official Jellyfin images](https://github.com/jellyfin/jellyfin-ux) are changed to allow us to update the repo images.
This repo already contains all necessary images for the app. This script only needs to be run when the [official Jellyfin images](https://github.com/jellyfin/jellyfin-ux) are changed to allow us to update the repo images. It only works using the [Command Line Method](method-2-command-line).

You'll need `convert`, from [ImageMagick](https://imagemagick.org)

Expand All @@ -190,7 +179,7 @@ make get_images

## Adding a User Setting

Your new functionality may need a setting to configure its behavior, or, sometimes, we may ask you to add a setting for your new functionality, so that users may enable or disable it. If you find yourself in this position, please observe the following considerations when adding your new user setting.
Your new functionality may need a setting to configure its behavior, or, sometimes, we may ask you to add a setting for your new functionality, so that users may enable or disable it. If you find yourself in this position, please observe the following considerations when adding your new user setting.

### The order of any particular menu is as follows

Expand All @@ -200,7 +189,7 @@ Your new functionality may need a setting to configure its behavior, or, sometim

### When giving your setting a name

Ideally, your setting will be named with a relevant noun such as ```Cinema Mode``` or ```Codec Support.``` Sometimes there is no such name that is sufficiently specific, such as with ```Clock```. In this case you must use a verb phrase to name your setting, such as ```Hide Clock.``` If your verb phrase _must_ be long to be specific, you may drop implied verbs if absolutely necessary, such as how ```Text Subtitles Only``` drops the implied ```Show.``` Do not use the infinitive form ```action-doing``` or ```doing stuff.``` Instead, use the imperative: ```Do Action``` or ```Do Stuff.``` Remember that _characters are a commodity in names._
Ideally, your setting will be named with a relevant noun such as `Cinema Mode` or `Codec Support.` Sometimes there is no such name that is sufficiently specific, such as with `Clock`. In this case you must use a verb phrase to name your setting, such as `Hide Clock.` If your verb phrase _must_ be long to be specific, you may drop implied verbs if absolutely necessary, such as how `Text Subtitles Only` drops the implied `Show.` Do not use the infinitive form `action-doing` or `doing stuff.` Instead, use the imperative: `Do Action` or `Do Stuff.` Remember that _characters are a commodity in names._

Generally, we should not repeat the name of a setting's parent in the setting's name. Being a child of that parent implies that the settings are related to it.

Expand Down

0 comments on commit a9bd316

Please sign in to comment.