mirror of
https://github.com/narrrl/proton-stream.git
synced 2026-11-03 16:41:26 +01:00
nvrl
16c2b4c9d3
docs/ gains pages for people using the app rather than building it: getting started, installation, the user guide, account and sync, Android and iOS, the command line, privacy, an FAQ and troubleshooting. docs/README.md is the wiki's home page. scripts/publish-wiki.sh, ported from proton-drive-linux, checks every link in docs/ and README.md, rewrites links between pages to wiki page names and copies the images they show. The Wiki workflow runs the check on pull requests and publishes on every push to main. images/ holds library, title and episode screenshots from the desktop and Android apps, and the logo.
1.7 KiB
1.7 KiB
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
pstrtool and theproton-streamlauncher. - 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.