Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ detail, look there first.
This builds a published example character and plays it. Its painting and layers are
already made, so you skip the GPU steps entirely.

**You'll need:** [Bun](https://bun.sh) 1.2 or later (`bun --version` prints it), and
**You'll need:** [Bun](https://bun.sh) 1.4.0 or later (`bun --version` prints it), and
[uv](https://docs.astral.sh/uv/) for the one Python script in step 6 — or skip the script;
step 6 says how. About 3 minutes of commands, plus the first-time downloads, under 1 GB in
all. The commands are for a macOS or Linux terminal; Windows isn't tested yet.
Expand Down Expand Up @@ -196,14 +196,14 @@ cat > map.json <<'EOF'
"translate": { "bone": "hip", "joint": "mid_hip", "scale": { "pose": ["mid_hip", "neck"], "rig": ["hip", "neck"] } }
}
EOF
bunx rig-pose retarget --rig out/rig --map map.json --pose wave.pose.clean.json --out wave.motion.json --name wave --profile spine-html --build wave-build
bunx rig-pose retarget --rig out/rig --map map.json --pose wave.pose.clean.json --out wave.motion.json --name wave --profile rig-play --build wave-build
mkdir -p wave-rig
cp -R out/rig/. wave-rig/
cp wave.motion.json wave-rig/motion.json
bunx rig-parts check --rig wave-rig --parts out --out wave-check
```

You should see `73 frame(s), 3 s at 24 fps`, `GATE rigc build --profile spine-html: green`, and
You should see `73 frame(s), 3 s at 24 fps`, `GATE rigc build --profile rig-play: green`, and
`FOLD rigc render --folds at 24 fps: no mesh folds`, and
`wrote wave.motion.json — animations: idle, wave`. A `FOLD` line is a reading, not a
failure: where a mesh does fold, it names the part and the frames to look at.
Expand Down Expand Up @@ -754,7 +754,7 @@ complete example are in [docs/KEYPOINTS.md](docs/KEYPOINTS.md).
rebuilds the rig-c trailer, a seated character on a swing, with one script.
- **The packages' own guides**: [`@rig-c/parts` AUTHORING.md](https://github.com/rig-c/parts/blob/main/docs/AUTHORING.md)
(every config field, what each refusal means, expressions and physics),
[`rig-c`](https://github.com/rig-c/core#readme) (the compiler and its check),
[`@rig-c/core`](https://github.com/rig-c/core#readme) (the compiler and its check),
[`@rig-c/pose`](https://github.com/rig-c/pose#readme) (map and pose formats, keypoints from
video), [`@rig-c/play`](https://github.com/rig-c/play#readme) (the player's API and cost).
- [docs/REFERENCE.md](docs/REFERENCE.md): tested-with versions, every measured time and
Expand Down
2 changes: 1 addition & 1 deletion docs/REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -925,7 +925,7 @@ Where a project states no minimum, this says so rather than filling one in.
- **Disk**: measured, 0.12 GB for *Try it first* (the packages, Bun's cache, the example
inputs and every output). The joint script adds about 0.7 GB (Python packages, a Python,
two models).
- **Bun 1.2.0 or later**: the `engines` field of `rig-c`, `@rig-c/parts` and `@rig-c/pose`.
- **Bun 1.4.0 or later**: the declared `engines` requirement of `@rig-c/core`, `@rig-c/parts` and `@rig-c/pose`.
Node and npm are not needed when you install with Bun. `@rig-c/play` states no browser
minimum; measured in Chromium 152.
- **For the joint script**: Python 3.10 or later (rtmlib's package metadata) and
Expand Down
2 changes: 1 addition & 1 deletion scripts/try-it.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ test('an already-current weekly record makes ZERO git, PR or dispatch calls', as
test('registry races, missing installs and incomplete publication refuse', async () => {
expect(() => assertVersions(versions, versions, versions)).not.toThrow();
expect(() => assertVersions({}, versions, versions)).toThrow('installed');
expect(() => assertVersions(versions, versions, { ...versions, 'rig-c': '2.0.0' })).toThrow('latest changed');
expect(() => assertVersions(versions, versions, { ...versions, '@rig-c/core': '2.0.0' })).toThrow('latest changed');
await expect(publish(root, '', { status: 'FAIL' }, () => { throw Error('must not run'); })).rejects.toThrow('incomplete');
});
test('repository TMPDIR is refused, including a symlink resolving into it', () => {
Expand Down
2 changes: 1 addition & 1 deletion scripts/try-it.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { createHash } from 'node:crypto';
import { readFileSync, writeFileSync, mkdirSync, rmSync, copyFileSync, mkdtempSync, realpathSync } from 'node:fs';
import { resolve, join, sep } from 'node:path';

export const packages = ['@rig-c/parts', 'rig-c', '@rig-c/pose', '@rig-c/play'] as const;
export const packages = ['@rig-c/parts', '@rig-c/core', '@rig-c/pose', '@rig-c/play'] as const;
export type Versions = Record<string, string>;
export type Step = { title: string; line: number; text: string; blocks: { command: string; line: number; mode: 'shell' | 'server' | 'not-run'; reason?: string }[] };
const begin = '<!-- try-it-tested:start -->', end = '<!-- try-it-tested:end -->';
Expand Down
Loading