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