Files
video-shader-toys/runtime/README.md
Aiden 254d4cd070
Some checks failed
CI / Native Windows Build And Tests (push) Failing after 7s
CI / React UI Build (push) Has been cancelled
CI / Windows Release Package (push) Has been cancelled
Added OSC
2026-05-03 12:17:03 +10:00

28 lines
1.1 KiB
Markdown

# Runtime Files
This directory is used by the native host for local runtime output.
Tracked files:
- `templates/`: source templates used to generate shader runtime code.
Packaged documentation:
- `../docs/openapi.yaml`: OpenAPI/Swagger spec for the local control API.
- `../docs/OSC_CONTROL.md`: OSC address and value reference.
- `http://127.0.0.1:<serverPort>/docs`: Swagger UI page served by the native control server.
Generated files:
- `shader_cache/active_shader_wrapper.slang`: generated Slang wrapper for the active shader/layer.
- `shader_cache/active_shader.raw.frag`: raw GLSL emitted by `slangc`.
- `shader_cache/active_shader.frag`: patched GLSL consumed by the OpenGL path.
- `runtime_state.json`: persisted layer stack and parameter values.
- `stack_presets/*.json`: user-saved layer stack presets.
Git policy:
- Runtime cache/state/preset output is ignored by default.
- Template files are source files and should stay tracked.
- If a project wants shared stack presets, move selected preset JSON files into a tracked fixtures or presets directory intentionally rather than committing the whole runtime output tree.