# RigWorks (Rig)

> A no-code creative application framework - a shared data vocabulary for creative applications. Apps and packs that speak the same schema ids interoperate. Not another editor: the vocabulary editors and agents could share.

Rig defines a grammar of POD schemas (prose + JSON Schema) and entity/component documents. Live hosts also honor SUDE + runtime ECS. Emit JSON documents; validate with rig-validate. Nothing to link into an app.

## AI entry

- [skills/generating-rig-documents/SKILL.md](skills/generating-rig-documents/SKILL.md): condensed agent skill (load before generating)
- [AGENTS.md](AGENTS.md): agent onboarding (points at the skill + validator)
- [docs/ai-collaboration.md](docs/ai-collaboration.md): why the repo is shaped for model authoring

## Docs

- [README.md](README.md): pitch, worked example, reference host
- [docs/design-philosophy.md](docs/design-philosophy.md): future-proof, host-independent, human-readable
- [docs/why-no-code.md](docs/why-no-code.md): why a framework that ships no code
- [docs/terms.md](docs/terms.md): Contract, fulfillment, host, pack, POD
- [docs/sude.md](docs/sude.md): Setup / Update / Draw / Exit (live hosts)
- [docs/ecs.md](docs/ecs.md): entity/component POD (floor) + runtime systems (live hosts)
- [docs/ui.md](docs/ui.md): optional Rig + UI (same Contract; litmus + `rig-validate` on `rig.ui.*`)
- [docs/interchange.md](docs/interchange.md): JSON wire format + `.rig` / `.rigz` package
- [docs/openbim.md](docs/openbim.md): OpenBIM (IFC / BCF / IDS) to `rig.bim.*`; encodings are fulfillment
- [docs/ufo.md](docs/ufo.md): UFO / GLIF to `rig.font.*`; encodings are fulfillment
- [docs/idml.md](docs/idml.md): IDML to `rig.layout.frame` + layout / story; encodings are fulfillment
- [docs/ros.md](docs/ros.md): ROS 2 to existing spatial / I/O / sensor / SUDE; no `rig.ros2.*`
- [docs/dev.md](docs/dev.md): portable dev machines to `rig.dev.machine` / `rig.dev.op`; [RigDev](https://github.com/rigkid/RigDev) fulfills
- [docs/print.md](docs/print.md): FGF / pellet to `rig.print.*`; not envelope `pdfX`, not a layout page
- [docs/properties.md](docs/properties.md): portable datatype ids
- [docs/honors.md](docs/honors.md): what counts as Rig (grammar floor; live hosts; optional Rig + UI)
- [docs/gaps.md](docs/gaps.md): where the Contract is silent, ambiguous, or wrong
- [docs/versioning.md](docs/versioning.md): version ranges and stability

## Schemas and examples

- [schemas/json/](schemas/json/): machine-readable JSON Schema catalog
- [schemas/](schemas/): prose field layouts
- [schemas/README.md](schemas/README.md): catalog + field-naming rules
- [schemas/document.md](schemas/document.md): document envelope
- [examples/](examples/): reference documents (all validate)

## Reference host

- [RigKit](https://github.com/rigkid/RigKit): desktop / Pi reference host (GLFW, packs). In-repo SVG fulfillment: [`tools/render-svg.mjs`](tools/render-svg.mjs).

## Tools

- [tools/rig-validate/README.md](tools/rig-validate/README.md): validate CLI (`node tools/rig-validate/cli.js <file.json>`)
- [tools/check-version.mjs](tools/check-version.mjs): SemVer format of [`VERSION`](VERSION) + site badges; hooks via `npm run hooks:install` (pre-commit SemVer, pre-push full `npm run check`)
- [tools/check-schema-parity/check.mjs](tools/check-schema-parity/check.mjs): prose / JSON Schema parity
- [tools/gen-schemas.mjs](tools/gen-schemas.mjs): regenerate `schemas/json/` (`--check` to detect drift); run `npm run check` before push
- [tools/site/gen.mjs](tools/site/gen.mjs): render this repo as the static site at https://rig.works (`npm run site`; `--check` gates page coverage and links)