isostate Docs

isostate renders compiled isometric scene bundles in the browser. Author YAML at build time, compile it into a runtime bundle, then mount that bundle with the small browser runtime.

AI Authoring Skill

Install the isostate authoring skill before asking an AI assistant to write or review scene YAML:

bunx skills add sebastianwessel/isostate --skill authoring-isostate-scenes

See Install The Authoring Skill for package-runner variants, agent-specific installation, and verification.

Start Here

• Install The Authoring Skill: give your AI assistant the isostate DSL, asset, connector, and deployment rules.
• Getting Started: compile the demo and mount it in a browser page.
• Author Scene Deltas: write the YAML timeline model.
• Use The CLI: validate, compile, bundle, and inspect scene files from CI or local scripts.
• Deploy Static Bundle: generate public-folder output with the CLI.
• Public API: runtime and dev-time imports.
• Runtime Bundle: compiled artifact shape.
• Errors: structured error classes and common fixes.
• Types Reference: exported TypeScript contracts.

Examples

• Examples Index: choose the focused workflow.
• Runtime Basic: mount a precompiled bundle.
• Controller Scroll: drive progress from a scroll container.
• Compile YAML: parse, validate, and compile .isostate.yaml.
• Custom Assets: create browser-loadable SVG assets with explicit footprint anchors.
• Custom Theme: use CSS variable themes.
• Inspect Bundle: read compiled bundle metadata.
• Low-Level Rendering: advanced rendering escape hatch.

Browser Demo

The runnable demo lives in examples/basic. It uses the same public API documented here.