Skip to content

Your Android phone and your Windows PC, working as one. Local-first, end-to-end encrypted, no account.

Document the desktop crate layout as built

Beeb3fb4fd3e038
diff --git a/docs/PLAN.md b/docs/PLAN.md
index eb32ba4..1e3f4c3 100644
--- a/docs/PLAN.md
+++ b/docs/PLAN.md
@@ -251,7 +251,7 @@ Power: 🟒 Basic Β· πŸ”΅ Assist Β· 🟣 Elevated (see Β§4.6).
β”‚ Qt Quick UI (QML screens, Nectarlink design system) β”‚ β”‚ Compose UI (Material 3 Expressive) β”‚
β”‚ main window Β· Island Β· Shelf Β· Deck editor Β· palette β”‚ β”‚ home Β· devices Β· onboarding Β· Deck Β· tiles Β· widgets β”‚
β”‚ mirror/app windows: decoded D3D11 video inside the UI β”‚ β”‚ β–² Kotlin facades (Flows) β”‚
-β”‚ β–² nectarlink-qt bridge (cxx-qt view-models, in-proc) β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚
+β”‚ β–² cxx-qt bridge (view-models, in-process) β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚
β”‚ β”Œβ”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ β”‚ β”‚ Android services (Kotlin) β”‚ β”‚
β”‚ β”‚ nectarlink-desktop (Rust) β”‚ β”‚ β”‚ β”‚ NotificationListener Β· SMS/Calls/Contacts Β· MediaSessionβ”‚ β”‚
β”‚ β”‚ nectarlink-win: toasts+reply Β· Cloud Files Β· GSMTC/ β”‚ β”‚ β”‚ β”‚ CameraX Β· AudioRecord Β· MediaProjection Β· CDM Β· FGS β”‚ β”‚
@@ -281,9 +281,10 @@ nectarlink/
nectarlink-ffi/ UniFFI bindings for Kotlin
nectarlink-cli/ command-line client
desktop/
- app/ Rust host: startup, tray, window lifecycle, wiring to core
- nectarlink-qt/ the ONLY Rust↔Qt bridge: cxx-qt view-models exposed to QML
- qml/ Nectarlink design system (tokens, ~30 components) + screens. Presentation only
+ app/ one crate (cxx-qt builds the QML module, bridge and binary together):
+ src/ Rust host: startup, tray, window lifecycle, wiring to core
+ src/bridge/ the ONLY Rust↔Qt bridge: cxx-qt view-models exposed to QML
+ qml/ Nectarlink design system (tokens, ~30 components) + screens. Presentation only
platform/ `Platform` trait: nectarlink-win (windows-rs) now, nectarlink-mac later
video/ `VideoSink`: MF decode + D3D11 texture β†’ Qt Quick scene-graph item (small C++)
now; VideoToolbox + Metal later
@@ -464,7 +465,7 @@ What we optimize for, in order:
| Issue | Rule / mitigation |
|---|---|
| Three languages in the UI layer (QML, Rust, a little C++) | **QML is presentation only**: screens, layout and animation. No business logic in QML/JavaScript. C++ is limited to the video item and a few window tweaks |
-| cxx-qt is pre-1.0 (0.10.x, KDAB) | Pin the version, upgrade on purpose. **One bridge crate (`nectarlink-qt`)** is the only place Rust touches Qt |
+| cxx-qt is pre-1.0 (0.10.x, KDAB) | Pin the version, upgrade on purpose. **One bridge module (`desktop/app/src/bridge`)** is the only place Rust touches Qt |
| Heavier build (Qt install, C++ glue, separate ARM64 build) | Install Qt via aqtinstall, cached in CI. Windows ARM64 is a supported Qt platform (MSVC 2022). Scripts make it one command locally |
| Two threading worlds (Rust async runtime vs Qt's screen thread) | **One pattern everywhere** for handing core events to the screen thread (cxx-qt's thread queue). No ad-hoc cross-thread calls |
| Bigger installer (+30–50 MB) | Ship only the Qt modules we use. `windeployqt` with an explicit module list |
@@ -681,7 +682,7 @@ Each phase ends with a usable, releasable product. Phase sizes are relative; act
| **Total, year 1** | **Bare minimum β‰ˆ $10–50 Β· Comfortable β‰ˆ $250–450** | Funded via GitHub Sponsors / Open Collective once public |
### 10.7 Future scope (recorded)
-- **macOS desktop:** the maintainer has a MacBook. A port, not a rewrite: the Rust core, the `nectarlink-qt` bridge and ~90 % of the QML screens are shared (Qt Quick renders with Metal on Mac). Mac-specific work sits behind `Platform`/`VideoSink`:
+- **macOS desktop:** the maintainer has a MacBook. A port, not a rewrite: the Rust core, the cxx-qt bridge and ~90 % of the QML screens are shared (Qt Quick renders with Metal on Mac). Mac-specific work sits behind `Platform`/`VideoSink`:
| Feature | Windows | Mac |
|---|---|---|
diff --git a/docs/foundations/phase-0.md b/docs/foundations/phase-0.md
index 09e9c8d..f9a6a10 100644
--- a/docs/foundations/phase-0.md
+++ b/docs/foundations/phase-0.md
@@ -33,9 +33,12 @@ nectarlink/
nectarlink-ffi/ UniFFI bindings (MPL-2.0)
nectarlink-cli/ dev/debug CLI: pair, ping, status (GPL)
desktop/
- app/ Rust binary: startup, tray, windows (GPL)
- nectarlink-qt/ cxx-qt bridge (view-models) (GPL)
- qml/ design system + screens (GPL)
+ app/ the desktop app, one crate (GPL)
+ src/bridge/ cxx-qt bridge: the only Rust↔Qt code
+ src/win/ Windows integration (tray, power, sound)
+ cpp/ C++ for Qt hooks (window chrome)
+ qml/ design system + screens
+ tools/xtask/ code generation (theme tokens) and checks (GPL)
android/ Gradle project (app module) (GPL)
spikes/ throwaway experiments, one folder each
docs/