Files
tidewall/packaging/dist/README.md
T
claudeandClaude Opus 5.5 f3161bf46c R2: Debian package, desktop entry, launcher and application icon
- 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>
2026-11-14 03:12:47 -05:00

57 lines
2.3 KiB
Markdown

# Tidewall for Linux (x86_64)
A free and open-source build-and-survive battle royale. The sea rises in phases and
swallows the low ground, so the last dry land keeps getting higher and smaller.
## Play
./tidewall
`tidewall` starts the game from this folder whatever directory you are in, and works
through a symlink too (for example `ln -s "$PWD/tidewall" ~/.local/bin/tidewall`).
To add Tidewall to your desktop's application menu, for you alone:
./install-desktop-entry.sh
Run it again if you move the folder, and `./install-desktop-entry.sh --remove` to take
the entry away. On Debian or Ubuntu, the `.deb` package does all of this system-wide.
The game opens on its main menu: practice against bots offline, or join a server on
your network or by address. It needs a Vulkan-capable GPU and driver (Forward+). On
hardware without Vulkan, start it with `--rendering-driver opengl3` to use OpenGL.
Settings and key bindings are saved in `~/.local/share/godot/app_userdata/Tidewall/`.
## Run a server
./tidewall-server --config=server.cfg
`server.cfg` is an example: it takes players over UDP on port 24650, answers LAN
discovery on 24651, and fills empty places with bots. Every option can also be given
on the command line (`--port=24650`, `--bots=1`, `--name=...`). SIGTERM or Ctrl+C stops
the server cleanly. Logs are JSON lines on standard output.
## What's here
| File | |
|---|---|
| `tidewall` | Starts the game |
| `install-desktop-entry.sh` | Adds the game to your application menu |
| `tidewall.x86_64` | The Godot 4.7.2 engine (official release template) |
| `tidewall.pck` | The game |
| `tidewall-server` | Runs the same game headless as a dedicated server |
| `server.cfg` | Example server configuration |
| `VERSION` | Version, commit and engine |
| `tidewall.png` | The application icon |
| `PROVENANCE.md` | How every model, texture and sound was made |
| `ENGINE-LICENSES.txt` | The Godot engine's licence and the notices of the code built into it |
## Licence
Code: GPL-3.0-or-later (`LICENSE`). Art and audio, all generated by scripts in the
source repository: CC BY-SA 4.0 (`LICENSE-ASSETS`). The Godot engine is MIT-licensed;
its licence and the notices of the third-party code built into it are in
`ENGINE-LICENSES.txt`.
Source: https://gitea.eom.dev/claude/tidewall