Proscenio docs

This is a top-level documentation index that pairs hand-authored workflow guides with an interactive JSON Schema reference so a reader can move from "how the pipeline works" to "what every field on a .proscenio document means" without leaving this directory.

Workflow guides

• Basic walkthrough: the end-to-end loop, one page per tool.
• Advanced workflow: deeper dives into the features of each tool, and how they fit together.

Project documentation

• Project architecture: the design goals, the dataflow, and how the tools and formats fit together.
• Pipeline comparison: Proscenio against other 2D authoring stacks (Spine, DragonBones, COA Tools).
• Deferred / out-of-scope: rationale for features explicitly not in the current iteration.

Tools

High-level, intent-level reference for each app in the pipeline:

• Blender Addon: the authoring addon - mesh, rig, weights, slots, atlas, export.
• Photoshop Plugin: tag and export a layered PSD into a manifest plus PNGs.
• Godot Plugin: reimport a .proscenio into a native Godot scene.

Schema reference

Interactive reference for both wire formats, grouped by feature and rendered live from the JSON Schemas by the docs-site viewer, so it always reflects the models:

• Schema reference: entry point for both formats.
• Proscenio character: the .proscenio document: skeleton, elements, slots, animation.
• PSD manifest: the manifest the Blender importer reads from the Photoshop export.

The JSON Schemas are dumped from the pydantic source of truth at packages/models/src/proscenio_models/. Regenerate the schemas and bindings after editing the models:

uv run python -m proscenio_codegen all

That emits the JSON Schema artifacts, the Godot Resource bindings, and the TypeScript bindings (or run schemas / godot / ts individually). The schema reference itself needs no regeneration step: the viewer reads the dumped schemas directly.

Where the source-of-truth lives

Surface	File / package
Wire-format models (.proscenio + PSD manifest)	packages/models/src/proscenio_models/
Codegen emitters (schemas / Godot / TS)	packages/codegen/src/proscenio_codegen/
Blender addon	apps/blender/
Photoshop UXP plugin	apps/photoshop/
Godot importer plugin	apps/godot/

Docs site

The docs site is a Docusaurus app in apps/docs/ that serves this docs/ folder as its content root.

Run it with pnpm --dir apps/docs start for dev, or pnpm --dir apps/docs build for a production bundle.

It deploys to GitHub Pages at firebound.github.io/proscenio via docs-deploy.yml, on every push to main that touches docs/, apps/docs/, or the dumped schemas.