@myvillage/cli 2.2.0 → 2.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@myvillage/cli",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "MyVillageOS CLI for community developers",
   "type": "module",
   "bin": {

package/src/commands/deploy.js

@@ -463,6 +463,13 @@ async function deployUnityPlatform(projectDir, mvConfig, platform, { gameIdOverr
       buildDir,
       sdkVersion: mvConfig.sdkVersion,
       platform,
+      onStatus: (text) => {
+        preflightSpinner.text = `[${platform}] ${text}`;
+        // Studio streams our stdout into its publish log and isn't a TTY, so
+        // the spinner's text changes never reach the developer there. Print a
+        // plain line too, otherwise the one-time UnityPy install looks like a hang.
+        if (!process.stderr.isTTY) console.log(brand.teal(`  [${platform}] ${text}`));
+      },
     });
     if (preflightResult.skipped) {
       if (preflightResult.fatal) {
@@ -471,7 +478,18 @@ async function deployUnityPlatform(projectDir, mvConfig, platform, { gameIdOverr
       }
       preflightSpinner.warn(`[${platform}] Preflight skipped: ${preflightResult.reason}`);
     } else if (!preflightResult.ok) {
-      preflightSpinner.fail(`[${platform}] Preflight found ${preflightResult.violations.length} violation(s).`);
+      // "preflight_error" / "preflight_crash" mean the scanner itself failed
+      // (couldn't parse the bundle, script crashed). That's on us, not on the
+      // developer's scripts — so don't tell them to rewrite their game.
+      const toolingFailures = preflightResult.violations.filter(
+        (v) => v.kind === 'preflight_error' || v.kind === 'preflight_crash',
+      );
+      const codeViolations = preflightResult.violations.filter((v) => !toolingFailures.includes(v));
+      if (codeViolations.length > 0) {
+        preflightSpinner.fail(`[${platform}] Preflight found ${codeViolations.length} violation(s).`);
+      } else {
+        preflightSpinner.fail(`[${platform}] Preflight could not scan the bundle.`);
+      }
       console.log();
       for (const v of preflightResult.violations) {
         console.log(chalk.red(`  \u2717 ${v.kind}`));
@@ -481,7 +499,12 @@ async function deployUnityPlatform(projectDir, mvConfig, platform, { gameIdOverr
         if (v.reason) console.log(`     ${v.reason}`);
         console.log();
       }
-      console.log(brand.teal('  Fix these scripts to extend MissionBase / use SDK templates, rebuild, and retry.'));
+      if (codeViolations.length > 0) {
+        console.log(brand.teal('  Fix these scripts to extend MissionBase / use SDK templates, rebuild, and retry.'));
+      } else {
+        console.log(brand.teal('  This is a problem with the bundle scanner, not with your game.'));
+        console.log(brand.teal('  Rebuild the bundle in Unity and publish again. If it keeps happening, send the message above to the MyVillage team.'));
+      }
       console.log();
       return { ok: false };
     } else {

package/src/utils/preflight.js

@@ -1,6 +1,6 @@
 import { spawn } from 'child_process';
-import { existsSync, mkdtempSync, readdirSync, statSync, writeFileSync } from 'fs';
-import { tmpdir } from 'os';
+import { existsSync, mkdirSync, mkdtempSync, readdirSync, statSync, writeFileSync } from 'fs';
+import { homedir, tmpdir } from 'os';
 import { dirname, join, resolve } from 'path';
 import { fileURLToPath } from 'url';
 import { getGameKitAllowlist } from './api.js';
@@ -14,6 +14,91 @@ const PREFLIGHT_SCRIPT = resolve(__dirname, '../../tools/preflight/preflight.py'
 
 const PYTHON_CANDIDATES = ['python3', 'python'];
 
+// The bundle scanner needs UnityPy. Rather than asking every game developer to
+// pip-install it by hand (the #1 reason deploys failed with "preflight_error"),
+// we install it once into a private venv under ~/.myvillage and reuse it.
+const UNITYPY_SPEC = 'UnityPy==1.25.0';
+const PREFLIGHT_VENV_DIR = join(homedir(), '.myvillage', 'tools', 'preflight-venv');
+
+function venvPython(dir) {
+  return process.platform === 'win32' ? join(dir, 'Scripts', 'python.exe') : join(dir, 'bin', 'python');
+}
+
+/** Run a command, capture output, never throw. */
+function runCapture(cmd, args) {
+  return new Promise((resolveRun) => {
+    let stdout = '';
+    let stderr = '';
+    let proc;
+    try {
+      proc = spawn(cmd, args, { stdio: ['ignore', 'pipe', 'pipe'] });
+    } catch (err) {
+      resolveRun({ code: -1, stdout, stderr: err.message });
+      return;
+    }
+    proc.stdout.on('data', (b) => { stdout += b.toString(); });
+    proc.stderr.on('data', (b) => { stderr += b.toString(); });
+    proc.on('error', (err) => resolveRun({ code: -1, stdout, stderr: err.message }));
+    proc.on('exit', (code) => resolveRun({ code, stdout, stderr }));
+  });
+}
+
+async function hasUnityPy(python) {
+  const r = await runCapture(python, ['-c', 'import UnityPy']);
+  return r.code === 0;
+}
+
+function lastLine(text) {
+  const lines = (text || '').trim().split(/\r?\n/).filter(Boolean);
+  return lines.length ? lines[lines.length - 1] : '';
+}
+
+/**
+ * Find a Python that can import UnityPy, installing it if needed.
+ *
+ * Order: our managed venv → a system Python that already has UnityPy →
+ * create the managed venv with the system Python and pip-install UnityPy.
+ * `onStatus(text)` is called with progress copy for the caller's spinner.
+ *
+ * Returns { python } on success, or { python: null, reason } when there's no
+ * usable interpreter — the caller decides whether that skips or blocks.
+ */
+export async function ensurePreflightPython({ onStatus } = {}) {
+  const managed = venvPython(PREFLIGHT_VENV_DIR);
+  if (existsSync(managed) && await hasUnityPy(managed)) return { python: managed };
+
+  const system = await findPython();
+  if (!system) {
+    return {
+      python: null,
+      reason: 'Python 3 was not found on your PATH. Install Python 3.9+ from python.org (on Windows, tick "Add to PATH"), then publish again.',
+    };
+  }
+  if (await hasUnityPy(system)) return { python: system };
+
+  const manualHint = `${system} -m pip install "${UNITYPY_SPEC}"`;
+
+  onStatus?.('First publish from this computer: setting up the bundle scanner (one-time, about a minute)...');
+  mkdirSync(PREFLIGHT_VENV_DIR, { recursive: true });
+  const venv = await runCapture(system, ['-m', 'venv', PREFLIGHT_VENV_DIR]);
+  if (venv.code !== 0 || !existsSync(managed)) {
+    return {
+      python: null,
+      reason: `Could not create a Python environment at ${PREFLIGHT_VENV_DIR} (${lastLine(venv.stderr) || `exit ${venv.code}`}). Repair your Python install or run: ${manualHint}`,
+    };
+  }
+
+  onStatus?.('Installing the bundle scanner (UnityPy)...');
+  const pip = await runCapture(managed, ['-m', 'pip', 'install', '--disable-pip-version-check', '--quiet', UNITYPY_SPEC]);
+  if (pip.code !== 0 || !(await hasUnityPy(managed))) {
+    return {
+      python: null,
+      reason: `Could not install ${UNITYPY_SPEC} (${lastLine(pip.stderr) || `exit ${pip.code}`}). Check your network connection and retry, or run: ${manualHint}`,
+    };
+  }
+  return { python: managed };
+}
+
 /**
  * Find the first usable Python interpreter on PATH.
  * Returns the command name (e.g. "python3") or null if none works.
@@ -94,11 +179,11 @@ async function runPreflight(python, bundlePath, allowlistPath) {
  * Run preflight against all AssetBundles in a build directory.
  *
  * Returns:
- *   { skipped: true, reason }        — bundles couldn't be checked (no SDK, no Python, etc.)
+ *   { skipped: true, reason }        — bundles couldn't be checked (no SDK, no usable Python, etc.)
  *   { ok: true, bundlesChecked }     — all bundles passed
  *   { ok: false, violations, bundle } — at least one violation found
  */
-export async function preflightBundles({ buildDir, sdkVersion, platform }) {
+export async function preflightBundles({ buildDir, sdkVersion, platform, onStatus }) {
   if (!sdkVersion) {
     return { skipped: true, reason: 'No sdkVersion in myvillage.json — preflight only runs for SDK-based games.' };
   }
@@ -109,12 +194,13 @@ export async function preflightBundles({ buildDir, sdkVersion, platform }) {
     return { skipped: true, reason: `preflight.py not found at ${PREFLIGHT_SCRIPT} — CLI install may be incomplete.` };
   }
 
-  const python = await findPython();
+  // No usable Python (or UnityPy couldn't be installed) is a *tooling* gap on
+  // the developer's machine, never a problem with their game. Skip with a clear
+  // warning instead of blocking — the same outcome for "no Python at all" and
+  // "Python but no UnityPy", which used to diverge (one skipped, one failed).
+  const { python, reason: pythonReason } = await ensurePreflightPython({ onStatus });
   if (!python) {
-    return {
-      skipped: true,
-      reason: 'Python 3 not found on PATH. Install Python 3.9+ and then run: pip install UnityPy==1.25.0',
-    };
+    return { skipped: true, reason: `${pythonReason} (Bundle scan skipped; the platform re-checks on upload.)` };
   }
 
   let allowlistResponse;

package/src/utils/templates.js

@@ -12,7 +12,7 @@ const GAME_ART_DIR = join(dirname(fileURLToPath(import.meta.url)), '..', 'assets
 
 // GameKit SDK version that scaffolded Unity projects pin to.
 // Bump alongside CLI minor releases as the SDK contract evolves.
-const GAMEKIT_SDK_VERSION = '1.1.0-alpha.4';
+const GAMEKIT_SDK_VERSION = '1.1.0-alpha.5';
 const GAMEKIT_SDK_URL =
   `https://github.com/MyVillage-Project-Technologies/myvillage-gamekit.git#v${GAMEKIT_SDK_VERSION}`;
 
@@ -1302,7 +1302,7 @@ export async function createUnityGameProject(targetDir, options) {
   // Unity project files. When the SDK is embedded it must NOT also be listed as
   // a manifest dependency (Unity would try to re-resolve it); when it isn't, the
   // git-URL entry is the fallback resolution path.
-  writeFileSync(join(targetDir, 'Packages/manifest.json'), generateUnityPackagesManifest(sdkEmbedded));
+  writeFileSync(join(targetDir, 'Packages/manifest.json'), generateUnityPackagesManifest(sdkEmbedded, unityVersion));
   writeFileSync(join(targetDir, 'ProjectSettings/ProjectVersion.txt'), generateUnityProjectVersion(unityVersion));
 
   // Starter mission. New devs subclass MissionBase here.
@@ -1367,7 +1367,59 @@ public static class MyVillageOrientation
 
 // ── Unity (GameKit SDK) ─────────────────────────────────────────────
 
-function generateUnityPackagesManifest(sdkEmbedded = true) {
+// Unity's built-in engine modules. A project created through Unity Hub lists
+// every one of these in Packages/manifest.json; a manifest that omits them
+// DISABLES them. An earlier version of this scaffold wrote only the registry
+// packages, so fresh projects had no Particle System, Terrain, Animation,
+// Tilemap, Physics2D, Video, ... and developers had to hand-restore them.
+const UNITY_BUILTIN_MODULES = [
+  'accessibility',
+  'ai',
+  'androidjni',
+  'animation',
+  'assetbundle',
+  'audio',
+  'cloth',
+  'director',
+  'imageconversion',
+  'imgui',
+  'jsonserialize',
+  'particlesystem',
+  'physics',
+  'physics2d',
+  'screencapture',
+  'terrain',
+  'terrainphysics',
+  'tilemap',
+  'ui',
+  'uielements',
+  'umbra',
+  'unityanalytics',
+  'unitywebrequest',
+  'unitywebrequestassetbundle',
+  'unitywebrequestaudio',
+  'unitywebrequesttexture',
+  'unitywebrequestwww',
+  'vehicles',
+  'video',
+  'vr',
+  'wind',
+  'xr',
+];
+
+// Visual Scripting version pinned in the scaffold manifest. Keep in sync with
+// the `com.unity.visualscripting` dependency in the GameKit's package.json —
+// GameKit's MyVillage.GameKit.VisualScripting assembly references it, and an
+// embedded package's own dependency isn't enough on its own for Unity to keep
+// it resolved, so the manifest lists it explicitly.
+const UNITY_VISUAL_SCRIPTING_VERSION = '1.9.4';
+
+function unityMajor(unityVersion) {
+  const m = /^(\d+)\./.exec(unityVersion || '');
+  return m ? Number(m[1]) : 6000;
+}
+
+function generateUnityPackagesManifest(sdkEmbedded = true, unityVersion = UNITY_EDITOR_VERSION_FALLBACK) {
   const dependencies = {};
   // Only declare the SDK as a git dependency when it could NOT be embedded
   // locally. When embedded under Packages/com.myvillage.gamekit/, Unity
@@ -1378,11 +1430,25 @@ function generateUnityPackagesManifest(sdkEmbedded = true) {
   Object.assign(dependencies, {
     'com.unity.feature.development': '1.0.2',
     'com.unity.render-pipelines.universal': '17.2.0',
-    'com.unity.textmeshpro': '3.0.6',
     'com.unity.inputsystem': '1.14.2',
+    // GameKit ships Visual Scripting units (CompleteMission, ReadConfig, ...).
+    // Without this package the SDK's VisualScripting assembly can't compile.
+    'com.unity.visualscripting': UNITY_VISUAL_SCRIPTING_VERSION,
     'com.unity.ide.rider': '3.0.38',
     'com.unity.ide.visualstudio': '2.0.22',
   });
+  // Unity 6 folded TextMesh Pro into com.unity.ugui 2.x; declaring the old
+  // standalone com.unity.textmeshpro there triggers a deprecation conflict.
+  // Older editors still need the standalone package.
+  if (unityMajor(unityVersion) >= 6000) {
+    dependencies['com.unity.ugui'] = '2.0.0';
+  } else {
+    dependencies['com.unity.ugui'] = '1.0.0';
+    dependencies['com.unity.textmeshpro'] = '3.0.6';
+  }
+  for (const mod of UNITY_BUILTIN_MODULES) {
+    dependencies[`com.unity.modules.${mod}`] = '1.0.0';
+  }
   return JSON.stringify({ dependencies }, null, 2) + '\n';
 }
 

package/tools/preflight/README.md

@@ -16,7 +16,7 @@ Requires **Python 3.9+** and **UnityPy 1.25.0** (specifically — newer versions
 pip install -r requirements.txt
 ```
 
-The CLI checks for `python3` and `UnityPy` automatically and prints install hints if either is missing.
+The CLI finds `python3`/`python` on PATH and, if UnityPy isn't importable, installs it once into a private venv at `~/.myvillage/tools/preflight-venv/` (see `ensurePreflightPython` in `src/utils/preflight.js`). If Python is missing or the install fails, preflight is skipped with a warning and the upload proceeds; the ed-platform re-checks on upload.
 
 ## Run directly (for debugging)