31 lines
2.3 KiB
Markdown
31 lines
2.3 KiB
Markdown
# High-Performance Voice Chat App
|
|
|
|
A highly optimized, self-hosted, multi-lane voice communication application built entirely in Rust. Designed as a modern, high-performance alternative to classic tools like TeamSpeak 3, it utilizes a custom UDP protocol for zero-latency voice transmission and TLS-secured TCP for reliable text chat, server state, and user authentication.
|
|
|
|
## 📖 Architecture & Documentation
|
|
|
|
This project has been extensively planned and documented. Before contributing or building, please review the core architectural documents located in the `Documentation/` folder:
|
|
|
|
1. [**Technical Specifications**](./Documentation/High_level_plan/Technical_Specs.md): Covers the Opus integration, Wasm plugin ABI, Database schema, and custom UDP payload anatomy.
|
|
2. [**Implementation Plan**](./Documentation/Low_level_plan/Implementation_Plan.md): The low-level breakdown of the Jitter Buffer, Server Relay zero-copy logic, and local UI testing tools.
|
|
3. [**Coding & Documentation Standards**](./Documentation/Standards/Coding_and_Docs_Standards.md): Strict rules regarding zero `unsafe` code, error handling, the Actor pattern, and PR requirements.
|
|
4. [**UI Mockups**](./Documentation/Concept/UI_Mockups.md): Visual utilitarian references for the desktop client and web admin dashboard.
|
|
|
|
## 🚀 Milestones
|
|
|
|
Development is heavily structured into six distinct phases. For granular, code-level checklists of what needs to be built, see the `Documentation/Mile_Stones/` directory:
|
|
|
|
* [**Milestone 1: The Foundation**](./Documentation/Mile_Stones/Milestone_1.md) (Workspace, Protocol, Auth)
|
|
* [**Milestone 2: Local Audio & GUI**](./Documentation/Mile_Stones/Milestone_2.md) (egui, cpal, WebRTC DSP)
|
|
* [**Milestone 3: The First Voice Call**](./Documentation/Mile_Stones/Milestone_3.md) (Opus encode/decode, UDP relay)
|
|
* [**Milestone 4: Multi-User Routing**](./Documentation/Mile_Stones/Milestone_4.md) (DashMap routing, Jitter Buffer, Whisper lists)
|
|
* [**Milestone 5: Management & Plugins**](./Documentation/Mile_Stones/Milestone_5.md) (Axum Web Admin, SQLite, Extism)
|
|
* [**Milestone 6: Deployment & Release**](./Documentation/Mile_Stones/Milestone_6.md) (Docker, ChaCha20, CI/CD)
|
|
|
|
## 🛠️ Getting Started
|
|
|
|
*(Instructions for building the `core_protocol`, `client_node`, and `server_node` will be populated here during Milestone 1.)*
|
|
|
|
## ⚖️ License
|
|
*(License TBD)*
|