Skip to content
Silo-ServerPublic

About

Native Roku client for the Silo self-hosted media server.

Topics

Resources

Contributing

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

244 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Silo Roku

Native Roku client for the Silo self-hosted media server: sign in, browse your movies and shows, and play them with server-planned direct play, remux, or transcode.

Status: Pre-release; not yet submitted to Roku. The app signs in to a Silo server, browses, searches, and plays movies and TV through playback protocol v3. Every build runs companion sign-in and, since decision D-7 in implementation-assumptions.md, the SiloControl receiver. Hardware testing so far used a Roku TV and a Roku Ultra, nearly all of it in development builds; release-checklist.md lists what still blocks a beta.

Table of contents

What's inside

Platform Roku OS, FHD (1920×1080) layout scaled for HD models
Language / UI BrightScript and BrighterScript · Roku SceneGraph
Playback Roku Video node driven by Silo playback protocol v3 over /api/v2
Tests Rooibos specs, run headless under brs-node
Tooling Node.js 22 · bsc and bslint · Roku Static Analysis
Platform floor rsg_version=1.3, minimum firmware 15.1.0 (set on the Developer Dashboard)

The server owns the library, metadata, playback decisions, and auth. The client renders what the server returns and plays the plan it chooses.

Install

The app is not in the Roku Channel Store yet. Each tester build on the Releases page includes a zip you can sideload onto a Roku in Developer Mode from a web browser: docs/sideloading.md walks through it. To build it yourself, see Build and sideload.

Features

The first public release covers what a viewer needs to find something and watch it. docs/spec.md section 3 has the full scope.

  • Setup and accounts: several saved Silo servers, sign-in with a QR code or an activation code, password sign-in, companion sign-in from a Silo phone app on the network, and the profile picker with PINs and child profiles.
  • Browse: Home from the server's sections (including Continue Watching and Next Up), Movies and Series library tabs with Recommended rows and a Browse grid with sort, filters, and an alphabet rail, read-only Collections, For You, Calendar, Requests, Search, movie and series detail pages, and person pages.
  • Playback: direct play, remux, or transcode as the server plans it, with audio and subtitle selection, resume, and Up Next.
  • Roku integration: deep links for movies, episodes, series, and seasons, and the SiloControl receiver, so a Silo phone app can act as a remote and hand playback off to the TV.
  • Diagnostics: Settings > Diagnostics sends a redacted log to Silo Diagnostics, and Home offers to after a crash.

Layout

components/      SceneGraph components and their BrightScript controllers
source/          Entry point and non-visual BrightScript modules
images/          Packaged Roku artwork
fonts/           Subset Inter TTFs with their license and SOURCE
locale/          Localized strings
tests/           Rooibos specs, mirroring source/ paths
scripts/         Build, sideload, signing, device, and asset scripts
docs/            Product and architecture documentation
manifest         Roku package manifest

Prerequisites

  • Node.js 22 (.nvmrc) and Python 3
  • A Roku in Developer Mode that this machine (or a relay host with curl and Python 3) can reach on ports 80 and 8060
  • A running Silo server for sign-in, browsing, and playback

Build and sideload

  1. Enable Developer Mode on the Roku: with the remote, press Home three times, Up twice, then Right, Left, Right, Left, Right. Enable the installer, accept the SDK license, and set a password. The username is always rokudev.
  2. Copy .env.example to .env and set ROKU_HOST and ROKU_PASSWORD. If this machine cannot reach the Roku, set ROKU_DEPLOY_VIA to a command that runs a shell command on a host that can (for example an SSH wrapper).
  3. Install the tooling and sideload:
npm ci
npm run lint           # BrighterScript and bslint validation, no package
npm run sideload       # build out/silo-roku.zip and install it as the dev app
npm run sideload:dev   # the dev build, with the diagnostic screen and dev tools
npm run console        # stream the BrightScript debug console (port 8085)
npm run roku -- key Home   # drive the device over ECP

npm run build, build:beta, build:perf, and build:dev make the four package variants in out/. Sideloading replaces the device's single developer app slot, and sideloaded builds are not release evidence.

Testing

npm test               # Rooibos specs, headless under brs-node, in shards
npm run format:check   # brighterscript-formatter check (npm run format rewrites)
npm run ci             # the pull request checks: lint, format, build, size,
                       # hygiene, Static Analysis, contract, and tests

Static Analysis needs Java 21 and unzip. Headless results are not device evidence; scripts/device-check.sh runs the cold-launch, performance, and deep-link checks on a real Roku.

Documentation

Contributing

Right now, the most helpful way to contribute is a clear, accurate issue. We implement and review changes through our own workflow, and pull request volume has outgrown what we can review carefully, so a good issue usually helps us more than a pull request.

Feature ideas go in Discussions → Ideas, not issues. Search first and upvote an existing idea rather than repeating it. Maintainers open an issue for an idea when they plan to build it.

Pull requests are still welcome from contributors who've had one merged in a Silo repository, or when a maintainer asks for one. A feature pull request (a feat title) from someone without triage or write access must also link, in its description, an issue in this repository that a maintainer has labeled accepted. A workflow closes other pull requests without review when they open. That isn't a judgment of the work: if the problem still matters, open an issue and link the closed pull request. Once a feature's issue is labeled accepted, link it in a new pull request, or ask a maintainer to reopen the closed one. If a maintainer asked you for a pull request and you haven't had one merged yet, the workflow still closes it when it opens; the maintainer reopens it, and the check leaves it alone from then on.

A change users can notice is not done until each other Silo client (Apple, Android, and Web) has been handled or ruled out. For each one that needs the same change, open an issue in its repository at minimum, linking your pull request; search first and add to an existing issue when there is one. Open a pull request there too if you can build and verify that client and its contribution rules let you. List the outcome on the template's Other clients: line. Cross-client parity has the details.

Two more rules apply to pull requests from anyone without triage or write access, including invited ones. Open the pull request ready for review: the workflow closes drafts, both when they open and when they are converted to drafts. And every pull request needs evidence. One whose Evidence check still asks for evidence 24 hours after it opens, or after a maintainer reopens it, is closed without review, so publish or attach evidence soon after you open it.

Evidence shows reviewers the change working without building the branch:

  • A change users can see: before-and-after screenshots of the same screen with the same data, taken on a Roku device, and a short recording when motion, timing, or focus matters. After a sideload, npm run roku -- screenshot captures the screen. Name the Roku model, Roku OS version, and build for each capture.
  • A change nothing shows: the steps you ran, the build or commit, and trimmed test or lint results that show it does what the description says.

Attach evidence under the pull request's Evidence heading, cropping or blurring server addresses, account names, and personal library contents, since GitHub is public. Or publish it to evidence.siloserver.org, where only you and Silo maintainers can open it after signing in with GitHub: upload from the Details link of the pull request's Evidence check, or run npx @silo-server/evidence publish <folder> --pr <number> (Node.js 22 or later, after npx @silo-server/evidence login), then write Evidence: https://evidence.siloserver.org/r/silo-roku/pr-<number>/ under the Evidence heading. A maintainer can waive evidence with the evidence-not-needed label, for example for an automated dependency update.

License and trademarks

Silo Roku is licensed under AGPL-3.0-or-later. See LICENSE.

The Silo name, logo, and wordmark are trademarks of Silo Media L.L.C. and are not covered by the AGPL. You're free to fork and redistribute the code, but forks and redistributions must not use the Silo brand as their identity and must remove or replace the brand assets. Publishing a Silo-branded app to an app store requires written permission. See TRADEMARK.md for what's permitted — including referential use like "compatible with Silo."

About

Native Roku client for the Silo self-hosted media server.

Topics

Resources

Contributing

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages