diff --git a/README.md b/README.md index 29f136f..9ed59db 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ Inside this repository, output is restricted to `_site/` or `dist/`; an external The builder copies **only this repository's** `assets/`, `demos/`, `styles.css` and `CNAME`, byte for byte. It never reads a sibling checkout or runs the media scripts. Site-authoring Markdown, scripts and configuration are not published; the static demo bundle intentionally preserves its own README and licence notice. Generated HTML/Markdown, redirect stubs, `llms*.txt`, `robots.txt` and `sitemap.xml` belong exclusively in the output directory and must be removed from source tracking during migration; authored `assets/`, `styles.css` and `CNAME` stay tracked. Actions publishes an already-rendered artifact without Jekyll. It does not need `.nojekyll`, and the official upload action excludes dotfiles, so the builder emits none and rejects hidden artifact files or symlinks rather than silently publishing an incomplete file set. -The landing HTML gives each adapter version its own escaped `` item separated by `
`. Its Markdown table remains one physical line per row, followed by a plain per-package list of all eight independently resolved packages; the same list appears in `llms.txt` and `llms-full.txt`. `@rig-c/core` and `@rig-c/adapters` are labels/aliases, not additional latest lookups. Docs badges and structured docs versions use the same build-time registry map. Recorded demo versions remain pinned to their sources. +The landing HTML gives each adapter version its own escaped `` item separated by `
`. Its Markdown table remains one physical line per row, followed by a plain per-package list of all eight independently resolved packages; the same list appears in `llms.txt` and `llms-full.txt`. The eight canonical registry identities are `@rig-c/core`, `@rig-c/parts`, `@rig-c/pose`, `@rig-c/review`, `@rig-c/play`, `@rig-c/pixi`, `@rig-c/phaser` and `@rig-c/three`. Core resolves the real scoped manifest; convenience name `rig-c` is not a separate lookup. The adapters heading groups three real packages; there is no `@rig-c/adapters` npm package. Convenience install names and legacy `spine-*` names are documented separately from canonical identities and executable names. `@rig-c/pose` provides the `rig-pose` executable; the proposed unscoped convenience package remains pending publication and verification. Docs badges and structured docs versions use the same build-time registry map. Recorded demo versions remain pinned to their sources. ## Link checks diff --git a/content/docs/core.md b/content/docs/core.md index cfa0da7..1c13c86 100644 --- a/content/docs/core.md +++ b/content/docs/core.md @@ -1,13 +1,13 @@ --- navLabel: Core -title: rig-c core — a 2D rig compiler with a named-assertion gate +title: "@rig-c/core — a 2D rig compiler with a named-assertion gate" description: rigc compiles a rig spec and a motion spec into Spine 4.3 skeleton data, and writes nothing unless every named assertion passes. -summaryForLlms: rig-c (also @rig-c/core, CLI rigc) compiles a JSON rig spec and motion spec plus loose part PNGs into Spine 4.3 skeleton data, gated by named assertions so nothing invalid is written. -packageName: rig-c +summaryForLlms: "@rig-c/core (convenience install name rig-c, CLI rigc) compiles a JSON rig spec and motion spec plus loose part PNGs into Spine 4.3 skeleton data, gated by named assertions so nothing invalid is written." +packageName: "@rig-c/core" repoUrl: https://github.com/rig-c/core -npmUrl: https://www.npmjs.com/package/rig-c +npmUrl: https://www.npmjs.com/package/@rig-c/core --- -# rig-c core (`rigc`) +# @rig-c/core (`rigc`)

The compiler: a rig spec and a motion spec in, Spine 4.3 skeleton data out — and nothing written unless every named check passes.

@@ -129,11 +129,11 @@ The published package links no Spine runtime, so `A00_ROUNDTRIP_PARSE` — Spine ## Install ```sh -bun add -d rig-c +bun add -d @rig-c/core bun rigc build --rig rig.json --motion motion.json --out build/ ``` -The published 2.74.0 package declares Bun 1.4.0 or later. The npm package is `rig-c`; `@rig-c/core` is the same package under the scope, and the command is `rigc`. Licensing by playback path: [Licensing](/docs/licensing/). +The published 2.74.0 package declares Bun 1.4.0 or later. The canonical npm package is `@rig-c/core`; `rig-c` is its convenience install name, and the command is `rigc`. Published legacy name `spine-rigc` remains a compatibility entry point; see [package names and aliases](/#package-names-and-aliases). Licensing by playback path: [Licensing](/docs/licensing/). ## Inputs and outputs @@ -160,7 +160,7 @@ The published 2.74.0 package declares Bun 1.4.0 or later. The npm package is `ri - [docs/AUTHORING.md](https://github.com/rig-c/core/blob/main/docs/AUTHORING.md) — the format guide; read it before writing a spec - [docs/RIGGING.md](https://github.com/rig-c/core/blob/main/docs/RIGGING.md) · [docs/MOTION.md](https://github.com/rig-c/core/blob/main/docs/MOTION.md) · [docs/FACE.md](https://github.com/rig-c/core/blob/main/docs/FACE.md) · [docs/INGEST.md](https://github.com/rig-c/core/blob/main/docs/INGEST.md) · [docs/PROMPTING.md](https://github.com/rig-c/core/blob/main/docs/PROMPTING.md) - [docs/BENCHMARK.md](https://github.com/rig-c/core/blob/main/docs/BENCHMARK.md) — why you can trust the output, and the 50 assertions with their profiles -- [npm: rig-c](https://www.npmjs.com/package/rig-c) · [CHANGELOG.md](https://github.com/rig-c/core/blob/main/CHANGELOG.md) +- [npm: @rig-c/core](https://www.npmjs.com/package/@rig-c/core) · [CHANGELOG.md](https://github.com/rig-c/core/blob/main/CHANGELOG.md) - Start here: [/docs/getting-started/](/docs/getting-started/)