Eric chose option B on #72. The drop is now the GDD's launch: - A packet ship sails a seeded straight line past the island, offshore, as close in as it can while keeping 45 m of open water from any land (eight-way probes; up to 32 headings, then the four world sides). - Jump fires the lifeline mortar along the look heading. How high the player aims sets the charge (-10 to 45 degrees: 16 to 110 m/s over the ground; every shot climbs at 75 m/s). The climb can't be steered and the kite can't open until the arc tops out. Riders still aboard at the end are fired towards the middle of the island. - Drop.reach() mirrors the fall for both ways down (kite at the top, or a fall with the kite opening by itself); bots, the soak and autoplay clients and the tutorial pilot aim with Drop.aim_charge(). - Bots fire at their landing spot once abeam of it, when in easy reach at their own staggered moment, or just before the route ends, and open the kite early only when the spot is beyond the rest of a fall. - Art: VesselModels.ship() (two-masted packet, tanned square sails, a salt-white boot-top, a bowsprit and the mortar on its bed, mirrored to face the island), the figure's gull-kite (figure.py), and a lifeline cord from the muzzle to each player still climbing. - Renamed barge to ship and wing-sail to gull-kite throughout code, tests, captures, docs and the tutorial text. make match now defaults to seed 2, where the scripted player still harvests and builds. Closes #72 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
285 lines
15 KiB
Markdown
285 lines
15 KiB
Markdown
# Playing Tidewall on Linux
|
|
|
|
Tidewall is a free and open-source build-and-survive battle royale. Up to 24 players
|
|
and bots fire themselves from a packet ship 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-1.0.0-linux-x86_64.tar.gz.sha256
|
|
tar xzf tidewall-1.0.0-linux-x86_64.tar.gz
|
|
cd tidewall-1.0.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_1.0.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 `1.0.0` with the version you downloaded.
|
|
|
|
## Starting a match
|
|
|
|
The first time, the game offers the tutorial; after that it opens on its main menu.
|
|
|
|
- **Tutorial** is a few minutes on an island of your own: fire yourself off the ship and glide
|
|
down, walk and jump, cut materials with the boathook, build a wall, fire the dock
|
|
carbine you start with, and get above the line the tide will reach. A card under the
|
|
minimap says what to do with your own keys and moves on when you've done it. Nobody
|
|
else is there, so only the tide can end it. Leave it whenever you like from the pause
|
|
menu (Escape).
|
|
- **Practice** plays offline against bots on an island of its own. No network needed.
|
|
Crew picks solo or duos, with a bot as your crewmate.
|
|
- **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 --tutorial # the tutorial
|
|
./tidewall --offline # practice against 23 bots
|
|
./tidewall --offline --bots=5 --seed=42 # fewer bots, a chosen island
|
|
./tidewall --offline --duos # duos, with the first bot as your crewmate
|
|
./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.
|
|
|
|
### Duos
|
|
|
|
In duos you play in a crew of two, on a server started with `--team-size=2` or in
|
|
practice. Crewmates can't hurt each other, with any weapon or keg.
|
|
|
|
- When your health runs out while your crewmate is still standing, you go **down**
|
|
instead of out. You crawl, slowly, and can't fire, build, loot or use anything. Your
|
|
health becomes 60 to bleed, one point every half second, and hits still take it.
|
|
- Your crewmate hauls you up by standing beside you (within 2 m) and holding **Pick
|
|
up** (E) for 6 seconds without a break. You get up with 30 health.
|
|
- You're out when you bleed out, when you're finished off, or when your crewmate goes
|
|
down or out too: a crew with nobody standing is eliminated, and both share its place.
|
|
- Drowning still takes a downed player, and faster than bleeding.
|
|
|
|
## Controls
|
|
|
|
Every key can be rebound in Settings → Controls. Mouse sensitivity and inversion are on
|
|
the Mouse tab. A gamepad works too (below). 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 ship, fire the mortar; in the air, open the gull-kite | 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 |
|
|
|
|
### Gamepad
|
|
|
|
A gamepad works alongside the keyboard and mouse, with one fixed layout (listed in
|
|
Settings → Gamepad). Buttons are named by position, so they sit the same on any pad:
|
|
South is A on most pads.
|
|
|
|
| Action | Gamepad |
|
|
|---|---|
|
|
| Move | Left stick |
|
|
| Look | Right stick |
|
|
| Sprint (until you stop) | Click the left stick |
|
|
| Jump, fire the mortar, open the gull-kite | South (A) |
|
|
| Crouch, dive | East (B) |
|
|
| Reload | West (X) |
|
|
| Pick up or open a chest | North (Y) |
|
|
| Use, fire, harvest or place | Right trigger |
|
|
| Aim | Left trigger |
|
|
| Next / previous slot, or piece in build mode | Right / left bumper |
|
|
| Build mode on and off | Click the right stick |
|
|
| In build mode: next / previous material | D-pad right / left |
|
|
| Chart | D-pad up |
|
|
| Drop the held item | D-pad down |
|
|
| Pause menu | Start |
|
|
|
|
In the menus the D-pad or the left stick moves between controls, South chooses and East
|
|
or Start goes back. Settings → Gamepad sets the stick's look speed and turns **aim
|
|
assist** on or off (on by default). Aim assist only works with the stick, never the
|
|
mouse, and only on an opponent in plain sight close to where you already look: the
|
|
stick turns more slowly across them, and while aiming the view eases towards them, by
|
|
at most 9° a second. It moves your view only, as your thumb would; the server judges
|
|
every shot the same way. Speed while aiming and Invert on the Mouse tab apply to the
|
|
stick too. The tutorial names pad buttons once you use the pad.
|
|
|
|
Gamepads were tested with simulated input only; no physical pad has been tried yet.
|
|
|
|
## Accessibility
|
|
|
|
Settings → Access:
|
|
|
|
- **Colour vision.** Standard, Red-green (protan, deutan) or Blue-yellow (tritan).
|
|
Changes the build preview's allowed and refused colours, danger marks (the tide's
|
|
next line, low health, "not enough") and your own marks (the tide gauge pointer, your
|
|
lines in the feed) to colours that stay apart for that kind of colour blindness.
|
|
Nothing in the HUD relies on colour alone in any set: there are words, numbers and
|
|
patterns too.
|
|
- **Interface size.** 90%, 100%, 115% or 130%: menus and HUD drawn larger or smaller.
|
|
At the larger sizes the hotbar moves beside the health panel and its slots narrow.
|
|
- **Captions for sounds.** Names the sounds that matter, and which way they came from
|
|
(ahead, left, right, behind): the tide's foghorn, bell, surges and lighthouse,
|
|
gunfire, shots striking someone, keg blasts, footsteps within 20 m, building and
|
|
breaking, splashes, and being hit. Your own sounds aren't captioned.
|
|
- **Reduce motion.** Aiming zooms in less (62° rather than 48° of view) and more
|
|
slowly, and the flash at the screen's edge when you're hurt is gentler. Tidewall has
|
|
no camera shake or head bob.
|
|
|
|
## How a match goes
|
|
|
|
1. **The drop.** Everyone rides a packet ship that sails past the island, offshore.
|
|
Face where you want to land and press jump to fire yourself inland by lifeline
|
|
mortar: aim level for the shore, and look higher to carry further, up to the far
|
|
side of the island. The climb can't be steered. Over the top of the arc, steer with
|
|
the move keys and press jump again to open the gull-kite; it opens by itself near the
|
|
ground. Anyone still aboard at the end of the route is fired towards the middle.
|
|
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.
|
|
|
|
**Powder kegs** are thrown with fire. One lands, lies there and blows three seconds
|
|
after the throw, hurting everyone in sight within six metres (you too, a little less)
|
|
and smashing built pieces, props and breakwaters. Cover between you and the keg
|
|
protects you.
|
|
|
|
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
|
|
|
|
Settings → Graphics → Quality.
|
|
|
|
| Preset | Sun shadows | Shadow cascades | 3D resolution | Anti-aliasing | Effect particles |
|
|
|---|---|---|---|---|---|
|
|
| Low | Off (and off on every preset under OpenGL) | n/a | 75% of the window | FXAA | 256 at once |
|
|
| Medium | Up to 200 m | 2 | 100% | FXAA | 512 |
|
|
| High (default) | Up to 400 m | 4 | 100% | MSAA 2x | 1,024 |
|
|
|
|
The particle budget only limits how much smoke, dust and spray a big fight shows at
|
|
once. Muzzle flashes, tracers, hit flashes and the hit marker are there on every preset.
|
|
|
|
No preset changes how far trees, rocks, wrecks or built pieces are drawn. A lower
|
|
preset never lets anyone see a player through cover that a higher one would still
|
|
draw. The woodcut ink lines are a separate switch on the same tab.
|
|
|
|
`make bench` counts what a frame asks of the GPU, with High's shadows. The measured numbers are in
|
|
[ARCHITECTURE.md](ARCHITECTURE.md#performance-budgets) and the DEVLOG.
|
|
|
|
## Renderers
|
|
|
|
Tidewall is made for Godot's **Forward+** renderer on **Vulkan**. If Vulkan can't start
|
|
(no Vulkan driver, or a GPU too old for it), the game falls back to **OpenGL**
|
|
(Godot's Compatibility renderer) rather than crashing. The main menu then says so in
|
|
red under the motto. Everything works there, but the light, fog and sea look a little
|
|
different. **Under OpenGL the sun casts no shadows, on every preset** (the presets'
|
|
other settings still apply). Godot's Compatibility renderer draws a shadowed sun in
|
|
a pass of its own and adds it to the picture after the picture is already converted
|
|
for the screen (sRGB), so sunlit ground and rocks came out pale and washed out
|
|
(issue #81). No setting in the engine avoids that, so the game turns those shadows
|
|
off rather than show wrong colours. The `sun_probe` and `sun_shadow_probe` capture
|
|
scenarios show the difference, to recheck after an engine upgrade.
|
|
|
|
To choose a renderer yourself:
|
|
|
|
./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
|
|
|
|
- **X11:** the default.
|
|
- **Wayland:** by default the game runs through XWayland, which every Wayland desktop
|
|
provides. To try Godot's native Wayland support, start it with
|
|
`--display-driver wayland`.
|
|
- **Hybrid graphics (a laptop or desktop with an integrated and a discrete GPU):**
|
|
Godot's Vulkan renderer prefers the discrete GPU on its own. If the game still starts
|
|
on the integrated one, run it with the driver's offload variables, for example
|
|
`__NV_PRIME_RENDER_OFFLOAD=1 __GLX_VENDOR_LIBRARY_NAME=nvidia ./tidewall.x86_64` on
|
|
NVIDIA, or `DRI_PRIME=1 ./tidewall.x86_64` on Mesa. `--gpu-index N` picks a Vulkan
|
|
device by number.
|
|
|
|
## Tested configurations
|
|
|
|
Be careful reading this table. The automated tests run in a container with **software
|
|
rendering only**. They show that the game starts, draws the right picture and falls back
|
|
correctly. They say nothing about frame rates or how it feels on real hardware. That
|
|
is checked in the hands-on playtest (R6), and this table will be updated from it.
|
|
|
|
| Configuration | Renderer | How it was tested | Result |
|
|
|---|---|---|---|
|
|
| Debian 13, Xvfb (X11), Mesa Lavapipe | Forward+ / Vulkan | Software only: every capture, all three presets (`quality_*` captures) | Draws correctly |
|
|
| Debian 13, Xvfb (X11), Mesa llvmpipe | Compatibility / OpenGL | Software only: all three presets | Draws correctly, with no sun shadows (see above) |
|
|
| Debian 13, Xvfb (X11), no Vulkan driver | Falls back to OpenGL | Software only: `CAPTURE_RENDERER=no_vulkan` capture of the main menu | Falls back and shows the notice |
|
|
| Release package outside the repo, headless | None (server and autoplay client) | `make dist-check` | Plays a full match; the game joins its server |
|
|
| Wayland (native or XWayland) | Any | **Not tested** | Unknown |
|
|
| Real NVIDIA, AMD or Intel GPU | Forward+ / Vulkan | **Not tested yet** (R6) | Unknown |
|
|
| Hybrid NVIDIA and Intel desktop | Any | **Not tested yet** (R6) | Unknown |
|
|
|
|
To reproduce the software-rendered rows:
|
|
|
|
CAPTURE_RENDERER=forward_plus tools/capture.sh quality_high captures/q.png
|
|
CAPTURE_RENDERER=compatibility tools/capture.sh quality_low captures/q.png
|
|
CAPTURE_RENDERER=no_vulkan tools/capture.sh menu_main captures/m.png
|