Documentation Index
A concise directory of all documentation located within the src/ tree.
Operator
| Document |
Description |
| README.md |
Product Overview. High-level overview, features, and runtime model. |
| CHANGELOG.md |
Release Notes. Product-visible changes by SemVer release. |
| QUICKSTART.md |
Quick Start. Quick intro for running NexQuake with Docker. |
| etc/README.md |
Quickstart Catalog. How game.json and QUICKSTART drive automatic game-data installs. |
| ENVIRONMENT.md |
Environment Reference. Complete list of environment variables for Nexus and networking. |
| SETUP.md |
Data and Servers. Managing game data, mods, and the servers.ini launch plan. |
| ADMIN.md |
Admin Commands. Reference for managing the server via console commands. |
| ARCHITECTURE.md |
Architecture. Technical deep dive into system design, protocols, and implementation details. |
Player
| Document |
Description |
| UI.md |
User Interface. How to use the in-browser settings panel for files, cfg editing, and CD controls. |
| CONTROLS.md |
Controls. Touch layout and bindings, gamepad key names and cvars, video modes. |
Component READMEs
| Document |
Description |
| build/README.md |
Build System. Documentation for Makefiles, scripts, and compiling Client/Server components. |
| bugfix/README.md |
Bug Fix Catalog. Patches and improvements for modern 64-bit systems. |
| client/README.md |
Web Client. Documentation for the Emscripten/WASM client implementation. |
| nexus/README.md |
Nexus Service. Documentation for the multiplayer routing, server management, and WebSocket gateway. |
| nexus/nqrelay/README.md |
Relay Package. Standalone WebSocket↔UDP relay package notes. |
| nexus/quake106/README.md |
Shareware Extractor. Quake 1.06 extraction package and provenance. |
| server/README.md |
Dedicated Server. Guide to the native nqserver build, configuration, and runtime. |
| ATTRIBUTIONS.md |
Attributions. Third-party software attributions and legal notices. |