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:
@@ -13,7 +13,9 @@ continuity.
|
||||
- [docs/STYLE.md](docs/STYLE.md): the look and sound. Every client colour comes from `Palette`.
|
||||
- [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md): server-authoritative design and module map.
|
||||
- [src/sim/tuning.gd](src/sim/tuning.gd): the one table of gameplay numbers.
|
||||
- [docs/PLAY.md](docs/PLAY.md): graphics presets, renderers and the tested configurations.
|
||||
- [docs/PLAY.md](docs/PLAY.md): the player guide (install, controls, rules), graphics presets, renderers and the tested configurations.
|
||||
- [docs/SERVER.md](docs/SERVER.md): the server guide. [CONTRIBUTING.md](CONTRIBUTING.md) and [CREDITS.md](CREDITS.md).
|
||||
- When a command, option or control changes, update PLAY.md, SERVER.md and the man pages in `packaging/deb/man/` with it.
|
||||
- [docs/BALANCE.md](docs/BALANCE.md): how the pacing and weapons were tuned from bot matches.
|
||||
|
||||
## Commands
|
||||
|
||||
@@ -0,0 +1,92 @@
|
||||
# Contributing to Tidewall
|
||||
|
||||
Thanks for helping. Tidewall is GPL-3.0-or-later code with CC BY-SA 4.0 art and audio,
|
||||
made with Godot 4.7.2 and typed GDScript, with no third-party addons or assets.
|
||||
|
||||
Issues and changes go through the repository at
|
||||
<https://gitea.eom.dev/claude/tidewall>. Open an issue before starting anything large,
|
||||
so it can be fitted to the roadmap in the milestones.
|
||||
|
||||
## Setting up
|
||||
|
||||
You need Linux on x86_64, `git`, `make`, `bash`, `python3` and `curl`. Docker is needed
|
||||
only for the rendering captures and the package checks.
|
||||
|
||||
1. Clone the repository.
|
||||
2. Download the **Godot 4.7.2 stable** Linux x86_64 editor
|
||||
(`Godot_v4.7.2-stable_linux.x86_64.zip`) and export templates
|
||||
(`Godot_v4.7.2-stable_export_templates.tpz`) from the official Godot release page.
|
||||
From the repository root, with both files in `~/Downloads`, check them against the
|
||||
pinned sums, unpack the editor into `tools/godot/` and put the templates beside it:
|
||||
|
||||
(cd ~/Downloads && sha512sum -c "$OLDPWD/tools/engine.upstream.sha512")
|
||||
mkdir -p tools/godot
|
||||
unzip ~/Downloads/Godot_v4.7.2-stable_linux.x86_64.zip -d tools/godot
|
||||
cp ~/Downloads/Godot_v4.7.2-stable_export_templates.tpz tools/godot/
|
||||
tools/godot.sh --verify
|
||||
|
||||
`tools/godot/` is git-ignored. No other version is supported: the build pins this
|
||||
one by its SHA-512 (`tools/engine.sha512`).
|
||||
3. Run the checks:
|
||||
|
||||
make check
|
||||
|
||||
That verifies the engine, parses every script and runs every test headless, about
|
||||
12 minutes on a desktop CPU. It must pass before every push.
|
||||
|
||||
`tools/godot.sh` always adds `--headless`, so nothing opens a window. To play from a
|
||||
source checkout on your own display, run the engine directly:
|
||||
`tools/godot/Godot_v4.7.2-stable_linux.x86_64 --path .`
|
||||
|
||||
## Where things are
|
||||
|
||||
- [docs/GDD.md](docs/GDD.md): the design. [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md):
|
||||
the module map and how the server-authoritative simulation works.
|
||||
- [docs/ORIGINALITY.md](docs/ORIGINALITY.md) and [docs/STYLE.md](docs/STYLE.md): the
|
||||
rules for everything that is seen or heard.
|
||||
- [CLAUDE.md](CLAUDE.md): working notes, including **every `make` target** with what it
|
||||
does and how long it takes.
|
||||
- `src/sim/`: the simulation. It must not depend on rendering, audio or UI; a test
|
||||
enforces this. `src/server/`, `src/net/`, `src/bots/`, `src/client/`, `src/ui/`,
|
||||
`src/audio/` and `src/app/` are the rest.
|
||||
- `src/sim/tuning.gd`: every gameplay number, and nowhere else.
|
||||
- `test/`: the tests, mirroring `src/`.
|
||||
- `tools/`: scripts for the build, checks, captures, art and audio.
|
||||
|
||||
## Rules for changes
|
||||
|
||||
- **Typed GDScript.** Untyped declarations are errors.
|
||||
- **Determinism.** All randomness in the simulation comes from the seeded streams in
|
||||
[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md). A match must replay to the same state
|
||||
hash from its seed and command log.
|
||||
- **Tests.** Add tests for what you build: a file named `test_*.gd` under `test/` with a
|
||||
class extending `TestCase`. Any engine or script error during a test fails it unless
|
||||
the test calls `expect_error()`. Run one group with
|
||||
`tools/run_tests.sh --root=res://test/sim`, or one test with
|
||||
`tools/run_tests.sh --filter=name`.
|
||||
- **Visual changes** come with a capture made after the change, with
|
||||
`tools/capture.sh <scenario> captures/<name>.png` (Docker, software rendering, about a
|
||||
minute). Look at it before you send it. Software rendering shows what is drawn, never
|
||||
how fast; don't report frame rates from it.
|
||||
- **Art and audio** are made by scripts in this repository: Blender run headless from
|
||||
`tools/models/`, synthesis in `tools/audio/`, shaders and meshes in code. Record how
|
||||
each new file was made in [assets/PROVENANCE.md](assets/PROVENANCE.md). Never add
|
||||
third-party art, audio, fonts, sample packs, code or addons.
|
||||
- **Originality.** Never name, copy or imitate another commercial game's names,
|
||||
characters, art, audio, maps, item names or UI. Read
|
||||
[docs/ORIGINALITY.md](docs/ORIGINALITY.md) first.
|
||||
- **The repository is public.** Never commit secrets, internal hostnames, private network
|
||||
details or personal data.
|
||||
|
||||
## Commits
|
||||
|
||||
One commit per issue where practical, with a short summary line, a body saying what
|
||||
changed and why, and `Closes #N` for the issue it finishes. Keep `make check` green on
|
||||
every commit.
|
||||
|
||||
## Licence of contributions
|
||||
|
||||
By contributing you agree that your code is licensed under GPL-3.0-or-later
|
||||
([LICENSE](LICENSE)) and your art and audio under CC BY-SA 4.0
|
||||
([LICENSE-ASSETS](LICENSE-ASSETS)), and that you have the right to license them so.
|
||||
Add yourself to [CREDITS.md](CREDITS.md).
|
||||
+39
@@ -0,0 +1,39 @@
|
||||
# Credits
|
||||
|
||||
## Tidewall
|
||||
|
||||
Tidewall is an [eom.dev](https://eom.dev) project. It was written by Claude, an AI
|
||||
assistant made by Anthropic, working to eom.dev's direction. That
|
||||
covers the code, the design documents, the models and textures (generated by scripts),
|
||||
the sound effects and the music (synthesized by scripts). The commit history records
|
||||
who did what.
|
||||
|
||||
Contributors add themselves here. See [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||
|
||||
## Art and audio
|
||||
|
||||
Every model, texture, icon, sound and piece of music is made by a script in this
|
||||
repository. Nothing is sampled, recorded, downloaded or taken from a third party. How
|
||||
each file was made is recorded in [assets/PROVENANCE.md](assets/PROVENANCE.md). The
|
||||
music is an original tune written for Tidewall. Licence: CC BY-SA 4.0
|
||||
([LICENSE-ASSETS](LICENSE-ASSETS)).
|
||||
|
||||
Tidewall uses no fonts of its own. Its text is drawn in the default font bundled inside
|
||||
the Godot engine, which is covered by the engine's notices below.
|
||||
|
||||
## Software
|
||||
|
||||
- **[Godot Engine](https://godotengine.org) 4.7.2**, MIT licence, by Juan Linietsky,
|
||||
Ariel Manzur and the Godot Engine contributors. The game ships the official release
|
||||
binary and export template unchanged. Its licence and the notices of the third-party
|
||||
code and fonts compiled into it are in `ENGINE-LICENSES.txt` in the release package,
|
||||
and in `/usr/share/doc/tidewall/copyright` from the Debian package. They are
|
||||
generated from the engine itself by `tools/engine_licenses.gd`.
|
||||
- **[Blender](https://www.blender.org)**, GPL, run headless by `tools/models/` to
|
||||
generate the models and icons. Blender's output is not covered by its licence, and no
|
||||
Blender assets or add-ons are used.
|
||||
- **[Debian](https://www.debian.org)** and **[Mesa](https://mesa3d.org)**: the build
|
||||
and test containers run Debian 13, and the capture tests render with Mesa's software
|
||||
rasterisers. Nothing from them is shipped in the game.
|
||||
|
||||
Tidewall has no other code dependencies and no Godot addons.
|
||||
@@ -4,7 +4,39 @@ A free and open-source third-person battle royale for Linux, made with [Godot](h
|
||||
|
||||
Up to 24 players or bots drop onto a procedurally generated island. Scavenge, fight and build. The sea rises in phases and swallows the low ground, so the last safe land keeps getting higher and smaller, and what you build can keep you above water.
|
||||
|
||||
**Status:** in development. See the [milestones](https://gitea.eom.dev/claude/tidewall/milestones) and [issues](https://gitea.eom.dev/claude/tidewall/issues). v1.0.0 is targeted for 2026-11-16.
|
||||
- **Play:** [docs/PLAY.md](docs/PLAY.md): install, controls, how a match goes, graphics and troubleshooting.
|
||||
- **Host:** [docs/SERVER.md](docs/SERVER.md): dedicated servers, options, ports, Docker and systemd.
|
||||
- **Contribute:** [CONTRIBUTING.md](CONTRIBUTING.md). Credits: [CREDITS.md](CREDITS.md).
|
||||
|
||||
## Status
|
||||
|
||||
**Pre-release (0.9.0), heading for v1.0.0.** Not yet played by a person on real hardware; that playtest comes before the release.
|
||||
|
||||
What works and is tested automatically:
|
||||
|
||||
- Whole matches, lobby to results, offline against bots or on a dedicated server, with up to 24 players and bots.
|
||||
- The rising tide on every generated island, with flooding that follows the terrain, breakwaters that hold water back, storm surges and sudden death.
|
||||
- Building walls, floors, ramps, roofs and breakwaters in driftwood, stone and salvage iron, with collapse; harvesting with the boathook; seven weapons, including a harpoon gun and a line thrower, in four tiers; healing and armor; sea chests and crates.
|
||||
- Bots at three difficulties. Balance was tuned over 200 bot matches (median match 13 minutes; see [docs/BALANCE.md](docs/BALANCE.md)).
|
||||
- Multiplayer with client prediction, tested with 24 network clients over two matches under simulated latency, jitter and loss; LAN discovery; list servers; joining by address.
|
||||
- Menus, HUD, chart, settings with rebindable keys, generated art and synthesized sound and music.
|
||||
- A release tarball and a Debian package, both checked outside the source tree, and a container image for servers. A 50-match run of one server showed no crash and flat memory.
|
||||
|
||||
All of this is checked headless or with **software rendering in a container**. No frame rate on a real GPU, and nothing about how the game feels, has been measured yet.
|
||||
|
||||
## Known limitations
|
||||
|
||||
- **Untested on real hardware.** No real GPU, Wayland session or hybrid-graphics machine has run it yet ([docs/PLAY.md](docs/PLAY.md#tested-configurations)).
|
||||
- **Solo only.** Duos and reviving ([#30](https://gitea.eom.dev/claude/tidewall/issues/30)) aren't in this release.
|
||||
- **The powder keg can be carried but not thrown** yet ([#22](https://gitea.eom.dev/claude/tidewall/issues/22)), and there are no particle effects such as muzzle flashes, tracers or splashes ([#47](https://gitea.eom.dev/claude/tidewall/issues/47)).
|
||||
- **Bots don't build** ([#29](https://gitea.eom.dev/claude/tidewall/issues/29)), and most of them fall early in a match ([#74](https://gitea.eom.dev/claude/tidewall/issues/74)).
|
||||
- **No gamepad support or tutorial** ([#53](https://gitea.eom.dev/claude/tidewall/issues/53), [#52](https://gitea.eom.dev/claude/tidewall/issues/52)). No character customization ([#43](https://gitea.eom.dev/claude/tidewall/issues/43)) or editing of placed pieces ([#18](https://gitea.eom.dev/claude/tidewall/issues/18)).
|
||||
- **The Join menu only searches the LAN.** List servers work from the command line (`--browse --list=...`); in the menu, join other servers by address.
|
||||
- Under OpenGL with shadows on, ground and rocks look paler than under Vulkan ([#81](https://gitea.eom.dev/claude/tidewall/issues/81)).
|
||||
- One network soak saw a single transient world-hash mismatch that hasn't been reproduced since ([#80](https://gitea.eom.dev/claude/tidewall/issues/80)).
|
||||
- The name is a working name until it has been cleared.
|
||||
|
||||
The [milestones](https://gitea.eom.dev/claude/tidewall/milestones) and [issues](https://gitea.eom.dev/claude/tidewall/issues) track the rest.
|
||||
|
||||
## Originality
|
||||
|
||||
@@ -12,4 +44,4 @@ Tidewall works in the build-and-survive battle royale genre, but it is its own g
|
||||
|
||||
## Licence
|
||||
|
||||
Code: GPL-3.0-or-later. Original art and audio: CC BY-SA 4.0.
|
||||
Code: GPL-3.0-or-later ([LICENSE](LICENSE)). Original art and audio: CC BY-SA 4.0 ([LICENSE-ASSETS](LICENSE-ASSETS)). The Godot engine is MIT-licensed; see [CREDITS.md](CREDITS.md).
|
||||
|
||||
+16
-12
@@ -212,7 +212,7 @@ sea wear each second: `TIDE_STRUCTURE_DPS` for most, and for breakwaters
|
||||
`BREAKWATER_WEAR_PER_METRE` per metre of water over the base, failing at once past
|
||||
`BREAKWATER_MAX_HEAD`.
|
||||
|
||||
**Placing.** Build mode (Q) shows a ghost of the selected piece where it would go:
|
||||
**Placing.** Build mode (B) shows a ghost of the selected piece where it would go:
|
||||
sea green if it can be placed, rust red if not. The look direction snaps to a quarter
|
||||
turn. Walls and breakwaters go on the edge of your own cell in that direction; floors,
|
||||
ramps and roofs go in the next cell, or in your own cell when you look well down. Ramps
|
||||
@@ -312,25 +312,29 @@ keeps under `BALANCE_MEDIAN_MINUTES_MAX`. Findings and the changes they led to a
|
||||
|
||||
## Controls
|
||||
|
||||
Rebindable. Defaults for keyboard and mouse:
|
||||
Rebindable in Settings → Controls (`src/client/key_bindings.gd` holds the defaults).
|
||||
Keys are matched by position. Defaults for keyboard and mouse:
|
||||
|
||||
| Action | Default |
|
||||
|---|---|
|
||||
| Move | W A S D |
|
||||
| Jump | Space |
|
||||
| Crouch | Left Ctrl |
|
||||
| Jump; leap from the barge; open the wing-sail | Space |
|
||||
| Crouch; dive when swimming | Left Ctrl |
|
||||
| Sprint | Left Shift |
|
||||
| Fire / harvest / place | Left mouse |
|
||||
| Use, fire, harvest or place | Left mouse |
|
||||
| Aim | Right mouse |
|
||||
| Reload | R |
|
||||
| Interact | E |
|
||||
| Build mode | Q |
|
||||
| Next / previous piece | Mouse wheel |
|
||||
| Cycle material | T |
|
||||
| Inventory slots | 1 to 5 |
|
||||
| Map | M |
|
||||
| Pick up or open | E |
|
||||
| Drop the held item | G |
|
||||
| Boathook | 1 |
|
||||
| Inventory slots | 2 to 6 |
|
||||
| Build mode | B |
|
||||
| In build mode: wall, floor, ramp, roof, breakwater | 1 to 5 |
|
||||
| In build mode: next material | Tab |
|
||||
| Chart | M |
|
||||
| Pause menu (not rebindable) | Escape |
|
||||
|
||||
Gamepad support is planned with the accessibility work in v0.6.
|
||||
Gamepad support is issue A13.
|
||||
|
||||
## Out of scope for v1.0
|
||||
|
||||
|
||||
+126
-4
@@ -1,7 +1,127 @@
|
||||
# Playing Tidewall on Linux
|
||||
|
||||
This page covers graphics settings and the systems Tidewall has been tested on. R3
|
||||
adds the rest of the player guide (controls, rules, servers).
|
||||
Tidewall is a free and open-source build-and-survive battle royale. Up to 24 players
|
||||
and bots leap from a sky barge onto a generated island, scavenge, fight and build,
|
||||
while the sea rises in phases and swallows the low ground. The last one standing wins.
|
||||
|
||||
To run a server, see [SERVER.md](SERVER.md).
|
||||
|
||||
## Install
|
||||
|
||||
You need 64-bit Linux (x86_64) and a GPU with a Vulkan driver. Without Vulkan the game
|
||||
falls back to OpenGL (see [Renderers](#renderers)).
|
||||
|
||||
**Any distribution: the tarball.** Download `tidewall-<version>-linux-x86_64.tar.gz` and
|
||||
its `.sha256` from the [releases page](https://gitea.eom.dev/claude/tidewall/releases),
|
||||
then:
|
||||
|
||||
sha256sum -c tidewall-0.9.0-linux-x86_64.tar.gz.sha256
|
||||
tar xzf tidewall-0.9.0-linux-x86_64.tar.gz
|
||||
cd tidewall-0.9.0-linux-x86_64
|
||||
./tidewall
|
||||
|
||||
`./install-desktop-entry.sh` adds Tidewall to your application menu, for you alone, and
|
||||
`./install-desktop-entry.sh --remove` takes it away again. Nothing is installed
|
||||
system-wide. To uninstall, remove the entry and delete the folder.
|
||||
|
||||
**Debian 13 or Ubuntu: the .deb package.**
|
||||
|
||||
sudo apt install ./tidewall_0.9.0-1_amd64.deb
|
||||
|
||||
That puts `tidewall` and `tidewall-server` in `/usr/games` and the game in your
|
||||
application menu. `sudo apt purge tidewall` removes it.
|
||||
|
||||
Replace `0.9.0` with the version you downloaded.
|
||||
|
||||
## Starting a match
|
||||
|
||||
The game opens on its main menu.
|
||||
|
||||
- **Practice** plays offline against bots on an island of its own. No network needed.
|
||||
- **Join a server** lists the servers it finds on your local network. Pick one, or type
|
||||
an address (`host` or `host:port`; the default port is 24650) for any other server.
|
||||
- **Settings** has Controls, Mouse, Graphics, Display and Audio tabs.
|
||||
|
||||
You can also start straight into a match from a terminal:
|
||||
|
||||
./tidewall --offline # practice against 23 bots
|
||||
./tidewall --offline --bots=5 --seed=42 # fewer bots, a chosen island
|
||||
./tidewall --connect=192.0.2.7:24650 --name=Mara
|
||||
./tidewall --headless --browse # print the LAN's servers, then quit
|
||||
./tidewall --headless --browse --list=lists.example.org:24660 # and a list server's
|
||||
|
||||
On a server, matches run back to back: a short lobby, a countdown, the drop, the match
|
||||
and the results, then a new island. If you join during a match you wait in the lobby
|
||||
for the next one. Leaving during a match counts as being eliminated where you stood.
|
||||
|
||||
## Controls
|
||||
|
||||
Every key can be rebound in Settings → Controls. Mouse sensitivity and inversion are on
|
||||
the Mouse tab. Escape opens the pause menu and can't be rebound. Keys are matched by
|
||||
position, so they sit in the same place on any keyboard layout.
|
||||
|
||||
| Action | Default |
|
||||
|---|---|
|
||||
| Move | W A S D |
|
||||
| Jump; on the barge, leap; in the air, open the wing-sail | Space |
|
||||
| Crouch; in water, dive | Left Ctrl |
|
||||
| Sprint | Left Shift |
|
||||
| Use, fire, harvest or place | Left mouse |
|
||||
| Aim | Right mouse |
|
||||
| Reload | R |
|
||||
| Pick up or open a chest | E |
|
||||
| Drop the held item | G |
|
||||
| Boathook | 1 |
|
||||
| Inventory slots | 2 to 6 |
|
||||
| Build mode on and off | B |
|
||||
| In build mode: wall, floor, ramp, roof, breakwater | 1 to 5 |
|
||||
| In build mode: next material | Tab |
|
||||
| Chart (the full map) | M |
|
||||
|
||||
Gamepads aren't supported in this release.
|
||||
|
||||
## How a match goes
|
||||
|
||||
1. **The drop.** Everyone rides a sky barge across the island. Press jump to leap,
|
||||
steer with the move keys while you fall, and press jump again to open the wing-sail.
|
||||
It opens by itself near the ground. Anyone still aboard at the end of the route is
|
||||
thrown off.
|
||||
2. **Scavenge.** Fishing hamlets, docks, salt works, quarries, lighthouses and hilltop
|
||||
shrines hold weapons, ammunition and supplies, on the floor and in sea chests (E opens one).
|
||||
Washed-up crates on the beaches spill loot when broken.
|
||||
3. **Harvest.** Hit trees, rocks and wrecks with the boathook (slot 1, left mouse) for
|
||||
driftwood, stone and salvage iron.
|
||||
4. **Read the tide.** The sea rises in phases. Between rises it holds still, and the
|
||||
chart (M) and the minimap show where the next flood line will be. High ground is
|
||||
safe ground, and the last land is the highest land.
|
||||
5. **Build.** Walls, floors, ramps and roofs cost materials and snap to a grid. Iron is
|
||||
strongest but slowest to set; driftwood is quickest. A ring of **breakwaters** keeps
|
||||
the sea out of low ground for a while, until the water wears it down or someone
|
||||
breaks it. Pieces with nothing holding them up collapse.
|
||||
6. **Survive.** In shallow water you wade. In deep water you swim, which uses stamina,
|
||||
and you can't fire or build. Underwater you run out of breath and start to drown.
|
||||
After the last rise everyone left loses health until one remains.
|
||||
|
||||
Weapons come in four tiers: Rusted, Seaworthy, Brass-Fitted and Captain's. Bandages and
|
||||
tonic restore health; tar patches and cork vests add armor, which takes damage first.
|
||||
|
||||
## Your files
|
||||
|
||||
Settings and key bindings are saved in
|
||||
`~/.local/share/godot/app_userdata/Tidewall/settings.cfg` (under `$XDG_DATA_HOME` if
|
||||
you set it). Delete that file to go back to the defaults.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- **The menu says in red that it fell back to OpenGL.** Vulkan couldn't start. Install
|
||||
your GPU's Vulkan driver (`mesa-vulkan-drivers` on Debian for AMD and Intel, or the
|
||||
NVIDIA driver) to get the intended look. The game is fully playable either way.
|
||||
- **It starts on the wrong GPU.** See [Display servers and GPUs](#display-servers-and-gpus).
|
||||
- **No servers in the list.** LAN discovery uses UDP broadcasts on port 24651; some
|
||||
networks and firewalls block them. Join by address instead.
|
||||
- **A server is greyed out, marked "(another version)".** It runs a different release.
|
||||
Use the same release as the server.
|
||||
- **Run it from a terminal** to see its log: `./tidewall` prints engine messages there.
|
||||
|
||||
## Graphics presets
|
||||
|
||||
@@ -31,8 +151,10 @@ out paler under OpenGL than under Vulkan (issue #81).
|
||||
|
||||
To choose a renderer yourself:
|
||||
|
||||
./tidewall.x86_64 --rendering-method gl_compatibility # OpenGL
|
||||
./tidewall.x86_64 --rendering-method forward_plus # Vulkan (the default)
|
||||
./tidewall --rendering-method gl_compatibility --rendering-driver opengl3 # OpenGL
|
||||
./tidewall --rendering-method forward_plus --rendering-driver vulkan # Vulkan (the default)
|
||||
|
||||
These are the same options the capture tests use for each renderer.
|
||||
|
||||
## Display servers and GPUs
|
||||
|
||||
|
||||
+128
@@ -0,0 +1,128 @@
|
||||
# Running a Tidewall server
|
||||
|
||||
A Tidewall server is the game itself running headless. It needs no display, GPU or
|
||||
sound card. It runs matches back to back, fills empty places with bots, and logs one
|
||||
JSON object per line on standard output. With 24 bots it uses about 200 MB of memory
|
||||
and well under one CPU core.
|
||||
|
||||
Container and systemd details are in [packaging/README.md](../packaging/README.md).
|
||||
For playing, see [PLAY.md](PLAY.md).
|
||||
|
||||
## Quick start
|
||||
|
||||
From the release tarball (see [PLAY.md](PLAY.md#install)):
|
||||
|
||||
cd tidewall-0.9.0-linux-x86_64
|
||||
./tidewall-server --config=server.cfg
|
||||
|
||||
From the Debian package, copy the example configuration first:
|
||||
|
||||
cp /usr/share/doc/tidewall/examples/server.cfg .
|
||||
tidewall-server --config=server.cfg
|
||||
|
||||
The example takes players over UDP port 24650, answers LAN discovery on 24651, fills
|
||||
empty places with bots and answers a health check on TCP 24650 on loopback. Ctrl+C or
|
||||
SIGTERM stops it cleanly: everyone connected is told the server shut down, and it exits
|
||||
with code 0.
|
||||
|
||||
Check it is up:
|
||||
|
||||
curl -s http://127.0.0.1:24650/health
|
||||
|
||||
which answers with something like
|
||||
`{"max_players":24,"phase":"lobby","players":0,"status":"ok","tick":189,"uptime_s":7}`.
|
||||
|
||||
Check that a game can see it, from the same machine or the LAN:
|
||||
|
||||
./tidewall --headless --browse --lan-target=127.0.0.1
|
||||
|
||||
## Options
|
||||
|
||||
Every option works on the command line (`--port=24700`) or in a `--config` file (one
|
||||
per line, without the dashes: `port = 24700`, or a bare `listen`). Options on the
|
||||
command line after `--config` win over the file. A misspelt or unknown option stops the
|
||||
server with exit code 2 instead of running the wrong match.
|
||||
|
||||
| Option | Default | What it does |
|
||||
|---|---|---|
|
||||
| `listen` | off | Take players over the network. Without it the server plays a bot-only match. |
|
||||
| `port=N` | 24650 | UDP port for players. LAN discovery uses this port plus one. |
|
||||
| `bots=N` | 0 | Any number above 0 fills each match's empty places with bots. |
|
||||
| `bot-difficulty=` | `mixed` | `easy`, `normal`, `hard` or `mixed`. |
|
||||
| `name=NAME` | `Tidewall server` | The name shown in server lists. |
|
||||
| `list=HOST[:PORT]` | none | Register with a list server, so people off your LAN can find you. Can be given more than once. |
|
||||
| `no-lan` | off | Don't answer LAN discovery. |
|
||||
| `seed=N` | random | The first island. Later islands follow from it, so a whole session can be replayed. |
|
||||
| `health-port=N` | 0 (none) | Answer `GET /health` on this TCP port. |
|
||||
| `health-bind=ADDRESS` | `127.0.0.1` | Where the health check listens. |
|
||||
| `log-every=N` | 0 | A progress line every N ticks (30 a second). |
|
||||
| `matches=N` | 0 | Stop after N matches. 0 runs until stopped. |
|
||||
| `ticks=N` | 0 | Stop after N ticks. 0 runs until stopped. |
|
||||
| `config=PATH` | none | Read options from a file. |
|
||||
|
||||
The full list, including options for tests, is in
|
||||
[`src/server/server_config.gd`](../src/server/server_config.gd).
|
||||
|
||||
## Ports and firewalls
|
||||
|
||||
| Port | Protocol | What | Open to players? |
|
||||
|---|---|---|---|
|
||||
| 24650 | UDP | Game traffic (`port`) | Yes |
|
||||
| 24651 | UDP | LAN discovery and list-server replies (`port` + 1) | On the LAN, if you want to be found |
|
||||
| 24650 | TCP | Health check (`health-port`), loopback only by default | No |
|
||||
| 24660 | UDP | A list server, if you run one | Yes, for that machine |
|
||||
|
||||
Players behind the same router as the server can join by its LAN address. Players on
|
||||
the internet need UDP 24650 forwarded to the server.
|
||||
|
||||
## Being found
|
||||
|
||||
- **On the LAN** the game's Join menu finds the server by broadcast, unless `no-lan` is
|
||||
set. Docker's default bridge network doesn't pass broadcasts; see
|
||||
[packaging/README.md](../packaging/README.md).
|
||||
- **Beyond the LAN**, run a list server somewhere reachable and register game servers
|
||||
with it:
|
||||
|
||||
./tidewall --headless --list-server --port=24660
|
||||
./tidewall-server --config=server.cfg --list=lists.example.org:24660 --name="Harbour"
|
||||
|
||||
Check it with `./tidewall --headless --browse --list=lists.example.org:24660`. In
|
||||
this release the game's Join menu only searches the LAN, so players outside it still
|
||||
join by address; the menu doesn't ask list servers yet.
|
||||
- **By address** always works: players type `host:port` in the Join menu, or start with
|
||||
`./tidewall --connect=host:24650`.
|
||||
|
||||
## Logs
|
||||
|
||||
Each line is one JSON object with an `event`, the `seed` and a timestamp `t_ms`. The
|
||||
first line, `start`, records every setting needed to reproduce the run. `stopping` and
|
||||
`stop` end it; `stop` carries the exit code and the number of errors. Pipe the log
|
||||
through `jq` to read it, or keep it as is for a log collector. Exit codes: 0 clean, 1 a
|
||||
script or engine error, 2 a bad command line.
|
||||
|
||||
## Docker, Compose and systemd
|
||||
|
||||
`packaging/docker/compose.yaml` runs the server as a read-only, unprivileged container
|
||||
with a health check:
|
||||
|
||||
cd packaging/docker
|
||||
docker compose up -d
|
||||
|
||||
`packaging/systemd/tidewall-server.service` runs it as a hardened systemd service.
|
||||
[packaging/README.md](../packaging/README.md) explains both, and `make
|
||||
server-package-check` tests the container from build to clean stop.
|
||||
|
||||
## Memory
|
||||
|
||||
The launchers set `MALLOC_ARENA_MAX=1` unless it is already set. Without it, memory
|
||||
grew about 28 MB a match for as long as the server ran. If you start the engine
|
||||
binary yourself instead of through `tidewall-server`, set it too.
|
||||
|
||||
## How this was checked
|
||||
|
||||
Each command on this page was run from an unpacked 0.9.0 release outside the source
|
||||
tree, with its own home directory, on 2026-11-14: the server from `server.cfg`, the
|
||||
health check, `--browse` on the LAN and through a list server, a headless game joining
|
||||
and playing through the drop, and a clean SIGTERM stop with exit code 0. The Debian
|
||||
package paths are checked by `make deb-check` and the container by `make
|
||||
server-package-check`.
|
||||
@@ -3,10 +3,9 @@
|
||||
tidewall \- build-and-survive battle royale on a drowning island
|
||||
.SH SYNOPSIS
|
||||
.B tidewall
|
||||
.RB [ \-\-rendering\-driver
|
||||
.IR driver ]
|
||||
.RB [ \-\-
|
||||
.IR "game options" ]
|
||||
.RI [ "engine options" ]
|
||||
.RB [ \-\- ]
|
||||
.RI [ "game options" ]
|
||||
.SH DESCRIPTION
|
||||
.B tidewall
|
||||
starts the game on its main menu: practice offline against bots, find a
|
||||
@@ -14,13 +13,14 @@ server on the local network, or join one by address. The sea rises in phases
|
||||
and swallows the low ground; gather salvage, build, and be the last one
|
||||
standing.
|
||||
.PP
|
||||
Options before
|
||||
.B \-\-
|
||||
go to the Godot engine; options after it go to the game.
|
||||
The game's own options below may be given on their own or after
|
||||
.BR \-\- ;
|
||||
any other option goes to the Godot engine.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BI \-\-rendering\-driver " opengl3"
|
||||
Use OpenGL instead of Vulkan, for hardware without a Vulkan driver.
|
||||
.B \-\-rendering\-method gl_compatibility \-\-rendering\-driver opengl3
|
||||
Use OpenGL instead of Vulkan, for hardware without a Vulkan driver. The game also
|
||||
falls back to OpenGL by itself when Vulkan can't start.
|
||||
.TP
|
||||
.BI \-\-connect= host[:port]
|
||||
Join a server directly (the port defaults to 24650).
|
||||
|
||||
Vendored
+3
-1
@@ -18,7 +18,9 @@ the entry away. On Debian or Ubuntu, the `.deb` package does all of this system-
|
||||
|
||||
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.
|
||||
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/`.
|
||||
|
||||
|
||||
Vendored
+2
-1
@@ -1,5 +1,6 @@
|
||||
#!/usr/bin/env sh
|
||||
# Starts Tidewall from wherever this folder is, whatever the current directory, and
|
||||
# through a symlink too. Options are passed to the game (e.g. --rendering-driver opengl3).
|
||||
# through a symlink too. Options are passed to the game (e.g. --connect=HOST, or
|
||||
# --rendering-method gl_compatibility --rendering-driver opengl3).
|
||||
here="$(dirname "$(readlink -f "$0")")"
|
||||
exec "$here/tidewall.x86_64" "$@"
|
||||
|
||||
@@ -41,6 +41,28 @@ var asked: bool = false
|
||||
var errors: Array[String] = []
|
||||
|
||||
|
||||
## Every option parse() knows, by name.
|
||||
const OPTIONS: Array[String] = [
|
||||
"--offline", "--autoplay", "--browse", "--list", "--lan-port", "--lan-target",
|
||||
"--connect", "--name", "--seed", "--bots", "--client-seconds",
|
||||
]
|
||||
|
||||
|
||||
## The game's own options from the command line. Godot hands the options after "--" to
|
||||
## the game (`user`); a player who leaves the "--" out, as in `tidewall --connect=HOST`,
|
||||
## has them among the engine's options (`all`) instead, so then the ones this class
|
||||
## knows are taken from there. The engine's own options, such as --headless, are left
|
||||
## alone. With options after "--", those alone count.
|
||||
static func game_args(user: PackedStringArray, all: PackedStringArray) -> PackedStringArray:
|
||||
if not user.is_empty():
|
||||
return user
|
||||
var found: PackedStringArray = PackedStringArray()
|
||||
for arg: String in all:
|
||||
if OPTIONS.has(arg.split("=", true, 1)[0]):
|
||||
found.append(arg)
|
||||
return found
|
||||
|
||||
|
||||
static func parse(args: PackedStringArray) -> ClientConfig:
|
||||
var config: ClientConfig = ClientConfig.new()
|
||||
for arg: String in args:
|
||||
|
||||
+3
-2
@@ -31,14 +31,15 @@ func _ready() -> void:
|
||||
if config.server:
|
||||
add_child(HeadlessServer.new(config))
|
||||
return
|
||||
_config = ClientConfig.parse(args)
|
||||
_config = ClientConfig.parse(ClientConfig.game_args(OS.get_cmdline_user_args(), OS.get_cmdline_args()))
|
||||
if not _config.is_valid():
|
||||
for problem: String in _config.errors:
|
||||
printerr("tidewall: " + problem)
|
||||
get_tree().quit(2)
|
||||
return
|
||||
if DisplayServer.get_name() == "headless" and not _config.asked:
|
||||
print("Tidewall")
|
||||
print("Tidewall: without a window, ask for --offline, --connect=HOST[:PORT] or --browse")
|
||||
get_tree().quit(0)
|
||||
return
|
||||
if _config.browse:
|
||||
_start_browsing()
|
||||
|
||||
@@ -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)
|
||||
|
||||
Reference in New Issue
Block a user