0 Fork 0

mirror of https://github.com/narrrl/proton-stream.git synced 2026-11-03 16:41:26 +01:00

Files

T

nvrl a8a18be248 docs(readme): screenshots, install table and features up to 1.6.1

The README still described an early, public-links-only app. It now
shows the desktop and Android apps, lists what each release ships per
platform, covers sign-in, Drive folders, sync, downloads, Android TV and
dialogue-first subtitles, and points at the wiki for the details.

2026-10-17 20:46:32 +02:00

ACCOUNT_AND_SYNC.md

docs: user guide pages, published to the GitHub wiki

2026-10-17 20:46:09 +02:00

ANDROID.md

feat(android): install on Android TV, and take a remote's keys in the player

2026-10-13 21:37:40 +02:00

ARCHITECTURE.md

feat(core,app,android,cli,ios): sync the library and settings, verify a share before adding it

2026-10-09 03:15:39 +02:00

BUGS.md

fix(app): never let the system's CJK font stop the app at start

2026-10-13 21:47:45 +02:00

CLI.md

docs: user guide pages, published to the GitHub wiki

2026-10-17 20:46:09 +02:00

DESIGN-TOKENS.md

refactor(app): spacing, radius and motion tokens

2026-10-02 23:10:39 +02:00

DEVELOPMENT.md

docs: sidecar subtitles are no longer a gap

2026-10-13 21:11:20 +02:00

FAQ.md

docs(readme): screenshots, install table and features up to 1.6.1

2026-10-17 20:46:32 +02:00

GETTING_STARTED.md

docs: user guide pages, published to the GitHub wiki

2026-10-17 20:46:09 +02:00

INSTALL.md

docs: user guide pages, published to the GitHub wiki

2026-10-17 20:46:09 +02:00

IOS.md

feat(ios): notify when a show gains episodes

2026-10-13 21:26:15 +02:00

METADATA.md

feat(core,app,android): sort, fold and shelve the Android library

2026-10-04 02:04:15 +02:00

MOBILE.md

docs: user guide pages, published to the GitHub wiki

2026-10-17 20:46:09 +02:00

PRIVACY.md

docs: user guide pages, published to the GitHub wiki

2026-10-17 20:46:09 +02:00

README.md

docs: user guide pages, published to the GitHub wiki

2026-10-17 20:46:09 +02:00

TESTING.md

feat(core,app,android,cli,ios): sync the library and settings, verify a share before adding it

2026-10-09 03:15:39 +02:00

TROUBLESHOOTING.md

docs: user guide pages, published to the GitHub wiki

2026-10-17 20:46:09 +02:00

USER_GUIDE.md

docs: user guide pages, published to the GitHub wiki

2026-10-17 20:46:09 +02:00

README.md

proton-stream documentation

proton-stream turns the videos in your Proton Drive, and the share links people send you, into a library you can browse and stream. It runs on Linux, Windows, Android, Android TV and iOS. This is an unofficial client, not a Proton product.

Start here

Getting started: install, add your first share, press play.
Installation: every platform, and how to update and uninstall.
FAQ: short answers to the questions people ask first.

Using it

User guide: the library, title pages, the player, downloads, history and settings.
Account and sync: signing in, folders of your own Drive, and keeping your place on every device.
Android and iOS: what is different on a phone, a tablet and Android TV.

Reference

Command-line reference: the pstr tool and the proton-stream launcher.
Privacy: what goes where, and what stays on your device.

When something goes wrong

Troubleshooting: links that will not add, sign-in problems, playback problems, and where the logs are.

Contributing

Development: the state of each layer, the build order and the traps.
Architecture: the crates, the data flow when an episode plays, and where secrets live.
Testing, Metadata, Design tokens, Android development and iOS development.

Bugs are tracked in BUGS.md in the repository.