diff --git a/Makefile b/Makefile index e42ef7e..ad86668 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ # Tidewall build entry points. Everything runs headless with the repo-local engine. GODOT := tools/godot.sh -.PHONY: effects-captures app-icon deb deb-check bench dist dist-check build-captures poi-captures art figure figure-captures sea-captures models item-captures audio audio-check check import parse test test-selfcheck smoke capture-test terrain-capture binaries verify-engine balance bot-matches match match-captures client-check client-captures hud-captures style-captures menu-captures chart-captures discovery-check fuzz stability soak soak-selfcheck server-package-check +.PHONY: qa-captures effects-captures app-icon deb deb-check bench dist dist-check build-captures poi-captures art figure figure-captures sea-captures models item-captures audio audio-check check import parse test test-selfcheck smoke capture-test terrain-capture binaries verify-engine balance bot-matches match match-captures client-check client-captures hud-captures style-captures menu-captures chart-captures discovery-check fuzz stability soak soak-selfcheck server-package-check ## A8: regenerates every sound in assets/audio/ from tools/audio/ (about 6 s). audio: import @@ -43,6 +43,11 @@ item-captures: import ## A7: renders the visual effects: a hit over the shoulder, a keg blast and collapse, the ## quieter effects, and the stress scene at the largest budget (about 6 min). +## H6: every capture scenario, the HUD at 4K and contact sheets (captures/qa/, about +## 40 min). Needs Docker. Judge each against docs/VISUAL_QA.md. +qa-captures: import + @tools/qa_captures.sh + effects-captures: import @for stage in fight blast work stress; do tools/capture.sh effects_$$stage captures/effects_$$stage.png; done diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 9708bda..208800e 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -490,7 +490,9 @@ water, surges). Its particles are simulated on the CPU in packed arrays and draw two MultiMeshes (blended and added) of camera-facing quads, sized per instance by a small shader, with tracers as a third; everything is allocated once at the preset's budget, so a big fight costs a fixed three draw calls and never adds nodes or grows buffers. -The figures, barge and items are stand-in shapes for the art pass to replace. +The figure (`FigureRig`), items (`ItemModels`) and barge and chests (`VesselModels`) are +the generated art described in assets/PROVENANCE.md; `test_world_art` fails on any +primitive stand-in mesh. In play, the simulation it reads is the client's own copy of the world: the `Simulation` that `ClientGame` generates from the match's seed and never steps. diff --git a/docs/VISUAL_QA.md b/docs/VISUAL_QA.md new file mode 100644 index 0000000..e44099c --- /dev/null +++ b/docs/VISUAL_QA.md @@ -0,0 +1,53 @@ +# Visual QA + +The checklist for a full visual pass (H6). Render everything with `make qa-captures` +(about 40 minutes, needs Docker), open every image in `captures/qa/` and judge it +against its line here. The contact sheets in `captures/qa/sheets/` are for a first +look; open a capture on its own to judge detail. File each defect as a `type/bug` +issue. + +Captures are drawn by Mesa's software renderer in a container. They show what is drawn, +not how fast, and colours differ a little from a GPU. + +The white captions at the top left of the `match_*`, `client_*`, `quality_*` and +`hud`/`client_hud*` captures are written by the capture scenarios (Godot's default +font) to say what the frame is. They are not part of the game's HUD. + +## The last pass: 2026-11-14 + +82 scenarios and the HUD at 3840x2160 rendered; all were viewed. Two defects were +found and fixed: + +- H15 (#84): a camera placed after the view's last sync kept the murk of where it had + been. `match_tide` came out as a flat teal frame, and `match_final` and + `match_results` drew dry land in the underwater murk. In the game this was one frame + of the wrong murk at every camera cut. +- H16 (#85): the terrain grid's square edge showed in the sea from the air, as a pale + square round the island in the lobby view. + +## Checklist + +| Area | Captures | What to check | 2026-11-14 | +|---|---|---|---| +| Menus | `menu_main`, `menu_practice`, `menu_join`, `menu_settings`, `menu_settings_mouse`, `menu_pause`, `menu_results` | Paper panels over the sea and tide post; every label readable; the version line; focus outline on the first button; nothing clipped. | Pass | +| Lobby | `match_lobby` | The whole island from the air, sea round it with no square edge. | Pass after H16 | +| The drop | `match_barge`, `client_barge`, `match_glide`, `client_glide`, `vessels` | The sky barge and its 24 passengers; the wing-sail held overhead; the island below. | Pass | +| Landing | `match_landed`, `client_landed`, `quality_low`, `quality_medium`, `quality_high` | The player on the shoulder camera, a sea chest, a building's inside. The three presets differ in shadow and detail, not in what's there. | Pass | +| Biomes | `props_beach`, `props_forest`, `props_highland`, `props_overview`, `props_crate`, `props_felled`, `terrain`, `terrain_lod`, `sea_shore_calm` | Sand with wet patches and beached boats, pine forest, highland stone and boulders, the marsh flats at low tide. | Pass | +| Points of interest | `poi_hamlet`, `poi_dock`, `poi_lighthouse`, `poi_quarry`, `poi_salt_works`, `poi_shrine`, `style_*` | Each reads as its place; the woodcut print pass (outlines, hatching) on, and off in the `_plain` captures. | Pass | +| Building | `build_fort`, `build_fort_side`, `build_states`, `client_build`, `client_build_refused`, `client_hud_build`, `match_built`, `client_basin` | Every material and state; the ghost green when it can go and red with the reason when it can't; a breakwater basin dry inside at high water. | Pass | +| Players and items | `figure_states`, `figure_actions`, `figure_close`, `items_held`, `items_shoulder`, `items_ground`, `items_tiers`, `items_kegs` | Coats in every colour, every pose, items in hand and on the ground, tier marks. | Pass | +| Combat | `effects_fight`, `effects_blast`, `effects_work`, `effects_stress` | Muzzle flash at the muzzle, the hit marker round the reticle, the keg blast and collapse dust, tracers in the stress scene. | Pass | +| HUD | `client_hud`, `hud_2160` (`CAPTURE_SIZE=3840x2160`) | Tide plaque, health and armour, the six slots, materials, the feed and count, crisp at 4K. | Pass | +| Chart | `chart_first`, `chart_later` | Place names, the barge's line, the next tide's land hatched, the minimap. | Pass | +| Each tide phase | `sea_tide_0` … `sea_tide_7`, `water_flood`, `water_shore` | The sea rising phase by phase to nothing left; the storm building to a gale with rain; flooding following the terrain. | Pass | +| The gale and under water | `sea_shore_gale`, `sea_underwater`, `match_final` | Rain, dark sea and whitecaps; the murk and the bright ceiling only when the camera is under the sea. | Pass after H15 | +| Results | `match_tide`, `match_results` | The drowned island from the lobby's viewpoint; the last players on the highest ground. | Pass after H15 | +| Camera tests | `camera`, `camera_aim`, `camera_wall`, `canopy`, `canopy_before` | Test cards for the camera rig, drawn with plain shapes on purpose; check the framing, not the art. | Pass | +| Terrain tests | `terrain_cracks`, `terrain_cracks_control` | Magenta shows through gaps: the control must crack and the real terrain must not. | Pass | + +## Placeholders + +Nothing the game draws is a stand-in. `test_world_art` fails on any primitive mesh or +placeholder resource under `src/` or `assets/`. The plain shapes in the `camera*` +scenarios are test cards under `test/capture/`, which isn't shipped. diff --git a/tools/contact_sheet.gd b/tools/contact_sheet.gd new file mode 100644 index 0000000..4adb718 --- /dev/null +++ b/tools/contact_sheet.gd @@ -0,0 +1,44 @@ +## Lays out the PNGs in a directory as contact sheets of four, in name order, left to +## right then top to bottom, for reviewing a whole capture pass (H6). It prints which +## captures each sheet holds; open a capture on its own to judge detail. +## tools/godot.sh --script res://tools/contact_sheet.gd -- --dir=res://captures/qa --out=res://captures/qa/sheets +extends SceneTree + +const CELL: Vector2i = Vector2i(960, 540) + + +func _init() -> void: + var dir: String = "res://captures/qa" + var out: String = dir + "/sheets" + for arg: String in OS.get_cmdline_user_args(): + if arg.begins_with("--dir="): + dir = arg.substr(6) + elif arg.begins_with("--out="): + out = arg.substr(6) + DirAccess.make_dir_recursive_absolute(ProjectSettings.globalize_path(out)) + var names: Array[String] = [] + for name: String in DirAccess.get_files_at(dir): + if name.ends_with(".png") and not name.begins_with("hud_2160"): + names.append(name) + names.sort() + var sheets: int = 0 + for first: int in range(0, names.size(), 4): + var sheet: Image = Image.create(CELL.x * 2, CELL.y * 2, false, Image.FORMAT_RGB8) + sheet.fill(Color.BLACK) + for index: int in range(first, mini(first + 4, names.size())): + var image: Image = Image.load_from_file(ProjectSettings.globalize_path(dir.path_join(names[index]))) + if image == null: + push_error("contact sheet: can't read %s" % names[index]) + quit(1) + return + image.convert(Image.FORMAT_RGB8) + image.resize(CELL.x, CELL.y, Image.INTERPOLATE_BILINEAR) + var slot: int = index - first + sheet.blit_rect(image, Rect2i(Vector2i.ZERO, CELL), Vector2i(slot % 2 * CELL.x, slot / 2 * CELL.y)) + var path: String = out.path_join("sheet_%02d.png" % sheets) + sheet.save_png(ProjectSettings.globalize_path(path)) + var listed: PackedStringArray = PackedStringArray(names.slice(first, first + 4)) + print("%s: %s" % [path, ", ".join(listed)]) + sheets += 1 + print("contact sheets: %d from %d captures" % [sheets, names.size()]) + quit(0) diff --git a/tools/contact_sheet.gd.uid b/tools/contact_sheet.gd.uid new file mode 100644 index 0000000..07a2f4e --- /dev/null +++ b/tools/contact_sheet.gd.uid @@ -0,0 +1 @@ +uid://b6d8qic0yo1qt diff --git a/tools/qa_captures.sh b/tools/qa_captures.sh new file mode 100755 index 0000000..cd43729 --- /dev/null +++ b/tools/qa_captures.sh @@ -0,0 +1,29 @@ +#!/usr/bin/env bash +# H6: renders every capture scenario in test/capture/ to captures/qa/.png, one +# container at a time, plus the HUD at 3840x2160, and writes contact sheets of four to +# captures/qa/sheets/. Waits while the host has under 1.5 GB of memory available. +# Plays `make match` first, since the match_* scenarios replay its log. Needs Docker. +# About 40 minutes. Open every image and judge it against docs/VISUAL_QA.md. +set -uo pipefail +cd "$(dirname "${BASH_SOURCE[0]}")/.." +mkdir -p captures/qa +nice -n 15 make match >/dev/null 2>&1 || { echo "qa-captures FAIL: make match"; exit 1; } +status=0 +for path in test/capture/*.tscn; do + scene="$(basename "$path" .tscn)" + [[ "$scene" == blank || "$scene" == smoke ]] && continue + while (( $(awk '/MemAvailable/ {print int($2 / 1024)}' /proc/meminfo) < 1500 )); do + echo "qa-captures: waiting for memory" + sleep 30 + done + if tools/capture.sh "$scene" "captures/qa/$scene.png" >"captures/qa/$scene.log" 2>&1; then + echo "ok $scene" + else + echo "FAIL $scene (captures/qa/$scene.log)" + status=1 + fi +done +CAPTURE_SIZE=3840x2160 tools/capture.sh client_hud captures/qa/hud_2160.png >/dev/null 2>&1 || { echo "FAIL hud_2160"; status=1; } +tools/godot.sh --script res://tools/contact_sheet.gd -- --dir=res://captures/qa --out=res://captures/qa/sheets || status=1 +[[ "$status" -eq 0 ]] && echo "qa-captures: ok (captures/qa, sheets in captures/qa/sheets)" +exit "$status"