Docs update
Some checks failed
CI / Native Windows Build And Tests (push) Has been cancelled
CI / React UI Build (push) Has been cancelled
CI / Windows Release Package (push) Has been cancelled

This commit is contained in:
2026-05-05 20:58:13 +10:00
parent be315111ea
commit 74789b43f6
2 changed files with 8 additions and 2 deletions

View File

@@ -140,6 +140,12 @@ The control UI is available at:
http://127.0.0.1:<serverPort> http://127.0.0.1:<serverPort>
``` ```
## Runtime State And Presets
The current layer stack is autosaved to `runtime/runtime_state.json` whenever layers, shader assignments, bypass state, ordering, or parameter values change. On startup, the host reloads that file before compiling the stack, so the last working stack should come back automatically.
Manual stack presets are still available from the control UI and are saved under `runtime/stack_presets/*.json`. Presets are useful for named looks, while `runtime_state.json` is the latest working state for the local machine.
## Control API ## Control API
The local REST control API is documented as an OpenAPI/Swagger spec: The local REST control API is documented as an OpenAPI/Swagger spec:
@@ -192,7 +198,7 @@ Runtime-generated files are intentionally ignored:
- `runtime/shader_cache/active_shader_wrapper.slang` - `runtime/shader_cache/active_shader_wrapper.slang`
- `runtime/shader_cache/active_shader.raw.frag` - `runtime/shader_cache/active_shader.raw.frag`
- `runtime/shader_cache/active_shader.frag` - `runtime/shader_cache/active_shader.frag`
- `runtime/runtime_state.json` - `runtime/runtime_state.json` autosaved latest stack and parameter state.
- `runtime/stack_presets/*.json` - `runtime/stack_presets/*.json`
Only `runtime/templates/` and `runtime/README.md` are tracked. Only `runtime/templates/` and `runtime/README.md` are tracked.

View File

@@ -17,7 +17,7 @@ Generated files:
- `shader_cache/active_shader_wrapper.slang`: generated Slang wrapper for the active shader/layer. - `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.raw.frag`: raw GLSL emitted by `slangc`.
- `shader_cache/active_shader.frag`: patched GLSL consumed by the OpenGL path. - `shader_cache/active_shader.frag`: patched GLSL consumed by the OpenGL path.
- `runtime_state.json`: persisted layer stack and parameter values. - `runtime_state.json`: autosaved latest layer stack, layer order, bypass state, shader assignments, and parameter values. The host reloads this file on startup.
- `stack_presets/*.json`: user-saved layer stack presets. - `stack_presets/*.json`: user-saved layer stack presets.
Git policy: Git policy: