luna/catacomb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
catacomb/android/README.md
Luna 3a55ff5b8a feat(android): Compose app with bundled yt-dlp, theme pack, nav & progress 
Turn android/ into a real Gradle app (Kotlin + Jetpack Compose + Material3)
that bundles an on-device yt-dlp engine and reuses the Phase-4 Rust JNI core.

- Bundled engine: youtubedl-android (Python + yt-dlp + ffmpeg + aria2c) via
  Engine.kt; initialises off the main thread on first launch. Requires legacy
  jniLib packaging so the bundled .zip.so payloads extract to disk.
- Intuitive navigation: bottom NavigationBar — Download / Files / Settings.
- Settings section: dedicated screen with a live theme picker, default-quality
  chips, engine info, and a Rust-core demo.
- All 19 desktop themes ported from src/theme.rs into Theme.kt as Material3
  colour schemes, shown as tappable swatches; selection persisted (Prefs.kt).
- Download screen: live platform detection through the Rust core as you type,
  plus an improved animated determinate progress indicator (%/ETA/status/
  success-error) and a scrollable log.

Toolchain pinned for reproducibility: Gradle 8.9 wrapper, AGP 8.5.2, Kotlin
1.9.24, Compose BOM 2024.06.00, compileSdk 34, minSdk 24, ABIs arm64-v8a +
x86_64. build-apk.sh runs Gradle on a JDK <= 21 (system JDK may break R8) and
builds the Rust libs first.

Verified on an Android 14 x86_64 emulator: installs, launches, engine reports
"yt-dlp ready", Rust .so loads, theme switching re-themes live and persists
across restart, all screens render. (A real YouTube download still depends on
the anti-bot/POT question — Phases 2-3, device-only.)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-07-04 02:54:00 -07:00

3.3 KiB
Raw Blame History

Catacomb Android

The Catacomb Android app: a Compose UI over a bundled on-device yt-dlp engine (Python + yt-dlp + ffmpeg + aria2c via youtubedl-android) plus a shared Rust core (vtt, error_class, platform) called over JNI.

What lives here

  • app/ — the Gradle app (Kotlin + Jetpack Compose + Material3). The real, installable app.
  • rust/catacomb_core/ — the Rust cdylib (Phase 4) reused verbatim from the desktop's pure modules, cross-compiled to a JNI .so. See its own README.
  • demo/ — a tiny dependency-free Java app that only exercises the Rust core (a minimal, Gradle-free reference; predates the full app).

Features

  • Bundled yt-dlp — real on-device download engine, no server needed. Extracts its Python environment on first launch.
  • Intuitive navigation — bottom navigation bar: Download, Files, Settings.
  • All desktop themes — the 19 palettes from src/theme.rs (Dark, Light, Dracula, Trans, the Emo/goth set, Cyberpunk, Synthwave, Vaporwave, Nord, Gruvbox, Tokyo Night, Paper, Honey, Candlelight) selectable as live swatches; the choice is persisted.
  • Live platform detection — as you type a URL, the Rust core resolves its platform (chip shows icon + name + folder).
  • Improved progress indicator — animated determinate bar with %, ETA, live yt-dlp status line, success/error end states, plus a scrollable log.

Build

./build-apk.sh      # -> app/build/outputs/apk/debug/app-debug.apk  (~130 MB)

build-apk.sh:

  • runs Gradle on a JDK <= 21 (the system JDK may be newer and break R8/d8; override with TOOL_JAVA_HOME),
  • builds the Rust native libs first if missing (rust/catacomb_core/build.sh),
  • writes local.properties (SDK path) and a stable debug.keystore,
  • runs ./gradlew assembleDebug.

Toolchain (pinned): Gradle 8.9 (wrapper), AGP 8.5.2, Kotlin 1.9.24, Compose compiler 1.5.14, Compose BOM 2024.06.00, compileSdk 34, minSdk 24. ABIs: arm64-v8a (devices) + x86_64 (emulator) — the intersection of what the Rust core and youtubedl-android ship.

Install & run

adb install -r app/build/outputs/apk/debug/app-debug.apk
adb shell am start -n com.catacomb.spike/.MainActivity

Verified on an Android 14 (API 34) x86_64 emulator: installs, launches, the bundled engine initialises ("yt-dlp ready"), the Rust .so loads (live platform detection), theme switching re-themes the whole app and persists across restart, and all three screens render.

Status vs the Stage-1 plan

Phase What Status
1 App shell + yt-dlp-android integration Done (this app)
2 WebView-BotGuard POT generation Not done — needs a real device + Google session
3 Token passing + anti-bot test Not done — device-only
4 Rust core -> Android .so via JNI Done (rust/catacomb_core)
5 On-device Go/No-Go Partial — app verified on emulator; anti-bot download test is device-only

The engine is bundled and initialises on-device; a successful YouTube download still depends on the anti-bot/POT question (Phases 2-3), which needs a physical device with a signed-in Google session — the open item from the feasibility research.