R3 Player, server and contributor documentation #62

Closed
opened 2026-11-09 05:29:44 +00:00 by claude · 1 comment
Owner

Depends on: R1

docs/PLAY.md, docs/SERVER.md, CONTRIBUTING.md, CREDITS.md and an updated README.

Acceptance

  • Each documented command was actually run.
  • The README's status and known limitations match reality.
**Depends on:** R1 `docs/PLAY.md`, `docs/SERVER.md`, `CONTRIBUTING.md`, `CREDITS.md` and an updated README. **Acceptance** - Each documented command was actually run. - The README's status and known limitations match reality.
claude added this to the v1.0 Release milestone 2026-11-09 05:29:44 +00:00
claude added the type/chorepriority/high labels 2026-11-09 05:29:45 +00:00
claude added this to the Tidewall v1.0 project 2026-11-09 15:00:09 +00:00
eric closed this issue 2026-11-14 13:30:20 +00:00
Author
Owner

Done in 36d4746.

What changed

  • docs/PLAY.md is now the player guide: install from the tarball or .deb, starting a match, controls, how a match goes, the settings file and troubleshooting. The graphics and tested-configuration sections are unchanged.
  • New docs/SERVER.md: quick start, the option table, ports and firewalls, how servers are found, logs, Docker/systemd (pointing to packaging/README.md), memory, and what was checked.
  • New CONTRIBUTING.md and CREDITS.md.
  • The README's status and known limitations now match the open issues.
  • The GDD controls table was stale (it said Q, T and 1 to 5). It now matches KeyBindings.

How the commands were checked
I ran the documented commands from a fresh make dist tarball, unpacked outside the repo with its own HOME and XDG dirs:

  • sha256sum -c
  • ./tidewall-server --config=server.cfg; curl /health returned status ok
  • --browse on the LAN, and through a --list-server that a server had registered with using --list=
  • --connect with autoplay, which joined and reached the drop
  • --offline, which played
  • install-desktop-entry.sh, then --remove, which left nothing behind
  • SIGTERM, which exited 0 with no errors

The engine setup steps in CONTRIBUTING were run against the templates file and tools/godot.sh --verify. The editor zip itself isn't on this host, so its checksum line wasn't re-run. The Debian install and purge were covered by make deb-check, which passed, and Docker by the existing make server-package-check. make check passed (664 tests).

Bugs found by running them, fixed in the same commit

  • ./tidewall --connect=HOST ignored the option unless it came after --. The release README and man page implied otherwise. ClientConfig.game_args() now picks up the game's own options either way. A test covers it.
  • A headless run with no mode printed a line and never exited. It now quits with a hint.

Follow-ups

  • #82: the Join menu only searches the LAN, so list servers work from the command line only. This is documented as a limitation.
  • The "Tested configurations" table in PLAY.md gets updated after Eric's playtest (R6).

— tidewall-build

Done in 36d4746. **What changed** - `docs/PLAY.md` is now the player guide: install from the tarball or .deb, starting a match, controls, how a match goes, the settings file and troubleshooting. The graphics and tested-configuration sections are unchanged. - New `docs/SERVER.md`: quick start, the option table, ports and firewalls, how servers are found, logs, Docker/systemd (pointing to `packaging/README.md`), memory, and what was checked. - New `CONTRIBUTING.md` and `CREDITS.md`. - The README's status and known limitations now match the open issues. - The GDD controls table was stale (it said Q, T and 1 to 5). It now matches `KeyBindings`. **How the commands were checked** I ran the documented commands from a fresh `make dist` tarball, unpacked outside the repo with its own HOME and XDG dirs: - `sha256sum -c` - `./tidewall-server --config=server.cfg`; `curl /health` returned status ok - `--browse` on the LAN, and through a `--list-server` that a server had registered with using `--list=` - `--connect` with autoplay, which joined and reached the drop - `--offline`, which played - `install-desktop-entry.sh`, then `--remove`, which left nothing behind - SIGTERM, which exited 0 with no errors The engine setup steps in CONTRIBUTING were run against the templates file and `tools/godot.sh --verify`. The editor zip itself isn't on this host, so its checksum line wasn't re-run. The Debian install and purge were covered by `make deb-check`, which passed, and Docker by the existing `make server-package-check`. `make check` passed (664 tests). **Bugs found by running them, fixed in the same commit** - `./tidewall --connect=HOST` ignored the option unless it came after `--`. The release README and man page implied otherwise. `ClientConfig.game_args()` now picks up the game's own options either way. A test covers it. - A headless run with no mode printed a line and never exited. It now quits with a hint. **Follow-ups** - #82: the Join menu only searches the LAN, so list servers work from the command line only. This is documented as a limitation. - The "Tested configurations" table in PLAY.md gets updated after Eric's playtest (R6). — tidewall-build
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: claude/tidewall#62