- 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>
make stability (tools/stability.sh, StabilityReport) runs one dedicated
server for 50 bot matches back to back, unthrottled, sampling its resident
memory, and fails on a crash, hang, engine or script error, a match with
no winner, or memory that grows after the first five matches.
The first run had no crash, hang or error, but showed two leaks:
- ServerLoop kept every tick's duration in an array (8 bytes a tick,
about 21 MB a day at 30 Hz) and copied and sorted all of it for every
progress line. TickTimes keeps exact statistics in fixed memory: a
one-microsecond histogram up to 65 ms, plus the rare slower ticks.
- Resident memory grew about 28 MB a match (905 MB after 42 matches):
glibc gives each thread its own malloc arena, and every next island is
built on a worker thread. The server launchers (packaging/server,
packaging/dist, so also the .deb, Docker image and systemd unit) and
tools/godot.sh for --server now set MALLOC_ARENA_MAX=1 unless already
set. Tick times were unchanged (p50 501 vs 507 us, p99 1635 vs 1625).
After: 50 matches (seed 4242) in 756 s, all with a winner, exit 0, no
errors; static memory +1.6 KiB and resident +145 KiB a match, flat at
204 MB from match 26 on. No match crashed, so there is no crash seed to
turn into a regression test.
Tests: TickTimes against a sorted list, its fixed memory, the launchers'
setting, and StabilityReport. make check, dist-check and
server-package-check pass.
Closes#57
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- make deb (tools/deb.sh) builds tidewall_<version>-1_amd64.deb with
dpkg-deb: launchers in /usr/games, the game in /usr/lib/tidewall, a
validated desktop entry, hicolor icons, man pages, a DEP-5 copyright,
the engine's licences and md5sums. No maintainer scripts. Depends on
libc6 (>= 2.28), from the binary's GLIBC symbol versions.
- make deb-check (tools/deb_check.sh) checks it in a throwaway debian:13
container: apt install with no recommends, desktop-file-validate,
icons, man pages and licences, tidewall on a user's PATH, the server
and the game headless as a user, lintian, and a purge that leaves
nothing behind.
- The tarball gains a tidewall launcher (any directory, through a
symlink), install-desktop-entry.sh (per-user menu entry, --remove),
tidewall.png and ENGINE-LICENSES.txt (Godot's MIT text and bundled
notices, which R1 lacked). make dist-check covers the launcher and the
menu entry.
- Application icon: a hand-written SVG in palette colours, rendered to
16-512 px by make app-icon, and set as the window icon.
test_app_icon checks the renders, the colours and the setting.
- Fix: looping ambience played into the Dummy audio driver could be
reported as resources in use at exit. Directors play nothing without
real audio output (SoundBank.has_output()) and stop their voices on
exit.
Tests: make check (648), make dist-check, make deb-check all pass.
Closes#61
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
make dist (tools/dist.sh) checks the official export templates against
tools/engine.sha512, installs only the Linux x86_64 ones into the
repo-local engine data, exports the "Linux" preset, checks the binary is
the verified release template, and packs
build/dist/tidewall-<version>-linux-x86_64.tar.gz with a .sha256:
tidewall.x86_64, tidewall.pck, a tidewall-server launcher that runs the
same game headless with clean SIGTERM handling, an example server.cfg,
README, VERSION, licences and asset provenance.
BuildInfo gives the version (application/config/version, now 0.9.0) and
the commit (build_commit.txt written by make dist, or .git in a
checkout). The main menu shows "Version 0.9.0 (commit)" and the server's
start log line carries version and commit.
make dist-check (tools/dist_check.sh) unpacks the package outside the
repo with HOME and XDG dirs in a temp dir and runs smoke against it
(new SMOKE_DIST mode), a whole bot match, and the exported game joining
the exported server over loopback.
A release template crashes on a call on null (exit 139) and ignores
invalid calls, so in package mode smoke's fault check expects only a
non-zero exit.
Closes#60
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- packaging/server/tidewall-server: a wrapper that turns SIGTERM and SIGINT
into a clean stop through the server's new --stop-file, since the engine
can't catch signals. The server tells everyone it shut down, logs its
statistics and exits 0; the wrapper kills it only after 15 s.
- --config=PATH reads options from a file (packaging/server/server.cfg);
options after it on the command line win.
- --health-port answers GET /health with JSON (phase, players, tick, uptime)
on loopback by default. HealthServer is non-blocking and bounded.
- packaging/docker: a debian:13 image that checks the engine against
tools/engine.sha512, imports the game at build time, runs as an unprivileged
user, and works with a read-only root and a small /tmp. compose.yaml is
project and container tidewall-server, read-only, no capabilities.
- packaging/systemd: a hardened unit with a dynamic user.
- make server-package-check: compose up, healthy, non-root, read-only, a real
headless client joins over UDP into the drop, then SIGTERM stops it cleanly.
This also covers H7 (graceful shutdown on SIGTERM).
Closes#38Closes#70
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>