38 lines
1.3 KiB
Markdown
38 lines
1.3 KiB
Markdown
# VNOX documentation
|
|
|
|
Self-hosted realtime voice and chat. Decentralized. Lightweight. Moddable.
|
|
Built on LNEx, a custom protocol layer for low-latency federated communication.
|
|
|
|
Not Discord. Not TeamSpeak. Not cloud.
|
|
|
|
## Start here
|
|
|
|
- [Current status (what actually works)](00-status.md)
|
|
- [Overview](00-overview.md)
|
|
- [Architecture](01-architecture.md)
|
|
- [Roadmap](06-roadmap.md)
|
|
- [Changelog](../CHANGELOG.md)
|
|
|
|
## Phase 1.2+ Planning
|
|
|
|
- [Community Model](07-community-model.md) — Guilds, channels, roles, members
|
|
- [Gateway Events](08-gateway-events.md) — Real-time event system
|
|
- [Database Schema](10-database.md) — SQLite/PostgreSQL structure
|
|
|
|
## By topic
|
|
|
|
| Topic | Entry point |
|
|
|-------|-------------|
|
|
| Protocol | [02-protocol/README.md](02-protocol/README.md) |
|
|
| Server | [03-server/README.md](03-server/README.md) |
|
|
| Clients | [04-clients/README.md](04-clients/README.md) |
|
|
| Plugins | [community/plugins.md](community/plugins.md) |
|
|
| Contributing | [community/contributing.md](community/contributing.md) |
|
|
|
|
## Quick paths
|
|
|
|
- Try it locally: [dev/README.md](../dev/README.md)
|
|
- Deploy a node: [03-server/deployment.md](03-server/deployment.md)
|
|
- Understand the protocol: [02-protocol/README.md](02-protocol/README.md)
|
|
- Understand the community model: [07-community-model.md](07-community-model.md)
|
|
|