SDL3CPlusPlus

Minimal SDL3 + Vulkan spinning cube demo.

Cheat sheet

Dependencies

python scripts/dev_commands.py dependencies installs the Conan graph in build.

Configure & build

python scripts/dev_commands.py configure defaults to Ninja+MSVC on Windows or plain Ninja on Linux/macOS, writing into the matching build-ninja-msvc/build-ninja folder with the Release build type; override the generator or build directory with --generator / --build-dir if you need something else.
python scripts/dev_commands.py build runs cmake --build in the same folder (change --build-dir to match a different configure directory).
python scripts/dev_commands.py msvc-quick (Windows only) runs the VC vars + Ninja build alias; pass --bat-path to target a different Visual Studio installation.
python scripts/dev_commands.py run launches sdl3_app (use --target to run another executable and --args to forward CLI arguments).
Prefix any subcommand with --dry-run to print the alias-driven shell command without executing it.

Run

python scripts/dev_commands.py run [--build-dir ...] (source build/conanrun.sh / build\conanrun.bat first if the Conan runtime exports env vars).

Audio assets

Install the dependencies that power scripts/generate_audio_assets.py:

python -m pip install --user numpy soundfile pedalboard piper-tts

Before translating phrases, download a Piper voice (the script defaults to en_US-lessac-medium):

python -m piper.download_voices en_US-lessac-medium --download-dir scripts/assets/audio/tts/voices

Running the generator recreates procedural effects under scripts/assets/audio/sfx/ and voice clips under scripts/assets/audio/tts/. Use --force to rebuild every file and --skip-sfx / --skip-tts if you only need one subset; add --verbose to see the internal logging as the files are created. Override the voice files with --piper-voice-model <path> and (optionally) --piper-voice-config <path> if you downloaded a different voice or location. Pass --download-voice to have the script invoke piper.download_voices automatically before rendering (requires piper-tts and network access).

Runtime configuration

sdl3_app --json-file-in <path> loads JSON configs (script path, window size, lua_debug, etc.).
sdl3_app --create-seed-json config/seed_runtime.json writes a starter file assuming scripts/cube_logic.lua sits beside the binary.
sdl3_app --set-default-json [path] stores or overrides the runtime JSON; Windows writes %APPDATA%/sdl3cpp, other OSes use $XDG_CONFIG_HOME/sdl3cpp/default_runtime.json (fallback ~/.config/sdl3cpp).

GUI Demo

scripts/gui_demo.lua paints the Lua GUI framework on top of the Vulkan scene. Launch it as ./build/sdl3_app --json-file-in config/gui_runtime.json or register that config via sdl3_app --set-default-json.

2.8 KiB Raw Blame History