Files
claudeandClaude Opus 5.5 36d474695a 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>
2026-11-14 08:30:16 -05:00

59 lines
2.4 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-method gl_compatibility --rendering-driver opengl3` to use OpenGL
(it also falls back to OpenGL by itself when Vulkan can't start).
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