Files
aevolution/docs/engineering/CLIENT_DEPENDENCIES.md
T

70 lines
3.6 KiB
Markdown

# M9.1 native client dependency probe
Decision: [ADR-0077](../adr/0077-scoped-native-client-dependencies.md). This is an
isolated dependency evaluation, not `evo-client`, gameplay or the M9.2 renderer.
SDL 3.4.16 provides window/events and a thin 2D renderer. Direct Vulkan and SDL_GPU
remain alternatives if measured workloads outgrow it. Audio and player UI are deferred.
## Reproduce
In a C++23 developer shell with CMake 3.28+ and Ninja:
```sh
cmake -P tools/prepare-sdl3.cmake
cmake --preset client-probe
cmake --build --preset client-probe --parallel 4
ctest --preset client-probe --no-tests=error
./build/client-probe/evo-client-probe
./build/client-probe/evo-client-probe --renderer vulkan
```
Windows executables have `.exe`. CTest uses SDL's dummy window driver and software
renderer for deterministic rectangle/background pixel checks. The standalone run
uses the native video driver and reports the actual renderer. The window is hidden
and the process exits after one checked frame; no persistent desktop window is left.
An explicitly requested missing renderer must fail, not silently fall back.
Synthetic keyboard injection proves event plumbing, not physical input/focus behavior.
Linux desktop builds require SDL's documented X11/Wayland development packages.
The `ci-client` Docker stage installs the X11 subset and runs a window probe under
Xvfb, in addition to dummy-driver CTests. It does not require a GPU or cluster.
For a CI host without these, explicitly add `-DSDL_UNIX_CONSOLE_BUILD=ON
-DSDL_X11=OFF -DSDL_WAYLAND=OFF`. That configuration proves software/offscreen
behavior only. Do not use it to claim Linux desktop-window qualification.
Offline preparation from a previously downloaded archive:
```sh
cmake -DSDL_ARCHIVE=/absolute/path/SDL3-3.4.16.tar.gz -P tools/prepare-sdl3.cmake
```
The script checks the archive before extraction. Sources go under ignored
`build/external/sdl3/`; configuration consumes only prepared sources and refuses
a missing/mismatched preparation marker. Treat that directory as an immutable
local dependency checkout; edits there invalidate qualification. Delete/reprepare
it explicitly for a clean rebuild. No network access occurs during configuration.
## Ownership, licensing and updates
- Machine-readable release URL/version/hash: `tools/sdl3-pin.cmake`.
- Owner: client/platform engineering. Upgrade by reviewing upstream release and
security changes, updating version/hash, preparing fresh sources and rerunning
Windows/Linux probes, analysis and package measurements.
- SDL's zlib notice is retained in `third_party/SDL3/LICENSE.txt`; the complete
upstream archive retains bundled component notices. No claim is made that SDL
license review licenses the game itself. Binary release packaging must retain
applicable third-party notices and audit enabled backend/system dependencies.
- Shared SDL is linked only by `evo-client-probe`; no SDL includes/link dependencies
enter `include/evo`, simulation, world, biology or server targets. It is disabled
by default. Windows copies SDL3.dll beside the probe; Linux uses the build RPATH.
- Size reports are build artifacts, not performance rankings. No representative
creature/terrain workload exists yet, so no renderer throughput claim is made.
## Follow-up boundary
M9.2 owns the real application lifecycle, immutable-view renderer interface,
resize/DPI/focus/device failures and resource limits. M9.3 owns camera/intentions.
M9.8 owns distributable packaging. Xvfb verifies the Linux X11 window path; real
desktop input, focus, DPI, Wayland and GPU qualification remain later gate work.
See VALIDATION.md for executed measurements and limitations.