multiplane 0.3.1 → 0.3.3

package/README.en.md

@@ -254,6 +254,8 @@ npx multiplane stills shot.html --every 0.5
 
 ## 3D layer
 
+The desktop app and its bundled command already include three.js (pinned at 0.180.0) for the 3D layer; nothing else to install. With the npm package, three.js is an optional dependency that projects using the 3D layer install themselves:
+
 ```sh
 npm install three@0.180.0
 ```

package/README.md

@@ -254,6 +254,8 @@ npx multiplane stills shot.html --every 0.5
 
 ## 三维层
 
+用桌面软件或它自带的命令行渲染时，三维层要用的 three.js（固定 0.180.0）已经带在软件里，不用另装。通过 npm 使用时，three.js 是可选依赖，用三维层的项目自己装：
+
 ```sh
 npm install three@0.180.0
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "multiplane",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "type": "module",
   "license": "Apache-2.0",
   "publishConfig": {

package/skills/multiplane/SKILL.md

@@ -117,7 +117,7 @@ Use `/* multiplane-disable-next-line css_animation */` in CSS and `<!-- multipla
 
 ## 3D layer (optional)
 
-Use `multiplane/three` when you need 3D cards or depth of field. Install `three@0.180.0` in the project (`npm install three@0.180.0`).
+Use `multiplane/three` when you need 3D cards or depth of field. When the renderer is the desktop app's bundled command, three.js 0.180.0 is already included. With the npm package, install `three@0.180.0` in the project (`npm install three@0.180.0`). `multiplane doctor` reports whether three.js is available, its version and where it comes from.
 
 ```html
 <script type="importmap">{"imports":{

package/src/doctor.mjs

@@ -3,6 +3,7 @@ import { runCommand } from './events.mjs';
 import { launchBrowser, environment, warnGpuFallback } from './environment.mjs';
 import { inspectFFmpeg, ffmpegOutput } from './ffmpeg.mjs';
 import { MultiplaneError } from './errors.mjs';
+import { threeCheck } from './three-package.mjs';
 
 export function benchmarkCheck(record, machine) {
   const current = validBenchmark(record, machine);
@@ -48,8 +49,7 @@ export const doctor = (options = {}) => runCommand('doctor', null, options, asyn
     for (const name of ['libvpx-vp9', 'prores_ks']) checks.push({ name, ok: false, detail: `${name} is optional; encoder availability could not be inspected.` });
   }
   if (info) events.emit('environment', { ...info, ffmpeg: ffmpeg ?? null });
-  try { await import('three'); checks.push({ name: 'three', ok: true, detail: 'Optional three.js is available.' }); }
-  catch { checks.push({ name: 'three', ok: false, detail: 'Optional three.js is not installed.' }); }
+  checks.push(await threeCheck());
   if (failure && checks.some(c => ['ffmpeg', 'libx264'].includes(c.name) && !c.ok)) failure.hint = (failure.hint ? failure.hint + ' ' : '') + 'Run multiplane config set ffmpeg <path> to save an FFmpeg executable.';
   if (failure) { failure.result = { data: { checks, config: events.config } }; throw failure; }
   return { checks, config: events.config };

package/src/server.mjs

@@ -5,6 +5,7 @@ import { stat, readdir } from 'node:fs/promises';
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { MultiplaneError, invalidOption } from './errors.mjs';
+import { resolveThree } from './three-package.mjs';
 
 export const root = process.cwd();
 const packageRoot = fileURLToPath(new URL('../', import.meta.url));
@@ -52,7 +53,7 @@ export async function startServer(port = 0, root = process.cwd()) {
         if (pathname.startsWith('/multiplane/runtime/')) { resourceRoot = path.join(packageRoot, 'src/runtime'); resourcePath = pathname.slice('/multiplane/runtime'.length); }
         else if (pathname === '/multiplane/three.js') { resourceRoot = path.join(packageRoot, 'src/three'); resourcePath = '/index.js'; }
         else if (pathname.startsWith('/multiplane/vendor/three/')) {
-          resourceRoot = path.dirname(path.dirname(fileURLToPath(import.meta.resolve('three'))));
+          resourceRoot = (await resolveThree()).root;
           resourcePath = pathname.slice('/multiplane/vendor/three'.length);
           if (!/^\/(build|examples\/jsm)\/.*\.js$/.test(resourcePath)) { res.writeHead(403); return res.end(); }
         } else { res.writeHead(404); return res.end(); }

package/src/three-package.mjs

@@ -0,0 +1,26 @@
+import { readFile } from 'node:fs/promises';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+// Desktop bundles keep the tested subset separate from optional npm peers.
+export async function resolveThree() {
+  let root = fileURLToPath(new URL('../vendor/three/', import.meta.url));
+  let source = 'bundled';
+  let pkg;
+  try { pkg = JSON.parse(await readFile(path.join(root, 'package.json'), 'utf8')); }
+  catch (error) {
+    if (error.code !== 'ENOENT') throw error;
+    root = path.dirname(path.dirname(fileURLToPath(import.meta.resolve('three'))));
+    pkg = JSON.parse(await readFile(path.join(root, 'package.json'), 'utf8'));
+    source = 'project';
+  }
+  return { root, version: pkg.version, source };
+}
+
+export async function threeCheck() {
+  try {
+    const { root, version, source } = await resolveThree();
+    await readFile(path.join(root, 'build/three.module.js'));
+    return { name: 'three', ok: true, detail: `three.js ${version} is available (${source === 'bundled' ? 'bundled with software' : 'installed by project'}).` };
+  } catch { return { name: 'three', ok: false, detail: 'Optional three.js is not installed.' }; }
+}