From 74789b43f6725e1731479bca95a93b072d52f6a0 Mon Sep 17 00:00:00 2001 From: Aiden Date: Tue, 5 May 2026 20:58:13 +1000 Subject: [PATCH] Docs update --- README.md | 8 +++++++- runtime/README.md | 2 +- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3a18a85..e6b8156 100644 --- a/README.md +++ b/README.md @@ -140,6 +140,12 @@ The control UI is available at: http://127.0.0.1: ``` +## 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 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.raw.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` Only `runtime/templates/` and `runtime/README.md` are tracked. diff --git a/runtime/README.md b/runtime/README.md index 9e20c40..73b02d7 100644 --- a/runtime/README.md +++ b/runtime/README.md @@ -17,7 +17,7 @@ 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. +- `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. Git policy: