isostate Project page

How isostate Works

isostate separates authoring from runtime. YAML, validation, compilation, asset catalogs, and the editor are development tools. The browser runtime only mounts a compiled bundle and loads browser-safe assets.

flowchart LR
  subgraph Authoring [Development and CI]
    Brief[Story brief] --> YAML[scene.isostate.yaml]
    Editor[Website editor] --> YAML
    AI[AI assistant with skill] --> YAML
    Assets[SVG assets and sprite sheets] --> Manifest[Asset manifests]
    YAML --> Validate[Validate]
    Manifest --> Validate
    Validate --> Compile[Compile]
    Compile --> Bundle[Runtime bundle]
  end

  subgraph Browser [Browser runtime]
    Bundle --> Mount[mountScene]
    PublishedAssets[Published assets] --> Mount
    Mount --> SVG[Interactive SVG scene]
  end

Source And Output

FileRoleEdited By
.isostate.yamlSource scene documentHuman, editor, or AI assistant
SVG/PNG/WebP assetsSource visual assetsDesigner, generator, or catalog maintainer
*.manifest.jsonEditor catalog metadataCLI or tooling
scene.isostate.js / .jsonCompiled runtime bundleCLI/compiler
isostate.runtime.jsStandalone browser runtime for static bundlesCLI bundle command
manifest.json in static outputDeployment metadata and digestsCLI bundle command

Do not edit generated static output by hand. Change the YAML or source assets, then validate and regenerate.

The Three Authoring Modes

All authoring modes produce the same YAML:

flowchart TD
  Editor[Use the editor] --> YAML[Shared YAML source]
  Manual[Write YAML] --> YAML
  Skill[Ask AI with the authoring skill] --> YAML
  YAML --> CLI[Validate and compile]
  CLI --> Runtime[Browser runtime]

Use the editor when placement and anchors matter. Write YAML when the structure is already clear. Use AI when you have a written story brief and want a draft or review pass.

Runtime Boundary

The browser runtime does not include:

  • YAML parsing
  • DSL validation
  • compilation
  • CLI code
  • editor code
  • asset manifest scanning
  • the yaml package

That boundary keeps production pages small and makes validation a build-time responsibility.

Next: Plan A Scene.