Skip to content

3D engine that AI agents drive

Say three-bridge is on npm now that 0.1.0 is published (#1991)

Nguyen Xuan An75acb0ca5b9b
diff --git a/changes/1991.md b/changes/1991.md
new file mode 100644
index 00000000..3c8912d7
--- /dev/null
+++ b/changes/1991.md
@@ -0,0 +1 @@
+- The three-bridge guide and README say to install `@codepawlhq/crucible-three-bridge` from npm, now that 0.1.0 is published.
diff --git a/docs/three-bridge.md b/docs/three-bridge.md
index c3b9356c..b66d0276 100644
--- a/docs/three-bridge.md
+++ b/docs/three-bridge.md
@@ -4,7 +4,7 @@
Left: the three.js scene. Right: the same scene after `fromThreeObject` turned it into Crucible parts. Geometry, colours, metalness, roughness and the checker texture carry over. Light and sky are not part of the tree: you set them on the Crucible side, so they differ by design.
-`@codepawlhq/crucible-three-bridge` (folder `packages/three-bridge`, not on npm yet: import it from a source checkout) moves meshes between a live three.js object tree and Crucible parts. Use it to try Crucible on a scene you already have, or to hand Crucible parts to code that expects three.js objects. For a GLB you do not need three.js at all: Crucible writes it.
+`@codepawlhq/crucible-three-bridge` (folder `packages/three-bridge`, install it with `npm install @codepawlhq/crucible-three-bridge three`) moves meshes between a live three.js object tree and Crucible parts. Use it to try Crucible on a scene you already have, or to hand Crucible parts to code that expects three.js objects. For a GLB you do not need three.js at all: Crucible writes it.
The addon is optional and not part of the core archive. It imports neither `three` nor Crucible. `three` is a peer dependency of the addon only, and you pass the namespace in when you export.
diff --git a/packages/three-bridge/README.md b/packages/three-bridge/README.md
index cf8080ce..2ea7d488 100644
--- a/packages/three-bridge/README.md
+++ b/packages/three-bridge/README.md
@@ -1,6 +1,6 @@
# @codepawlhq/crucible-three-bridge
-Companion package that imports a three.js object tree as Crucible parts and builds three.js meshes from Crucible parts. It imports neither `three` nor Crucible. `three` is a peer dependency of this package only; the core gains none. Not part of the core `crucible` archive. It is a library, not an addon: it registers nothing, so the MCP server does not load it with `--allow-addon`. It is not on npm yet: import it from this folder in a source checkout.
+Companion package that imports a three.js object tree as Crucible parts and builds three.js meshes from Crucible parts. It imports neither `three` nor Crucible. `three` is a peer dependency of this package only; the core gains none. Not part of the core `crucible` archive. It is a library, not an addon: it registers nothing, so the MCP server does not load it with `--allow-addon`. Install it with `npm install @codepawlhq/crucible-three-bridge three`.
```js
import * as THREE from 'three';
diff --git a/tests/published-site.test.js b/tests/published-site.test.js
index f85ec074..2c4591f7 100644
--- a/tests/published-site.test.js
+++ b/tests/published-site.test.js
@@ -102,15 +102,16 @@ test('the learn pages carry no release URL that the site stops serving', () => {
assert.match(readText('docs/learn/install.md'), /releases\/<version>\/67\.module\.js/);
});
-test('the docs say the two optional packages are not on npm, and each package names its repository folder', () => {
+test('the docs say three-compat is not on npm, three-bridge installs from npm, and each package names its repository folder', () => {
const notes = [
- ['docs/three-bridge.md', 'not on npm yet'],
['docs/learn/if-you-know-three-js.md', 'not on npm yet'],
['public/llms.txt', 'not on npm yet'],
- ['packages/three-bridge/README.md', 'not on npm yet'],
+ ['docs/three-bridge.md', 'npm install @codepawlhq/crucible-three-bridge three'],
+ ['packages/three-bridge/README.md', 'npm install @codepawlhq/crucible-three-bridge three'],
['packages/three-compat/README.md', 'not on npm yet'],
];
for (const [file, phrase] of notes) assert.ok(readText(file).includes(phrase), file);
+ for (const file of ['docs/three-bridge.md', 'packages/three-bridge/README.md']) assert.ok(!readText(file).includes('not on npm'), file);
for (const name of ['denoise-oidn', 'three-bridge', 'three-compat']) {
const pack = JSON.parse(readText(`packages/${name}/package.json`));
assert.equal(pack.repository.directory, `packages/${name}`);