Talon
5c03e5f261
Adds vcpkg as a submodule at vcpkg/, pinned to the exact commit vcpkg.json already declares as builtin-baseline, so the bundled checkout and the manifest's resolved port versions can never drift apart. cmake/voicecat-toolchain.cmake, scripts/common.sh, and clients/apple/scripts/build-xcframework.sh now resolve vcpkg as: VCPKG_ROOT env var (external checkout) > bundled submodule. Docs updated to describe the new one-time setup. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
69 lines
2.8 KiB
Markdown
69 lines
2.8 KiB
Markdown
# 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.
|
||
|
||
> **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`.
|
||
|
||
## 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
|
||
```
|
||
|
||
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).
|
||
|
||
## 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
|
||
```
|
||
|
||
## License
|
||
|
||
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).
|