H2: Graphics presets, OpenGL fallback notice, tested configurations
Presets now tune shadows, cascades, render scale and anti-aliasing: Low (no shadows, 75%, FXAA), Medium (200 m, 2 cascades, FXAA), High (400 m, 4 cascades, MSAA 2x). GameSettings.apply_to_viewport sets the viewport; MatchView.apply_settings sets the sun's cascades. No preset changes how far props or pieces are drawn, so a lower one never shows a player through cover; a test guards it. When Vulkan can't start, Godot falls back to OpenGL (fallback_to_opengl3) and RendererCheck has the main menu say so. tools/capture.sh gains CAPTURE_RENDERER=no_vulkan, which hides the Vulkan driver and expects the fallback. New scenarios quality_low/medium/high draw a match moment with each preset, reviewed in both renderers. docs/PLAY.md lists the presets, renderers, Wayland and hybrid-GPU notes, and the tested configurations, marking each as software-rendered only or not tested. Closes #55 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,71 @@
|
||||
# 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).
|
||||
|
||||
## Graphics presets
|
||||
|
||||
Settings → Graphics → Quality.
|
||||
|
||||
| Preset | Sun shadows | Shadow cascades | 3D resolution | Anti-aliasing |
|
||||
|---|---|---|---|---|
|
||||
| Low | Off | n/a | 75% of the window | FXAA |
|
||||
| Medium | Up to 200 m | 2 | 100% | FXAA |
|
||||
| High (default) | Up to 400 m | 4 | 100% | MSAA 2x |
|
||||
|
||||
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. Known difference: with shadows on (Medium, High) the ground and rocks come
|
||||
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)
|
||||
|
||||
## 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. Paler ground with shadows on (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
|
||||
Reference in New Issue
Block a user