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:
+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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user