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.
2.6 KiB
Getting started
This page takes you from nothing to a playing episode. It takes a few minutes.
1. Install the app
Download the package for your system from the latest release and install it. Installation has the commands for each platform.
2. Add a share
A share is a folder the app reads videos from. There are two kinds:
- A public share link. Someone sends you a Proton Drive link such as
https://drive.proton.me/urls/ABC123#xyz. You need no Proton account for this. - A folder of your own Drive. Sign in to your Proton account, then pick a folder. See Account and sync.
To add a public link on the desktop:
- Copy the whole link, including the part after
#. That part is the key that decrypts the share, so the link does not work without it. - Open the Shares page, or press Ctrl+V anywhere outside a text field.
- Paste the link into Link.
- If the person who shared it set a password of their own, turn on The link asks for a password and type it.
- Click Add share.
The app opens the link to check it before it saves anything. If the link is wrong, it tells you why and stores nothing.
On Android and iOS, tap Add share on the Shares tab. On Android you can also share the link to the app from your browser. Android and iOS has the details.
3. Wait for the library to fill
The app reads the share's folders. This is called a crawl. Titles appear in the Library as they are found. A large share takes a minute or two.
The folder layout decides how titles are grouped. Each show should have its own folder:
Sousou no Frieren/
Season 01/
S01E01.mkv
S01E02.mkv
Paprika (2006).mkv
A file without episode numbers is shown as a film. How the library reads your folders has the full rules.
4. Press play
Open a title and click Play. The episode starts in a few seconds, and you can drag the seek bar to any point. The app remembers where you stopped, so Resume takes you back.
Next steps
- Posters and descriptions. Turn them on in Settings → Posters and descriptions. They are off by default, because the app then sends your title names to AniList or TMDB. See Privacy.
- Your place on every device. Sign in to Proton on each device, and your position in every episode follows you. See Account and sync.
- Keyboard. Press ? on the desktop for the list of shortcuts.