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
+17
View File
@@ -227,6 +227,23 @@ func test_the_command_line_picks_the_mode() -> void:
assert_false(ClientConfig.parse(PackedStringArray([bad])).is_valid(), bad)
## R3: `tidewall --connect=HOST` works without the "--" the engine wants before game
## options, as the player guide promises, and the engine's own options are left alone.
func test_game_options_are_found_with_or_without_the_separator() -> void:
var engine: PackedStringArray = PackedStringArray(["--headless", "--rendering-method", "gl_compatibility", "--connect=192.0.2.7:7000", "--name=Mara"])
var found: PackedStringArray = ClientConfig.game_args(PackedStringArray([]), engine)
assert_eq(Array(found), ["--connect=192.0.2.7:7000", "--name=Mara"])
var join: ClientConfig = ClientConfig.parse(found)
assert_true(join.is_valid(), str(join.errors))
assert_eq(join.host, "192.0.2.7")
assert_eq(join.port, 7000)
# Options after "--" are the only ones that count when there are any.
var user: PackedStringArray = PackedStringArray(["--offline"])
assert_eq(Array(ClientConfig.game_args(user, engine)), ["--offline"])
# A bare start finds nothing, so a window opens the menu.
assert_eq(ClientConfig.game_args(PackedStringArray([]), PackedStringArray(["--headless"])).size(), 0)
func test_restored_entities_keep_their_ids_and_their_order() -> void:
var registry: EntityRegistry = EntityRegistry.new()
registry.restore(7, SimEntity.ARCHETYPE_PLAYER)