Retire legacy sources and verify managed iOS deployment
This commit is contained in:
@@ -1,68 +1,45 @@
|
||||
# VoiceCat
|
||||
|
||||
Self-hosted, native voice & text chat in the spirit of classic TeamSpeak / Mumble —
|
||||
channel-based voice, channel + private text, one server you run yourself. Plain **TCP**
|
||||
(control) and **UDP** (media), no WebRTC. Encrypted by default. A shared **C++ core**
|
||||
(`libvoicecat`) drives native clients (Swift on macOS/iOS, C# on Windows) and the server.
|
||||
VoiceCat is a self-hosted, channel-based voice and text chat system built on .NET 10. It uses
|
||||
TLS 1.3 for protobuf control traffic and authenticated encrypted UDP for Opus media. There is
|
||||
no WebRTC, central directory, or plaintext mode.
|
||||
|
||||
> **Status:** Design complete in [`docs/`](docs/). M1–M5 are implemented — real TLS control
|
||||
> plane, encrypted UDP voice (Opus), multi-stream, TOFU identity pinning, channel tree,
|
||||
> permissions, moderation, disconnect/keepalive/reaper. Windows WinForms C# client shipped
|
||||
> (M4). macOS/iOS Swift client is next. See [`PROGRESS.md`](PROGRESS.md) and
|
||||
> [`docs/roadmap.md`](docs/roadmap.md).
|
||||
|
||||
## Read the design first
|
||||
|
||||
The [`docs/`](docs/) folder is the source of truth. Start at [`docs/README.md`](docs/README.md),
|
||||
then `architecture` → `protocol` → `voice` → `security` → `tech-stack` → `deployment` →
|
||||
`roadmap`.
|
||||
The repository contains a managed server, CLI, shared client/audio core, and native Windows,
|
||||
macOS, and iOS user interfaces. A small C library supplies Opus/RNNoise, and a small Swift iOS
|
||||
extension captures ReplayKit application audio.
|
||||
|
||||
## Build
|
||||
|
||||
The default development preset is **`dev`** — it builds everything (server + tools + tests)
|
||||
with real vcpkg deps. It works on Windows, Linux, and macOS (vcpkg triplet auto-resolved).
|
||||
|
||||
```bash
|
||||
# one-time vcpkg setup (bundled as a submodule, pinned to vcpkg.json's builtin-baseline):
|
||||
git submodule update --init vcpkg
|
||||
./vcpkg/bootstrap-vcpkg.sh # .bat on Windows
|
||||
|
||||
# configure + build + test:
|
||||
cmake --preset dev
|
||||
cmake --build --preset dev
|
||||
ctest --preset dev # 21 behavior tests
|
||||
./dotnet/build-native.ps1
|
||||
dotnet restore dotnet/VoiceCat.slnx --locked-mode
|
||||
dotnet build dotnet/VoiceCat.slnx -c Release --no-restore
|
||||
dotnet test dotnet/VoiceCat.slnx -c Release --no-build
|
||||
```
|
||||
|
||||
To use an external vcpkg checkout instead, set `VCPKG_ROOT=/path/to/vcpkg` (or
|
||||
`$env:VCPKG_ROOT` on PowerShell) — it always takes priority over the bundled submodule.
|
||||
|
||||
Artifacts land in `build/dev/bin/` (`voicecat-server`, `vccli`, `voicecat-admin`).
|
||||
|
||||
The `skeleton` preset (no vcpkg deps, stubs only) is a fast smoke check that needs no
|
||||
third-party libraries:
|
||||
|
||||
```bash
|
||||
cmake --preset skeleton && cmake --build --preset skeleton && ctest --preset skeleton
|
||||
```
|
||||
|
||||
See [`docs/building.md`](docs/building.md) for the full preset matrix (including `release`,
|
||||
`server-release`, `windows-client`, and Apple platform scaffolding).
|
||||
See [CLAUDE.md](CLAUDE.md) for the developer map, [docs/README.md](docs/README.md) for current
|
||||
contracts, and [PROGRESS.md](PROGRESS.md) for the short release handoff.
|
||||
|
||||
## Layout
|
||||
|
||||
```
|
||||
docs/ design spec (read this)
|
||||
core/ libvoicecat — the shared C++ core
|
||||
include/ voicecat.h (the C ABI all clients call)
|
||||
proto/ voicecat.proto (control-plane wire format, source of truth)
|
||||
src/ net/ crypto/ codec/ protocol/ session/ audio/ (stubs today)
|
||||
server/ voicecat-server (headless; links the core)
|
||||
tools/vccli/ headless test client — drives the protocol from M1 on
|
||||
clients/ apple/ (Swift, M4) windows/ (C#, M4) — placeholders for now
|
||||
tests/ CTest targets
|
||||
```text
|
||||
proto/ protobuf wire schema
|
||||
dotnet/src/ managed protocol, crypto, server, client, audio, and CLI
|
||||
dotnet/tests/ managed behavior and integration tests
|
||||
clients/windows/ WinForms client
|
||||
clients/apple/dotnet/ AppKit and UIKit clients
|
||||
native/media/ narrow Opus/RNNoise C shim
|
||||
native/rnnoise/ vendored RNNoise source and model
|
||||
native/apple/broadcast/ ReplayKit broadcast extension
|
||||
docs/ current contracts and operating documentation
|
||||
```
|
||||
|
||||
## License
|
||||
The remaining C++ implementation and old Swift applications are unsupported retirement
|
||||
sources. They are not compatibility targets or architectural authorities.
|
||||
|
||||
Permissive-only dependencies (no GPL/LGPL) so the project can be redistributed freely,
|
||||
including closed-source. Project license: TBD (see [`docs/tech-stack.md`](docs/tech-stack.md) §5).
|
||||
## Non-negotiable constraints
|
||||
|
||||
- Encryption is mandatory.
|
||||
- No GPL or LGPL dependencies.
|
||||
- Real-time audio callbacks never allocate, lock, block, or perform I/O.
|
||||
- Accessibility is a release requirement on every client platform.
|
||||
|
||||
Reference in New Issue
Block a user