@rig-c/core 2.82.0 → 2.82.2

package/README.md

@@ -26,7 +26,7 @@ name. Both remain published alongside it with the same product files.
 
 <p align="center"><em>Fourteen part PNGs drawn from scratch for this repo, one rig spec, one motion spec — the assembly,
 the breathing and the wave are all rigc-compiled Spine animations, rendered with
-<code>rigc render</code>. A <a href="https://raw.githubusercontent.com/rig-c/core/main/assets/rigc-demo@2x.gif">2x version</a> (1200x810) sits beside it.</em></p>
+<code>rigc render</code>. A <a href="https://raw.githubusercontent.com/rig-c/core/main/assets/rigc-demo@2x.gif">2x assembly film</a> (1200x810) sits beside it.</em></p>
 
 Loose part PNGs and two small JSON files in; **Spine 4.3 skeleton data out** — a
 `skeleton.json` and a `skeleton.atlas` that load in any Spine runtime and **import
@@ -44,13 +44,29 @@ installed.
 | a compiled rig and a question about its geometry | `rigc inspect` | one picture of its bones, axes, mesh edges and hulls, one bone's weights, the triangles folded over, the draw order, a world grid or a declared axis over the art — at the setup pose, one time or a sheet of several, zoomed to a bone or a slot, or beside a second build on one transform — and a legend that puts every mark back in world units |
 | a compiled rig | `rigc preview` | one self-contained `.html` that plays it in Spine's own web player |
 | two to four compiled rigs | `rigc vote` | one ballot page a human picks from, and the answer checked into a ledger |
-| a picture of a key pose | `rigc pose` | where each loose part PNG sits in it, in spec coordinates — the movement between two poses is then yours to key ([docs/MOTION.md](docs/MOTION.md)) |
+| a picture of a key pose | `rigc pose` | where each loose part PNG sits in it, in spec coordinates — the movement between two poses is then yours to key ([the motion recipe](docs/MOTION.md)) |
 | the same picture, and a rig | `rigc chainfit` | the parts `pose` refuses because something is drawn over them — read through the candidate's own draw order and hierarchy, with the share of each part the answer was measured on |
 
 Everything in that table needs Bun and this package — `preview` and `vote` also
 `@esotericsoftware/spine-core` installed beside it (see below) — and no clone, no
 reference art, no art pipeline, no server.
 
+### Depth-driven rigging
+
+Explicit depth, which a drawing alone does not state, makes facial features
+shift by different amounts during a small head turn: [the portrait depth example](https://github.com/rig-c/core/tree/main/gallery/portrait)
+uses per-part depths, while [the mesh-depth look example](https://github.com/rig-c/core/tree/main/gallery/look)
+samples a depth map at the mesh vertices.
+With [`@rig-c/parts`' depth fields](https://github.com/rig-c/parts/blob/main/docs/AUTHORING.md#per-layer-depth-sheets-773),
+See-through's per-layer sheets are bound explicitly with `near` and `zScale`,
+then consumed by head-turn roles in `turn.roles`.
+The [depth-yaw flow](docs/FACE.md#a-measured-alpha-aperture) shows how a turning
+surface and its alpha clipping aperture move together.
+The [value-driven turn](docs/FACE.md#the-turn-as-a-value-rather-than-a-time) is a
+rig control; the consumer chooses when to move it, and
+[getting-started](https://github.com/rig-c/getting-started) is the painting-to-rig
+walkthrough.
+
 ### Alpha-derived clipping
 
 Alpha-derived clipping takes a named source slot/skin/attachment plus explicit
@@ -59,7 +75,8 @@ Region, authored/resolved linked mesh and generated grid/contour depth sources u
 ordinary weighted clipping, with the existing validation gate before emission.
 See [AUTHORING: Alpha-derived clipping](docs/AUTHORING.md#alpha-derived-clipping)
 for source-motion limits, fit reports and named refusals, and
-[the face guide](docs/FACE.md#a-measured-alpha-aperture) for the depth-yaw flow.
+[the face guide](docs/FACE.md#a-measured-alpha-aperture) for the depth-yaw flow
+used in depth-driven rigging.
 
 ## What rigc is, and what it is not
 
@@ -89,45 +106,7 @@ it cuts both ways:
 
 ### Licensing, stated plainly
 
-rigc's own code is MIT (see [LICENSE](LICENSE)). That says nothing about Spine, and
-the following is a restatement of Esoteric Software's terms, not a term of ours:
-
-1. rigc's output **is Spine skeleton data**.
-2. A product that plays it with **a Spine Runtime** — the official runtimes, the Web
-   Player — has integrated the Spine Runtimes. rigc also writes the model document
-   its own core poses, and a product may play that or anything else; what the terms
-   turn on is the integration.
-3. Integrating a Spine Runtime into a product is permitted **under Section 2 of the
-   [Spine Editor License Agreement](https://esotericsoftware.com/spine-editor-license)**,
-   or otherwise on the condition that **each user of the product obtains their own
-   Spine editor licence** and the product carries the Runtimes licence and copyright
-   notice — the Runtimes licence's own two routes, in its words.
-4. The published rigc **links no Spine runtime**. This repository does — `spine-core`
-   as a development dependency, for its own gate — and so does an install with the
-   runtime added beside it.
-
-> **If a product integrates a Spine Runtime to play rigc's output, that integration
-> is subject to the terms above** — rigc neither adds those terms nor removes them.
-> Running the published rigc links no Spine runtime, and whether its output is then
-> played by one, by rigc's own core, or by something else is the consumer's choice.
-
-See [NOTICE.md](NOTICE.md) for the full notice.
-
-📐 **What of Esoteric Software's is in this repository, and under what grant.** No
-example asset is committed: `bun run fetch-examples` downloads the example projects
-into a gitignored `examples/`. What *is* committed is `bench/reference/` — 1,293 PNG
-frames **this project renders** from those examples' own exports, so a frame carries
-those images' pixels and committing one **is** redistribution. Each example's own
-`license.txt` permits exactly that, *"as long as they are accompanied by this license
-file"*, and a verbatim copy of it sits at each example root here — all eight, written
-there by the render script rather than left to memory. The same file's
-**non-commercial** condition rides along with those images, and
-[LICENSE](LICENSE) says so: rigc's MIT grant covers rigc's own code, documentation
-and art, not this material. `7-anticipation` publishes no `license.txt` upstream, so
-no such grant exists for it and its frames are never committed — they render only
-into a gitignored directory, enforced by `git check-ignore`. Full reasoning:
-[`bench/reference/README.md`](https://github.com/rig-c/core/blob/main/bench/reference/README.md)
-(repository material, not in the npm package).
+See [the licensing notice](NOTICE.md) for licensing and third-party terms.
 
 The problem rigc is aimed at is narrow. An agent asked to author a rig has no way
 to tell whether it succeeded: Spine's JSON parser accepts a great deal of nonsense
@@ -211,7 +190,7 @@ reference frames this project renders from them, which **are** committed, each
 example's own `license.txt` beside them under the redistribution grant those files
 carry; the images stay **non-commercial only**. The reasoning is in
 [`bench/reference/README.md`](https://github.com/rig-c/core/blob/main/bench/reference/README.md)
-and the terms in [NOTICE.md](NOTICE.md). It needs a clone and `bun run
+and the terms in [the reference-image notice](NOTICE.md). It needs a clone and `bun run
 fetch-examples`, and says so by name when the corpus is absent. `check` is not one
 of them: it reads whatever frames you point it at, so it runs from the installed
 package on pictures of your own — which is what *Where to go next* below tells you
@@ -467,39 +446,7 @@ origin and tip in world units and in pixels, so a position read off the picture
 straight back into the spec. [AUTHORING §13](docs/AUTHORING.md#13-asking-the-picture-a-question--rigc-inspect)
 maps each question to its view.
 
-**`render`** samples every animation at 12 fps and writes `render/<animation>/f0000.png…`
-with a `contact.png` beside them — every frame of the shot as one labelled grid,
-which is the picture to open first, because spacing is a comparison *across*
-frames. It draws with rigc's own rasteriser (the one `check` measures with), so
-it needs no browser and no network, and the `frames.json` it leaves beside the
-directories makes the result a frame set like any other — the world box every
-frame is a picture of. `--animation <name>` narrows it to one, `--fps` and
-`--max` change the rate and the frame size. A set drawn at any rate but the
-default is written to `<anim>@<fps>fps/` rather than `<anim>/`, so two rates sit
-side by side: `--fps 24` writes `<anim>@24fps/`, and the default 12 writes
-`<anim>/`. Each set's summary line ends with the directory it wrote.
-
-> 🚨 **`--skin <name>` if your rig has more than one.** With no `--skin` no skin
-> is set at all, so every slot resolves through the **default** skin alone — and
-> a slot whose art lives only in a named skin draws *nothing*. That is not a
-> quirk of `render`: `check` compares `render`'s frames, so a multi-skin rig
-> checked with no skin compares blank against blank and reports a perfect
-> `0.0000` about art nobody drew. `render --skin` records the name in
-> `frames.json`, `check --skin` poses the candidate under it, and a candidate
-> scored against frames rendered under a *different* skin is refused by name
-> rather than measured.
-
-**`preview`** writes a single self-contained `.html`: your skeleton, your atlas
-and every page's PNG bytes are embedded in it as data URIs, and it plays them in
-the **official [Spine Web Player](https://esotericsoftware.com/spine-player)**.
-Double-click it, or attach it to a message — the file carries the whole artifact.
-It is also the strongest interop statement in this repository: a rig that plays
-there has been played by Esoteric Software's own runtime rather than by ours.
-
-> ⚖️ The player itself is **referenced, not embedded** — the page loads it from
-> unpkg, so the first open needs a network, and rigc redistributes nothing
-> Esoteric Software owns (see [NOTICE.md](NOTICE.md)). Everything the player
-> draws is inside your file.
+**`render`** writes PNG frames and a contact sheet; **`preview`** writes a playable HTML file — see [the render and preview reference](docs/AUTHORING.md#0-the-loop).
 
 **7. Let someone choose.** Sooner or later you will have two builds that both pass
 the gate and no instrument that can separate them. `vote` puts them in one page
@@ -519,11 +466,11 @@ that does not belong to it. See
 
 **Where to go next.**
 
-- 📘 **[docs/AUTHORING.md](docs/AUTHORING.md)** is the real guide — both files
+- 📘 **[the authoring guide](docs/AUTHORING.md)** is the real guide — both files
   field by field, the emission rules, every named failure mapped to the file that
   has to change, and §8–§9 for reproducing a shot you were given as pictures. It
   ships inside the npm package too, at
-  `node_modules/rig-c/docs/AUTHORING.md`.
+  `node_modules/@rig-c/core/docs/AUTHORING.md`.
 - `rigc explain --rig buoy.rig.json --motion buoy.motion.json --out spine` prints
   the compiled rig as a table — every bone with its resolved parent, the slots in
   draw order, every timeline key by key — and writes nothing. It is what to reach
@@ -543,11 +490,11 @@ that does not belong to it. See
   it, so a figure is read against that rather than against a number from a page;
   AUTHORING.md §9.2 says what the two halves of that bound are and why the floor
   is not zero.
-- [docs/LADDER.md](https://github.com/rig-c/core/blob/main/docs/LADDER.md) is the benchmark: the same job, from a brief
+- [the benchmark ladder](https://github.com/rig-c/core/blob/main/docs/LADDER.md) is the benchmark: the same job, from a brief
   and rendered frames, scored. [docs/PILOT.md](https://github.com/rig-c/core/blob/main/docs/PILOT.md) is how to run an
   agent through it and score what comes back.
 - 🤖 **Handing the authoring to an AI agent?**
-  [docs/PROMPTING.md](docs/PROMPTING.md) is the operator's page — the six prompt
+  [the prompting guide](docs/PROMPTING.md) is the operator's page — the six prompt
   clauses a measured pilot run paid for, and what you can leave unsaid.
 
 ## See what you built, and let someone choose
@@ -567,7 +514,7 @@ a rig compiles green, because green says nothing at all about the picture.
 conditions, <code>rigc pose</code> reads where every part sits in each picture, two
 candidate in-betweenings are compiled from the same pair — and a real
 <code>rigc vote</code> ballot picks the winner, because the movement between the poses
-is the one thing no instrument here will grade. A <a href="https://raw.githubusercontent.com/rig-c/core/main/assets/rigc-keypose@2x.gif">2x version</a> (1200x810) sits beside it.</em></p>
+is the one thing no instrument here will grade. A <a href="https://raw.githubusercontent.com/rig-c/core/main/assets/rigc-keypose@2x.gif">2x key-pose film</a> (1200x810) sits beside it.</em></p>
 
 Three properties of `vote` are worth stating, because they are what make its ledger
 usable by the next agent rather than by a reader: **a tie is a recorded outcome, not a
@@ -578,7 +525,7 @@ anywhere; and **every line carries a reason code** from a closed enumeration tha
 enforced, so *"tie, because this one is better"* is refused.
 
 🎞️ **Authoring the movement those pages show you** — key poses, in-betweening, and how
-to spread candidates so a ballot informs — is [docs/MOTION.md](docs/MOTION.md).
+to spread candidates so a ballot informs — is [the motion authoring guide](docs/MOTION.md).
 
 📐 **`rigc pose --images parts/ --frame poseA.png` runs the other way.** Every command
 above takes something you authored and tells you about it; this one takes a **picture
@@ -621,7 +568,7 @@ while <code>gaze</code> and <code>turn</code> return to rest, so the hand-offs m
 differing pixels — and the composing is the consumer's. Authorable on plain Spine 4.3, no
 plugin, no runtime patch; what the turn costs is authoring rather than runtime capability,
 and that cost is one stated expression per key. Compiled and rendered entirely by the
-published package. A <a href="https://raw.githubusercontent.com/rig-c/core/main/assets/rigc-scene@2x.gif">2x version</a> (1200x810) sits beside it.</em></p>
+published package. A <a href="https://raw.githubusercontent.com/rig-c/core/main/assets/rigc-scene@2x.gif">2x portrait film</a> (1200x810) sits beside it.</em></p>
 
 🎞️ **How the three films on this page were made** is kept with them, one directory per
 film in [`films/`](https://github.com/rig-c/core/tree/main/films) — a `run.sh` that
@@ -631,203 +578,44 @@ material, like the gallery: a clone runs them.
 
 ## Commands
 
-Every command takes its paths explicitly. `rigc <command> --help` prints its flags —
-`rigc help <command>` prints the same page — and
-[AUTHORING.md §0](docs/AUTHORING.md) is the same list with what each flag means, which
-commands take it and what its default is.
+`rigc help <command>` prints the command’s flags; [AUTHORING §0](docs/AUTHORING.md#0-the-loop) is the CLI reference.
 
 | Command | Does |
 | --- | --- |
-| `build --rig … --motion … --out …` | compiles, gates, and **writes only if the gate is green**. `--images <dir>` says where the rig spec's `image` names resolve, `--manifest` adds measured art, and `--copy-images` copies every page PNG into `--out` so the directory is self-contained, with `skeleton.images` pointing at it so the editor's import finds the parts |
-| `build … --pack` | the same build with every part arranged onto **shared** atlas pages, written into `--out` — losslessly, and gated a second time as the pair that ships. `--page-size`, `--padding`, `--page-edges` and `--pack-shape` tune it — `--pack-shape polygon` lets a neighbour sit inside a mesh's rectangle where its hull is not, and with `--page-edges free` costs 12–56 times `rect`'s pack (3–11 s against 0.2–0.3 s on 90–144 parts over two to four pages; past 5 s from about 60 parts, a second or so below 45 on one page — AUTHORING §0.1) |
-| `build … --atlas-in <file.atlas>` | the same build with every part resolved to a **region of an existing pack** instead of a loose PNG; a name the atlas lacks, a size the spec disagrees with or a rectangle off its page is refused by name |
-| `validate <dir>` | re-gates artifacts already on disk |
-| `repack <dir> --out <dir>` | a packed build **repacked from its own output** — `skeleton.json`, `skeleton.atlas` and the pages, with no parts kept — under the packing flags `build --pack` takes, so a packer improvement reaches a build whose parts are gone. Every region is lifted off its page, the skeleton read back with `ingest`, and `build --pack` run over the lifted parts with the same gate; it writes only after every region is shown pixel-identical to the input's, the skeleton byte-identical and the gate green, and refuses by name an atlas it cannot lift exactly. A skeleton the rebuild does not reproduce byte for byte — a build written before 2.2.0, whose header box was its stage — is refused naming every differing path, and written, every path printed, only under `--accept-skeleton-differences`. `--stage-box <slot>` reads the stage from the box a build carries for it (`skeleton.stageBox`), the one way the three files alone carry the stage exactly ([AUTHORING §0.4](docs/AUTHORING.md)) |
-| `repack <dir> --out <dir> --keep-pages` | **`skeleton.model.json` alone, for the pages already in place** — for a player that reads the document beside an atlas and pages that already shipped. The same read and stage rules, then `build --atlas-in` over the input atlas in place of the lift and the pack; it writes the document, and nothing else, only after its `pages` are shown to state the atlas as it stands, the rebuilt skeleton byte-identical to the one on disk (so `spine.sha256` names it — no acceptance flag here) and the gate green. `--out` is usually the build's own directory and must not already hold a `skeleton.model.json`; a page or region line the document has no field for is refused by name ([AUTHORING §0.4](docs/AUTHORING.md)) |
-| `ingest <skeleton.json> --out <dir>` | `build` run backwards: reads a Spine 4.3 skeleton and writes the rig spec and motion spec that **rebuild it**, plus a findings report naming everything it could not carry. a skeleton that declares no stage is carried as declaring none, `--stage x,y,w,h` adds a box to one — and is refused, rather than ignored, beside one that declares a box — and `--images <dir>` writes the spec's own images directory — the opposite direction from `build --images`, which overrides it — so the rebuild carries no flag at all |
-| `split --rig … --motion … --slot <name> --out <dir>` | the answer to a mesh refused because its triangles are **several pieces that share no vertex** — two legs after the triangles bridging them were deleted. It reads the two specs and writes them back into an absent or empty `--out` with one mesh per piece: piece 1 stays in the slot, piece k gets a new slot `<slot>_<k>` after it, each with the original's uvs and weights unchanged, its triangles renumbered outline first where the hull rule needs it, and every deform key re-sliced to the new indices — plus `split.json`, where every original vertex and triangle went. One piece is said so and nothing is written; what it cannot carry is refused by name ([AUTHORING §3.4.11](docs/AUTHORING.md)) |
-| `explain --rig … --motion …` | the compiled rig as a table — every bone with its resolved parent, the slots in draw order, every timeline key by key. Writes nothing. What to reach for when a rig compiles and still looks wrong |
-| `render --candidate <dir>` | PNG frames plus a contact sheet, in `render/`, one directory per set: `<anim>@<fps>fps/` rather than `<anim>/` at any rate but the default — `--fps 24` writes `<anim>@24fps/`, and the default 12 writes `<anim>/`. `--hide <slot,…>` or `--slot <slot,…>` draws part of the rig on the **same grid** as the whole, so the two frames overlay and the difference is the part; `frames.json` records the subset and `check` refuses such a set as a reference. `--geometry` adds a `geometry.json` per set: every frame's bone world transforms and skinned attachment vertices, with the rest geometry, on the frames' own grid. `--folds` adds a `folds.json` per set and prints one line per mesh with a triangle turned over against the setup pose: the frames, the worst frame's count and which triangles, their world box and their setup-pose area. `--pass-through <cloth>:<leg>` adds a `pass-through.json` per set and prints the frames where a cloth drawn over a leg has its side inside the leg's drawn outline, with the depth and the world box — a reading, not a gate. `--seam <slot>:<slot>` adds a `seam.json` per set and prints, per pair, the frames where two slots that meet open background inside the joint (a gap) or show the overlap band of one past the other (a ghost), with the worst frame's cell count and world box; `ghostA` and `ghostB` partition the same ghost by which named pair member drew it, each with its own frames, spans and worst; `gapOpen` and `gapCovered` partition `gap` by zero versus positive rendered alpha from the whole skeleton, including faint and clipped drawings ([AUTHORING §8.8](docs/AUTHORING.md#88-where-two-slots-stop-meeting--render---seam)) — a reading, not a gate; the exit status never moves. `--overlaps` adds an `overlaps.json` per set and prints one `OVERLAP "<under>" under "<over>"` line per pair of slots where the one drawn later covers the earlier one and the motion moves it — the frames, and the most pixels covered and the frame of them — with an outline plate per covered frame; the render reports what was drawn, and the draw-order key is the author's remedy — a reading, not a gate. `--extremes` adds `extremes.json` and a native six-panel `extremes.png` (setup, geometry-pair min/max and three premultiplied RGBA diffs with a legend), plus one `EXTREMES` line per set. Per-channel minima/maxima and the farthest original-vertex geometry pair are distinct readings; valid channel extrema survive a geometry/image SKIP, with channel refusals reported separately; still or uncomparable geometry reports a named SKIP without changing render exit status. `--extremes-only` writes the same `extremes.json` and readable `extremes.png` bytes while skipping ordinary frame rasterization/encoding, `contact.png` and `frames.json`; it implies `--extremes` and takes no other diagnostic or sheet output flags. Look at min, max and diff before a person does ([AUTHORING §8.11](docs/AUTHORING.md#811-min-max-and-diff-before-a-person-looks--render---extremes)). `--angle-range <bone>:<relative-to>` prints how far one bone turns against another over each set: the lowest and highest angle and the frames they fall on — a reading, not a gate. `--viewport <x,y,w,h>` or `--viewport-from <frames.json>` draws over a given box instead of a fitted one, so two builds land on one pixel grid; a slot that reaches past it is named by set and frame, and `frames.json` records it. `--environment <schedule.json>` draws the rig under the wind and gravity its physics answers, in time — the same frames on the core and on spine-core; an inspection of the response the rig states, not a scene. `--sheet [--sheet-format json-hash] [--page-edges pot\|free]` also packs each set's straight-alpha transparent frames into `sheet.png` + `sheet.json` (TexturePacker JSON Hash with a shared world-origin `anchor` and `2`-px clamped edge extrusion, verified through `pixi.js@8.22.0` and `phaser@3.90.0` by `tools/sheet_readers.ts`) and `sheet-manifest.json` (`rigc-sheet/1`), leaving diagnostic `f####.png` and `contact.png` unchanged ([AUTHORING §8.10](docs/AUTHORING.md#810-sprite-sheets-from-a-render--render---sheet)) — a self-contained sprite object per animation set; when animations play and how a scene is composed remains the consumer's |
-| `preview --candidate <dir>` | one self-contained `.html` that plays it, headed by the line `validate <dir>` prints for it and the rigc version — a refused candidate is still previewed, and its header says so in the gate's words. Repeat `--candidate` for one page with a pane per candidate, in the order given; a green `build` ends by naming this command for its own `--out` |
-| `vote --candidate a --candidate b` | one `.html` that asks a human which; `vote --record <file>` checks the answer into `votes.jsonl` |
-| `pose --images <dir> --frame <png>` | reads part placements **out of** a picture |
-| `chainfit --candidate <dir> --images <dir> --frame <png>` | reads the parts `pose` refuses, through the candidate's own draw order and hierarchy: masked residuals over **visible** pixels, one hinge per child instead of four degrees of freedom, and the `rotate` key value each answer implies. A bone with two or more anchored descendants is **determined** rather than searched, and the residual that over-determination leaves is reported |
-| `diff <candidate.json> <reference.json>` | structural comparison of two skeletons, one ratio per measure and deliberately no combined score |
-| `bonedist --candidate … --reference … --bones …` | per-frame, per-bone world-transform distance against another skeleton — the ladder's stage 3, run on its own. `--bones <correspondence.json \| identity>` is required rather than defaulted: a candidate is entitled to its own bone names, so the pairing is stated |
-| `check --candidate <dir> --frames <dir> [--out <dir>]` | the candidate against reference pictures — the only instrument here that can see a *wrong animation*. `--out` also writes, for every frame the table lists, the picture its figures came from: reference, candidate, difference and overlay at native size |
-| `bench <rung> --candidate <dir>` | one rung of the benchmark ladder |
-| `guide <RULE>` / `guide §<n>[.<m>[.<k>]] [--all]` | the guide's row for the rule a failure line names — every `FAIL` line, `vote --record` refusal, `ingest` finding and coded compile error ends with ` (see rigc guide <RULE>)`; only legacy uncoded library errors point at `§5.1` — or a section's heading, own prose and subsection index, read from the installed `docs/AUTHORING.md` when it runs. `--all` includes the subsection bodies; a leaf prints its full text either way. Sizes describe full ledger spans. `--all` with a rule is refused, exit 2; an unknown name is refused with the nearest real ones, exit 1 |
-| `skills install [--dir …] [--copy]` | links every agent skill the package ships into `.agents/skills` (or `--dir`) as relative symlinks, or copies them with `--copy` — where Codex, Gemini CLI and Antigravity look. A second run has nothing to do; an entry already there that is not this command's is refused by name and nothing is written |
-| `review <dir> […]` | the human review of a build, handed to the `rig-review` bin of `@rig-c/review` installed beside the package; rigc does not depend on it and never installs it. `rigc review <dir> [--reference <video>] [--animation <name>] [--compare <dir>]` is `rig-review open <dir> …` with those flags 1:1 and prints the loopback URL to give a person; a first argument that is one of review's own words (`open`, `check`, `feedback`, `control`, `strip`, `compare`) or starts with `-` (`--help`, `--`) is handed over untouched. stdout is review's byte for byte, stderr review's plus the launcher's own refusals, the exit code review's. Refused by name, exit 2, before the bin starts: `REVIEW_OUTPUT_MISSING <path>` (the target is not a directory); `REVIEW_NOT_INSTALLED` with two lines, `bun add -d @rig-c/review` and `bunx @rig-c/review open <dir> …` carrying the flags given — the same on a terminal and off, with nothing installed or written; `REVIEW_BUN_TOO_OLD: Bun <found>, @rig-c/review needs <required>`, the floor read off the installed package's `engines.bun`; and an empty argument (`""`) under a Bun that drops one (Bun 1.2.0, measured by a probe), `rigc review: argument N is empty, and Bun <version>, the Bun running this, drops an empty argument when it starts a process — …`. docs/AUTHORING.md lists every line |
-
-`diff`, `bonedist`, `check` and `bench` measure against something you were given; the
-first three work on any reference you have, and `bench` is a repository workflow that needs a clone
-and `bun run fetch-examples`. The reasoning behind them is in
-[the benchmark dossier](https://github.com/rig-c/core/blob/main/docs/BENCHMARK.md).
-
-`build` and `validate` both default to `--profile spine` — the 36 validity rules, which
-ask *is this valid Spine 4.3 that any runtime plays correctly?* `--profile rig-play`
-adds all 50: the other 14 are one renderer's policy and one canvas budget's, and they
-fire on perfectly correct editor-produced Spine data, which is why they are opt-in.
-⇒ **That reason is about foreign data and does not carry to a rig you are authoring
-yourself: author under `--profile rig-play` and read the extra 14 as findings, and
-gate the release under `--profile spine`.** A `deform` key that folds a mesh inside
-out is written out under the default and refused by name under `rig-play`, which
-is the shape of what that split buys you. A report always names
-the profile it ran and lists what that profile left out.
-
-Several cuts can also be registered in a `cuts.json` and built by name
-(`build --cut my_cut --cuts path/to/cuts.json`); every path in that table resolves
-relative to the `cuts.json` file itself, so the table lives with the project that owns
-the art. Its shape is under
-[Usage](https://github.com/rig-c/core/blob/main/docs/BENCHMARK.md#usage).
-
-### Starting from a skeleton you already have
-
-`rigc ingest` reads a Spine 4.3 `skeleton.json` and writes the two spec files that
-rebuild it. It is the only command that runs against `build`'s direction, and the
-only one whose contract is an equality rather than a rulebook:
-
-```bash
-rigc ingest hero.json --out specs/ --images parts/
-rigc build --rig specs/rig.json --motion specs/motion.json --out build/
-rigc diff build/skeleton.json hero.json
-```
-
-`--images parts/` is what makes the second line carry no flag: it writes the spec's
-own `images` directory, spelled from `--out`, so the specs are self-contained from
-there on. Leave it off and the `image` names resolve against `specs/` itself, which
-holds no art — every rebuild then has to repeat `build --images parts/`.
-
-**`build(ingest(x))` is `x`.** Over the eleven rigs this repository builds — the seven
-gallery examples, the three generated probes and a coverage probe written for the
-purpose — the rebuilt `skeleton.json` is byte for byte the file the decompiler read.
-The atlas is held to a weaker
-claim on purpose, and the weakening is measured rather than assumed: it comes back
-equal as a **multiset of region blocks**, because the order the pages are collected in
-is in no field of the skeleton.
-
-**And over twelve skeletons nobody here wrote.** Every editor export in the fetched
-example corpus, ingested, rebuilt through the pack beside it and `diff`ed against the
-source, comes back **12 of 12, no blockers, 1.000 on every measure the report
-carries** — and each rebuild is its export's own text in canonical form, apart from
-the header's `hash` and `spine`: the editor's project hash and the runtime version
-rigc stamps, the two keys the rig spec has no field for by design (12 of 12) — and
-the header's box, which `build` computes rather than carries (issue #907): the rebuild
-writes spine-core's `getBounds` over the export on the header's 1e-6 grid at float32, equal on all twelve,
-where the editor wrote its own arithmetic, up to 0.0071 units away.
-[INGEST.md §2.3](docs/INGEST.md) states that pass line and why those two are the
-exceptions.
-
-**What it reads is skeleton JSON and nothing else** — no `.spine` project, no binary
-`.skel`, no atlas, no art. So it never invents, and the things it cannot get out of
-the file are **findings** with codes rather than plausible values: a construct the
-spec format cannot hold (`point`, a `sequence` block, an unknown field
-on a bone, slot or constraint) is a blocker, the command exits non-zero, and both
-specs are still written — a spec plus a list of what is missing from it beats no spec.
-
-⚠️ **Two values are not in a skeleton at all.**
-
-- **The stage.** `skeleton.width`/`height`. A skeleton that declares none is carried as
-  declaring none — the rig spec states `"width": null, "height": null` and the rebuild
-  carries no box either, byte for byte — and `--stage x,y,w,h` is how a
-  caller *adds* one, recorded as a judgement. It is not derivable — posing the rig gives
-  the *animated* extent, which is a different number from the setup box. ⛔ **And `--stage` beside a box the file already states is refused
-  too**, for the opposite reason: two sources for one value, where the file is the record
-  of what was measured. **All twelve exports in the example corpus carry a stage** and
-  none of them needs the flag. It is the value that costs least to get wrong, because
-  `diff` reports the box and gates nothing on it. 🔁 The box an export's header carries
-  is its setup-pose bounding box, and it becomes the rebuild's *stage*; the rebuild's own
-  header is computed again, because since issue #907 `build` writes the setup-pose
-  bounding box there — never the stage — held to spine-core's `getBounds`. 📦 A rig
-  that has to carry its stage in the Spine files asks for it as a bounding box
-  (`skeleton.stageBox`, written by `build` from the stage and held by
-  `A50_STAGE_BOX_IS_THE_STAGE`), and `ingest --stage-box <slot>` reads that box back as
-  the rebuild's stage — [AUTHORING §3.1](docs/AUTHORING.md) has the field and the
-  paragraph for a consumer of the files.
-- **An animation's duration.** The format has no such field. The largest key time is
-  the only derivable answer and it is what a runtime plays to; it is wrong for an
-  animation that holds its last pose past its last key, so it is recorded as a finding
-  on every animation rather than chosen quietly.
-
-Both specs carry a `note` that `ingest` writes itself, saying the file is decompiled
-and naming the skeleton it came from — because a decompiled spec is indistinguishable
-from an authored one by inspection, every gate here calls it green (it *is* green),
-and no gate can catch a missing note.
-
-[docs/INGEST.md](docs/INGEST.md) is the whole page on working from a file you were
-handed; [docs/AUTHORING.md](docs/AUTHORING.md) §0.3 is the loop.
-
-### The editor round trip — for a licence holder, never in CI
-
-`tools/editor_roundtrip.ts` drives the loop the output's whole premise rests on:
-build → **import into the Spine editor** → export back to JSON → gate, `diff`,
-`render` and `check` the export against the build it came from.
-
-```
-bun cli.ts build --rig … --motion … --out build/ --copy-images
-bun tools/editor_roundtrip.ts --build build/ --editor /Applications/Spine.app/Contents/MacOS/Spine
-```
-
-Of the editor's `--version` it records one line, the `Spine <x.y.z> …` line that
-carries the version, and nothing else that command prints — the rest of it
-names the licence holder — or `editor version: not found in --version output`
-where no such line is there. That call carries the same `-u` as the import and
-the export, so a trip pinned with `--editor-version <v>` names the editor it
-pinned and says so on the line (`(read from --version under -u <v>, …)`); an
-unpinned trip names the launcher's default. Once the export exists the version
-is held against the export's own `skeleton.spine`, and a disagreement is a FAIL
-naming both values — the line would otherwise name an editor the trip did not
-run on. It prints the import and export exit codes, the
-validator's verdict on the export, every `diff` measure that moved, `check`'s mean MAE and worst drift per
-animation **for each skin the build and the export both declare** — one
-render-and-check block per skin, with a per-skin roll-up under them, because a
-rig's contested art lives in its named skins and a single un-skinned check draws
-none of it; a skin only one side declares is a FAIL naming it as **lost** (or
-**added**) **by the export**, with `diff`'s `attachments.skins` beside it, and is
-rendered on neither side — and a
-field-by-field list of what the editor rewrote. Every step quotes what its child
-said when that child did not do what it was for, the renderers included — the
-editor's words in full and in order, except its `Licensed to:` line, which names
-the licence holder and is replaced by a line saying it was withheld; a skin
-**neither** side can draw — a hit-box rig, say — is a **SKIP** naming that, not a
-red, because `check` had nothing to compare and `diff` and `validate` have
-already measured the rig. One side drawing where the other does not is the
-divergence the trip exists to find and stays a failure. A human edit made in the
-editor survives the trip back.
-
-🔒 **It requires a licensed Spine editor on the machine, by construction**, and
-drives only the [documented command line](https://esotericsoftware.com/spine-command-line-interface)
-— never the UI, and it produces nothing the editor did not produce. With no
-editor present it refuses by name and exits non-zero, and so does the **trial**:
-the trial cannot save projects or export animation data, so the refusal names
-what it found — the executable, the bundle, the `CFBundleName` that bundle
-declares, or the banner the binary prints about itself — rather than starting it
-and failing downstream. Both refusals point at `--exported <file>`, which
-measures an export the editor already made and is the half of this tool that
-needs no editor at all. A build whose `skeleton.json` is missing, is not JSON, or
-holds JSON that is not one object is refused by name before the editor starts,
-and so is a build with no atlas or an atlas that is a directory, or an
-`--exported` file that is not one JSON object.
-
-⛔ **Run the round trip by hand, on a machine that has the editor.** CI has no
-editor, so no automated check runs it. The by-hand measurement before a landing
-trips the production rigs and one **parts-built** rig, the exam's task-01
-painting through `@rig-c/parts`. The production rigs were authored in the editor,
-so they are already in the editor's own shape. A refusal that only a generated
-rig carries cannot show up on them. Issue #1407 was such a refusal: a green build
-whose meshes listed their bones in two orders, which the editor would not import.
-
-⚠️ Build with `--copy-images`. An ordinary build's atlas names its pages by a
-relative path back to the art directory, and the round trip copies that atlas to
-a directory at another depth — the tool refuses such a build by name rather than
-letting `A17` blame the editor for the harness's own doing.
+| `build` | Compile, gate and write the rig. [`build` in the CLI reference](docs/AUTHORING.md#cmd-build) |
+| `validate` | Re-gate artifacts already on disk. [`validate` in the CLI reference](docs/AUTHORING.md#cmd-validate) |
+| `repack` | Repack a build from its output. [`repack` in the CLI reference](docs/AUTHORING.md#cmd-repack) |
+| `ingest` | Read a skeleton back into specs. [`ingest` in the CLI reference](docs/AUTHORING.md#cmd-ingest) |
+| `split` | Separate disconnected mesh pieces. [`split` in the CLI reference](docs/AUTHORING.md#cmd-split) |
+| `explain` | Print the compiled rig as a table. [`explain` in the CLI reference](docs/AUTHORING.md#cmd-explain) |
+| `render` | Write PNG frames and a contact sheet. [`render` in the CLI reference](docs/AUTHORING.md#cmd-render) |
+| `preview` | Write a playable HTML preview. [`preview` in the CLI reference](docs/AUTHORING.md#cmd-preview) |
+| `vote` | Make a ballot and record its answer. [`vote` in the CLI reference](docs/AUTHORING.md#cmd-vote) |
+| `pose` | Read part placements from a picture. [`pose` in the CLI reference](docs/AUTHORING.md#cmd-pose) |
+| `chainfit` | Read occluded parts through a candidate rig. [`chainfit` in the CLI reference](docs/AUTHORING.md#cmd-chainfit) |
+| `diff` | Compare two skeletons structurally. [`diff` in the CLI reference](docs/AUTHORING.md#cmd-diff) |
+| `bonedist` | Measure per-bone world-transform distance. [`bonedist` in the CLI reference](docs/AUTHORING.md#cmd-bonedist) |
+| `check` | Compare a candidate against reference pictures. [`check` in the CLI reference](docs/AUTHORING.md#cmd-check) |
+| `bench` | Run a rung of the benchmark ladder. [`bench` in the CLI reference](docs/AUTHORING.md#cmd-bench) |
+| `guide` | Read a named failure or guide section. [`guide` in the CLI reference](docs/AUTHORING.md#cmd-guide) |
+| `skills install` | Install the packaged agent skills. [`skills install` in the CLI reference](docs/AUTHORING.md#cmd-skills-install) |
+| `review` | Hand a build to the review package. [`review` in the CLI reference](docs/AUTHORING.md#cmd-review) |
+
+### Existing skeletons and the editor
+
+<a id="starting-from-a-skeleton-you-already-have"></a>
+<a id="the-editor-round-trip--for-a-licence-holder-never-in-ci"></a>
+
+For a skeleton you already have, [the ingest-and-rebuild loop](docs/INGEST.md#starting-from-a-skeleton-you-already-have)
+turns a Spine 4.3 export into rig and motion specs, then checks that rebuilding them reproduces it.
+For a licence holder, [the editor round trip](docs/INGEST.md#the-editor-round-trip--for-a-licence-holder-never-in-ci)
+imports a build into the Spine editor and checks the export against that build with the gate, structural diff and rendered frames; it never runs in CI.
 
 ## Documentation
 
 | Document | For |
 | --- | --- |
-| 📘 **[docs/AUTHORING.md](docs/AUTHORING.md)** | **the format guide, and the one to read before writing a spec.** Both input files field by field with a complete minimal example each, every field with its Spine meaning, the rules that decide what is emitted, the build → read the report → fix → repeat loop, the map from every named failure to the file that has to change, and the features rigc refuses by name so you do not spend a loop discovering them. It travels **inside the npm package**, at `node_modules/rig-c/docs/AUTHORING.md` |
+| 📘 **[docs/AUTHORING.md](docs/AUTHORING.md)** | **the format guide, and the one to read before writing a spec.** Both input files field by field with a complete minimal example each, every field with its Spine meaning, the rules that decide what is emitted, the build → read the report → fix → repeat loop, the map from every named failure to the file that has to change, and the features rigc refuses by name so you do not spend a loop discovering them. It travels **inside the npm package**, at `node_modules/@rig-c/core/docs/AUTHORING.md` |
 | 🦴 **[docs/RIGGING.md](docs/RIGGING.md)** | **authoring the hierarchy.** Where a bone goes and why the art is pushed out on an offset, why a pivot in the wrong place looks like a search failure and what identifies one, moving a pivot and the child row that gets forgotten, gauges, siblings-not-a-chain, what a chain can reach and how many links it needs, why a local key is not a world key, duplicate art at mirrored pivots, and constraints as structure. Every section is a stumble the run records hold more than once, ranked by how often. Ships in the package too |
 | 🎞️ **[docs/MOTION.md](docs/MOTION.md)** | **the key-pose recipe.** How to get two poses, what a pair of poses does and does not fix, the in-betweening rules and where each comes from, and how to spread candidates so a ballot informs. Ships in the package too |
 | 🙂 **[docs/FACE.md](docs/FACE.md)** | **authoring a face.** A blink, a gaze and a 2.5D head turn on plain Spine data: the one line of yaw arithmetic every number in a turn comes from, depth as the parameter you are actually authoring, where to put a grid's columns and the angle at which any grid folds, what foreshortens and what does not, channel allocation before the first key, and the three cliffs with their angles. Also the deform audit gap, demonstrated — a folded mesh gates green — and the differential check that works today |
@@ -836,11 +624,12 @@ letting `A17` blame the editor for the harness's own doing.
 | 🔬 **[docs/SPEC_COVERAGE.md](docs/SPEC_COVERAGE.md)** | **the Spine 4.3 format, field by field.** Every key the 4.3 JSON parser and atlas reader take, what each defaults to, and the parser line it comes from — the rows rigc's refusals cite by part number. Ships in the package too |
 | 🎓 **[the benchmark dossier](https://github.com/rig-c/core/blob/main/docs/BENCHMARK.md)** | **why you can trust the output.** The yardstick, `diff` and `check` and what neither can see, the eight-rung ladder and the spineboy graduation exam, the run viewer, the 50 named assertions with their profiles, and the selftest that has watched every one of them fire. Repository material — it is not in the npm package |
 | 📋 [LADDER.md](https://github.com/rig-c/core/blob/main/docs/LADDER.md) · [GATE.md](https://github.com/rig-c/core/blob/main/docs/GATE.md) · [PILOT.md](https://github.com/rig-c/core/blob/main/docs/PILOT.md) | the live rung ledger, the clause statements a candidate is graded against, and how to run an agent through the ladder and score what comes back |
-| 🔬 [SURVEY_2026-08-22.md](https://github.com/rig-c/core/blob/main/docs/SURVEY_2026-08-22.md) | the survey the ladder was climbed by: rigc and the official examples as measured on 2026-08-22, and the gap list ordered by rung. A dated record, not kept current. Repository material |
 | 🧬 [GENERATIONS.md](https://github.com/rig-c/core/blob/main/docs/GENERATIONS.md) | **Spine data from another generation.** Why a 3.8–4.2 file read as 4.3 fails in silence, the policy that follows (detect from `skeleton.spine`, never guess, play on the matching runtime), what `A16` and `ingest` do with such a file, and the editor as the migration path. Repository material |
 | 📓 [CASES.md](https://github.com/rig-c/core/blob/main/docs/CASES.md) | **converting a Live2D model to Spine, and verifying the conversion.** The method — the source's own player headless, parts from its texture along the drawables, motion baked as deform keys, reference frames first, `check` — run once end to end on two Live2D sample models with no editor and no converter, and verified against the source's renderer and Spine's own runtime: the three instruments, the two rigc defects verifying it led to and v1.2.1 fixed, and where the method stops. Figures only — the models' licence keeps every asset out. Repository material |
 | 🗺️ [ROADMAP.md](https://github.com/rig-c/core/blob/main/ROADMAP.md) | where this is going, and where it has been. What 1.0 had to mean before the number was claimed, and what it was claimed on — conditions rather than a feature list, because direction here comes from what users hit |
-| 📐 [CLAUDE.md](https://github.com/rig-c/core/blob/main/CLAUDE.md) | **the doctrine** — why the validator's messages are the product, why nothing reaches disk before green, why no number is ever invented, and what a change has to keep. [CONTRIBUTING.md](https://github.com/rig-c/core/blob/main/CONTRIBUTING.md) calls it worth ten minutes before a first patch. Repository material |
+| 📐 [CLAUDE.md](https://github.com/rig-c/core/blob/main/CLAUDE.md) | **the doctrine** — why the validator's messages are the product, why nothing reaches disk before green, why no number is ever invented, and what a change has to keep. [the contribution guide](https://github.com/rig-c/core/blob/main/CONTRIBUTING.md) calls it worth ten minutes before a first patch. Repository material |
+
+[Dated survey](https://github.com/rig-c/core/blob/main/docs/SURVEY_2026-08-22.md).
 
 ## Why you can trust the output
 
@@ -862,7 +651,7 @@ attributability is **measured** to be capped below the bar reads down when every
 observable about it is independently verified strict. Every other rung and the
 graduation exam pass on the clause itself. Recompiling a stored candidate reproduces its
 record **to the digit within one gate**; across an instrument change the digits move,
-and [docs/LADDER.md](https://github.com/rig-c/core/blob/main/docs/LADDER.md) records
+and [the gate re-inspection ledger](https://github.com/rig-c/core/blob/main/docs/LADDER.md) records
 where. The standing figures quoted above are from its *gate-v2.4 re-inspection*, which
 is the current sweep.
 
@@ -881,13 +670,13 @@ a from-zero run is a tooling-progress measurement rather than a re-climb, which
 why the certification above is scoped to tool + guide + protocol. One of those
 attempts states the residual in its own words: *"in motion it is not at editor
 quality."* All six, with their verdicts, are in
-[docs/LADDER.md](https://github.com/rig-c/core/blob/main/docs/LADDER.md).
+[the from-zero attempt records](https://github.com/rig-c/core/blob/main/docs/LADDER.md).
 
 The whole dossier — the yardstick, `diff` and `check` and what neither of them can
 see, every rung, the run viewer, the 50 assertions and the selftest behind them — is
 [docs/BENCHMARK.md](https://github.com/rig-c/core/blob/main/docs/BENCHMARK.md).
 Live rung status is
-[docs/LADDER.md](https://github.com/rig-c/core/blob/main/docs/LADDER.md).
+[recorded in the ladder ledger](https://github.com/rig-c/core/blob/main/docs/LADDER.md).
 
 ## Contributing
 
@@ -897,5 +686,4 @@ has to clear before it lands. Releases are cut by release-please —
 
 ## Licence
 
-MIT — see [LICENSE](LICENSE). Third-party terms, including the Spine editor licence
-requirement that this project inherits, are in [NOTICE.md](NOTICE.md).
+See [NOTICE.md](NOTICE.md) for licensing and third-party terms.