R3: Player, server and contributor documentation

- docs/PLAY.md is now the player guide: install from the tarball or .deb,
  starting a match, controls, how a match goes, settings files and
  troubleshooting, ahead of the graphics and tested-configuration sections.
- docs/SERVER.md: quick start, every option, ports, being found, logs,
  Docker and systemd, memory, and what was checked.
- CONTRIBUTING.md (engine setup, rules, commits, licence of contributions)
  and CREDITS.md.
- README: status and known limitations as they are.
- GDD controls table matched to the real defaults (B, Tab, G, 1 to 6).

Running the documented commands from an unpacked release found two bugs,
fixed here:
- `tidewall --connect=HOST` ignored the option unless it came after `--`.
  ClientConfig.game_args() now takes the game's own options from the
  engine's arguments when there is no `--`; tested.
- A headless run with no mode printed a line and never exited; it quits now.

The renderer option is given as the pair the capture tests use
(`--rendering-method gl_compatibility --rendering-driver opengl3`) in the
docs, the tarball README and the man page. The Join menu only searching the
LAN is documented and filed as #82.

Closes #62

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
2026-11-14 08:30:16 -05:00
co-authored by Claude Opus 5.5
parent df367d691a
commit 36d474695a
13 changed files with 494 additions and 32 deletions
+3 -1
View File
@@ -13,7 +13,9 @@ continuity.
- [docs/STYLE.md](docs/STYLE.md): the look and sound. Every client colour comes from `Palette`.
- [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md): server-authoritative design and module map.
- [src/sim/tuning.gd](src/sim/tuning.gd): the one table of gameplay numbers.
- [docs/PLAY.md](docs/PLAY.md): graphics presets, renderers and the tested configurations.
- [docs/PLAY.md](docs/PLAY.md): the player guide (install, controls, rules), graphics presets, renderers and the tested configurations.
- [docs/SERVER.md](docs/SERVER.md): the server guide. [CONTRIBUTING.md](CONTRIBUTING.md) and [CREDITS.md](CREDITS.md).
- When a command, option or control changes, update PLAY.md, SERVER.md and the man pages in `packaging/deb/man/` with it.
- [docs/BALANCE.md](docs/BALANCE.md): how the pacing and weapons were tuned from bot matches.
## Commands