[Feature]: Desktop app: offline downloads

Open
#97 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript

Research direction

Read the epic #80 first, then inspect #81 for the cache/data directory and #84, #86, and #91 for media downloads and playback; start only after web parity is reached, as the issue specifies. The music path references /api/music/tracks/{id}/file, and the video path references /api/media/{id}/file?download=1. Done means downloaded episodes and albums play without a network connection with subtitles, fonts, artwork, and lyrics, and offline progress appears on the web after reconnecting.

Written by the indexing model from the issue text.

Description

enhancement

[!NOTE]
This issue was written by Claude (Claude Opus 5.5) from a planning session with @PhrolovaMoe. Part of #80, builds on #84, #86 and #91. Start after web parity is reached (all other sub-issues except #95 done). Read the epic first.

Area

Desktop app

Problem

On a laptop away from home (train, plane, bad hotel Wi-Fi), the app is useless without a connection to the server.

Proposed solution
Downloads
  • Download episodes, films, seasons, albums and playlists to local storage: video through /api/media/{id}/file?download=1 (#84), music through /api/music/tracks/{id}/file. Downloads are resumable (Range) and run in the background with a queue, progress and pause/cancel.
  • Download alongside each item what offline playback needs:
    • subtitles (the server's ASS for each text track) and fonts;
    • artwork, metadata, chapters and intro/credits markers;
    • lyrics for music.
  • Optional "download a smaller version" (a server transcode at a chosen height), if the server can produce a downloadable transcode. If it can't, file a follow-up server issue instead of adding it here.
  • Per server, in the cache/data directory from #81. Storage use is shown and managed in Settings → Desktop.
Offline mode
  • When the server can't be reached, the app shows the downloaded items (a "Downloads" view) instead of erroring, and plays them from disk with the same player (#86/#87/#91).
  • Progress, watched state, plays and scrobbles are queued and sent when the server is reachable again (oldest first; on conflict the newest position wins, as the server already decides for multiple devices).
  • Music gets the Android plan's behaviour (#47): an LRU cache of recently played tracks, pinned albums/playlists, and prefetching the next 3 queued tracks.
Done when

Downloaded episodes and albums play with the network off: subtitles, fonts, artwork and lyrics included. Progress made offline shows up on web after reconnecting.

Dominant language
TypeScript
Stars
4
Forks
1
Avg merge
4h 49m
Merged PRs (30d)
5

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • No pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tinystream-dev/tinystream

All issues in tinystream-dev/tinystream

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.