Reference
CSRetro documentation is maintained under docs/ (MkDocs). Essential cvars, commands, and install layout are on the component and audience pages — not on third-party sites. Maintainer-only documentation rules live in .github/documentation-policy.md in the repository (not published on the docs site).
Documentation workflow (authors)
- Sources: prefer vendored trees in this repository (
engine/Documentation/, YaPBConVardefinitions, NodeModpackages/core/types/). - Curate: add or extend English pages under
docs/; use CSRetro paths andcsr_*binary names. - Validate:
python3 -m venv .venv && .venv/bin/pip install -r requirements-docs.txt && .venv/bin/mkdocs build --strict(see Developers).
Audience-specific
| Audience | Document |
|---|---|
| Players | Players, Client CVARs |
| Server hosts | Server administrators, Server CVARs |
| Builders / contributors | Building, Developers |
| Topic index (coverage map) | Documentation coverage |
| Cross-component notes | Cross-component reference |
Components (in this handbook)
| Topic | Primary page |
|---|---|
| Engine (Xash3D FWGS) | Engine |
| Client (cs16-client) | Client |
| Metamod | Metamod |
| NodeMod | NodeMod, NodeMod – CSRetro |
| YaPB | YaPB |
Origins and licenses for upstream projects are listed in Credits. Pinned source revisions for csr version are in VENDOR.md (repo root) and Vendor table (VENDOR.md).