docs: refresh status and roadmap for Slint and protocol v2

This commit is contained in:
Loki 2026-10-24 16:53:05 +02:00
parent 3e7f5b22dc
commit f1883e5001
Signed by: boba
GPG key ID: 253067914055423B
3 changed files with 20 additions and 9 deletions

View file

@ -3,7 +3,18 @@
This file describes what the repository actually does today.
Protocol and security docs may describe future phases. When in doubt, trust this file.
Last updated: 2026-06-29.
Last updated: 2026-10-24.
---
## Update 2026-10 (protocol v2)
- Signed v2 handshake and protobuf payloads between client and gateway (verified by `VNOX-Client/tests/gateway_interop.rs`).
- Authenticated, encrypted UDP voice relay in voice-node.
- Voice access is revoked when a channel is deleted, a member is kicked or permissions change.
- Senders get acknowledgements for their own chat messages.
- Channel webhooks, GitHub sign-in, hub service, screen sharing and media broadcast.
- `cargo audit`: no known vulnerabilities in both workspaces (2026-10-24).
---
@ -51,7 +62,7 @@ Last updated: 2026-06-29.
| SDK crate | Present as a stub; not a usable public API yet. |
| Federation crate | Stub only (`// TODO`). |
| RNNoise | Feature-gated, no-op stub by default. Enable with `--features rnnoise`. |
| Slint migration | Plan exists at `docs/superpowers/plans/2026-05-31-slint-migration.md`; deferred — egui UI continues to be improved. |
| Slint migration | Done. The client UI is Slint (RU/EN localization, themes, settings). |
| Server-side channel creation | Client-side channels work locally; gateway still needs `ChannelCreate` packet + storage (Phase 2). |
| Identity export/import UI | Vault API is ready (`identity::save(identity, Some(passphrase))`), but no UI modal yet. |

View file

@ -5,7 +5,7 @@
```
┌─────────────────────────────────────────────────────┐
│ VNOX Client │
│ (Rust + egui + wgpu) │
│ (Rust + Slint) │
└────────────────────┬────────────────────────────────┘
│ LNEx v1
┌──────────┴──────────┐
@ -104,7 +104,7 @@ Can run on the same machine as the gateway or separately.
### client
Language: Rust
UI: egui
UI: Slint
Renderer: wgpu
Audio: cpal + rodio + opus
Networking: tokio
@ -151,7 +151,7 @@ Handles cross-node communication:
|-----------|----------|----------|
| Gateway | Rust | Tokio, serde, sqlx |
| Voice node | Rust | opus, tokio |
| Client | Rust | egui, wgpu, cpal, tokio |
| Client | Rust | Slint, cpal, tokio |
| Overlay | Rust | TBD |
| Plugins | TypeScript | Deno / QuickJS |
@ -175,7 +175,7 @@ without changing the wire framing (header stays identical).
```
vnox/
├── client/ # Desktop client (Rust + egui)
├── client/ # Desktop client (Rust + Slint)
├── gateway/ # TCP gateway (Rust + Tokio)
├── voice-node/ # UDP voice relay (Rust)
├── federation/ # Federation layer (Phase 3)
@ -259,7 +259,7 @@ client/src/
│ ├── config.rs # find() best StreamConfig for device
│ ├── capture.rs # cpal input → Opus encode → EncodedFrame channel
│ └── playback.rs # Opus decode → cpal output
└── ui/ # egui layout
└── ui/ # Slint layout
├── mod.rs # VnoxApp, eframe::App impl, poll_net()
├── state.rs # UiState, ConnState, Channel, ChatMessage
├── theme.rs # color constants (BG_BASE, ACCENT, …)

View file

@ -62,11 +62,11 @@ See [features/direct-messages.md](05-features/direct-messages.md). **Backend and
- [x] Makes VNOX safe for single-server deployment (OwnCord-style)
### UI Refresh
- [x] Evaluate Slint vs improving egui design system — **staying on egui**
- [x] Evaluate Slint vs egui: migrated to Slint
- [x] Custom dark theme with accent color support (#E67E22 orange)
- [x] Redesigned channel list and user bar
- [x] Consistency pass across all settings panels
- [ ] Slint migration plan exists at `docs/superpowers/plans/2026-05-31-slint-migration.md` (deferred to Phase 2+)
- [x] Slint migration done (client UI is native Slint)
### Client Polish
- [x] Audio device labels in settings (live cpal enumeration)