@directivegames/genesys.sdk 4.2.4 → 4.2.5

package/dist/src/dependencies.js

@@ -52,6 +52,7 @@ export const DEV_DEPENDENCIES = {
     '@types/react': '19.2.7',
     '@types/react-dom': '19.2.3',
     '@types/three': '0.182.0',
+    '@types/node': '22.19.1',
     '@types/ws': '8.18.1',
     '@typescript-eslint/eslint-plugin': '8.48.0',
     '@typescript-eslint/parser': '8.48.0',

package/dist/src/templates/scripts/genesys/migrate-scenes-and-prefabs.js

@@ -1,3 +1,17 @@
+/**
+ * Migration script for Genesys scene, prefab, and material files.
+ *
+ * Migration order: Scenes → Prefabs → Materials
+ * This order is important because the engine cannot load new prefab data with old scene data.
+ *
+ * The migration runs TWICE:
+ * - Pass 1: Updates all files to the new format
+ * - Pass 2: Re-processes all files to ensure prefab instances in scenes are saved correctly
+ *           (prefab instances are only serialized properly when both the prefab and scene
+ *           data are at the same version)
+ *
+ * Usage: pnpm migrate (requires running `pnpm build` first to compile game classes)
+ */
 import fs from 'fs';
 import path from 'path';
 import * as ENGINE from '@directivegames/genesys.js';
@@ -148,31 +162,16 @@ async function migrateFile(fileInfo) {
     }
     return 'skipped';
 }
-async function main() {
-    // Game classes are registered via the top-level import of dist/src/game.js
-    // Make sure to run `pnpm build` first!
-    const projectRoot = getProjectRoot();
-    const assetsFolder = path.join(projectRoot, 'assets');
-    console.log(`📁 Scanning for scene and prefab files in: ${assetsFolder}\n`);
-    // Find all scene and prefab files in the assets folder
-    const files = findScenesAndPrefabs(assetsFolder);
-    if (files.length === 0) {
-        console.log('⚠️  No scene or prefab files found.');
-        return;
-    }
-    const prefabFiles = files.filter(f => f.type === 'prefab');
-    const sceneFiles = files.filter(f => f.type === 'scene');
-    const materialFiles = files.filter(f => f.type === 'material');
-    console.log(`Found ${files.length} files to migrate:`);
-    console.log(`  - ${prefabFiles.length} prefab file(s)`);
-    console.log(`  - ${sceneFiles.length} scene file(s)\n`);
-    console.log(`  - ${materialFiles.length} material file(s)\n`);
+async function runMigrationPass(sceneFiles, prefabFiles, materialFiles, passNumber) {
     let successCount = 0;
     let failCount = 0;
-    // Migrate prefabs first
-    if (prefabFiles.length > 0) {
-        console.log('📦 Migrating prefabs...\n');
-        for (const fileInfo of prefabFiles) {
+    console.log(`\n${'='.repeat(60)}`);
+    console.log(`Migration Pass ${passNumber}`);
+    console.log(`${'='.repeat(60)}\n`);
+    // Migrate scenes first (must be done before prefabs to ensure engine can load new prefab data)
+    if (sceneFiles.length > 0) {
+        console.log('🌍 Migrating scenes...\n');
+        for (const fileInfo of sceneFiles) {
             const success = await migrateFile(fileInfo);
             if (success) {
                 successCount++;
@@ -182,10 +181,10 @@ async function main() {
             }
         }
     }
-    // Then migrate scenes
-    if (sceneFiles.length > 0) {
-        console.log('\n🌍 Migrating scenes...\n');
-        for (const fileInfo of sceneFiles) {
+    // Then migrate prefabs
+    if (prefabFiles.length > 0) {
+        console.log('\n📦 Migrating prefabs...\n');
+        for (const fileInfo of prefabFiles) {
             const success = await migrateFile(fileInfo);
             if (success) {
                 successCount++;
@@ -194,7 +193,9 @@ async function main() {
                 failCount++;
             }
         }
-        // Finally migrate materials
+    }
+    // Finally migrate materials
+    if (materialFiles.length > 0) {
         console.log('\n🎨 Migrating materials...\n');
         for (const fileInfo of materialFiles) {
             const success = await migrateFile(fileInfo);
@@ -206,13 +207,41 @@ async function main() {
             }
         }
     }
+    return { successCount, failCount };
+}
+async function main() {
+    // Game classes are registered via the top-level import of dist/src/game.js
+    // Make sure to run `pnpm build` first!
+    const projectRoot = getProjectRoot();
+    const assetsFolder = path.join(projectRoot, 'assets');
+    console.log(`📁 Scanning for scene and prefab files in: ${assetsFolder}\n`);
+    // Find all scene and prefab files in the assets folder
+    const files = findScenesAndPrefabs(assetsFolder);
+    if (files.length === 0) {
+        console.log('⚠️  No scene or prefab files found.');
+        return;
+    }
+    const prefabFiles = files.filter(f => f.type === 'prefab');
+    const sceneFiles = files.filter(f => f.type === 'scene');
+    const materialFiles = files.filter(f => f.type === 'material');
+    console.log(`Found ${files.length} files to migrate:`);
+    console.log(`  - ${sceneFiles.length} scene file(s)`);
+    console.log(`  - ${prefabFiles.length} prefab file(s)`);
+    console.log(`  - ${materialFiles.length} material file(s)`);
+    // Run migration twice to ensure prefab instances in scenes are saved properly
+    // (prefab instances are only saved correctly when both prefab and scene data are the same version)
+    const pass1 = await runMigrationPass(sceneFiles, prefabFiles, materialFiles, 1);
+    const pass2 = await runMigrationPass(sceneFiles, prefabFiles, materialFiles, 2);
+    const totalSuccess = pass1.successCount + pass2.successCount;
+    const totalFail = pass1.failCount + pass2.failCount;
     console.log(`\n${'='.repeat(60)}`);
     console.log('Migration Summary:');
-    console.log(`  Total files: ${files.length}`);
-    console.log(`  Successful: ${successCount}`);
-    console.log(`  Failed: ${failCount}`);
+    console.log(`  Total files per pass: ${files.length}`);
+    console.log(`  Pass 1 - Successful: ${pass1.successCount}, Failed: ${pass1.failCount}`);
+    console.log(`  Pass 2 - Successful: ${pass2.successCount}, Failed: ${pass2.failCount}`);
+    console.log(`  Total - Successful: ${totalSuccess}, Failed: ${totalFail}`);
     console.log(`${'='.repeat(60)}`);
-    if (failCount > 0) {
+    if (totalFail > 0) {
         process.exit(1);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@directivegames/genesys.sdk",
-  "version": "4.2.4",
+  "version": "4.2.5",
   "description": "Genesys SDK - A development toolkit for game development",
   "author": "Directive Games",
   "main": "index.js",
@@ -152,6 +152,7 @@
     "@types/react": "^19.2.0",
     "@types/react-dom": "^19.2.0",
     "@types/three": "^0.182.0",
+    "@types/node": "^22.15.21",
     "@types/ws": "^8.18.1",
     "@typescript-eslint/eslint-plugin": "^8.29.1",
     "@typescript-eslint/parser": "^8.29.1",

package/src/templates/scripts/genesys/migrate-scenes-and-prefabs.ts

@@ -1,3 +1,18 @@
+/**
+ * Migration script for Genesys scene, prefab, and material files.
+ *
+ * Migration order: Scenes → Prefabs → Materials
+ * This order is important because the engine cannot load new prefab data with old scene data.
+ *
+ * The migration runs TWICE:
+ * - Pass 1: Updates all files to the new format
+ * - Pass 2: Re-processes all files to ensure prefab instances in scenes are saved correctly
+ *           (prefab instances are only serialized properly when both the prefab and scene
+ *           data are at the same version)
+ *
+ * Usage: pnpm migrate (requires running `pnpm build` first to compile game classes)
+ */
+
 import fs from 'fs';
 import path from 'path';
 
@@ -174,37 +189,28 @@ async function migrateFile(fileInfo: FileInfo): Promise<'success' | 'failure' |
   return 'skipped';
 }
 
-async function main() {
-  // Game classes are registered via the top-level import of dist/src/game.js
-  // Make sure to run `pnpm build` first!
-
-  const projectRoot = getProjectRoot();
-  const assetsFolder = path.join(projectRoot, 'assets');
-  console.log(`📁 Scanning for scene and prefab files in: ${assetsFolder}\n`);
-
-  // Find all scene and prefab files in the assets folder
-  const files = findScenesAndPrefabs(assetsFolder);
-
-  if (files.length === 0) {
-    console.log('⚠️  No scene or prefab files found.');
-    return;
-  }
-
-  const prefabFiles = files.filter(f => f.type === 'prefab');
-  const sceneFiles = files.filter(f => f.type === 'scene');
-  const materialFiles = files.filter(f => f.type === 'material');
-  console.log(`Found ${files.length} files to migrate:`);
-  console.log(`  - ${prefabFiles.length} prefab file(s)`);
-  console.log(`  - ${sceneFiles.length} scene file(s)\n`);
-  console.log(`  - ${materialFiles.length} material file(s)\n`);
+interface MigrationResult {
+  successCount: number;
+  failCount: number;
+}
 
+async function runMigrationPass(
+  sceneFiles: FileInfo[],
+  prefabFiles: FileInfo[],
+  materialFiles: FileInfo[],
+  passNumber: number
+): Promise<MigrationResult> {
   let successCount = 0;
   let failCount = 0;
 
-  // Migrate prefabs first
-  if (prefabFiles.length > 0) {
-    console.log('📦 Migrating prefabs...\n');
-    for (const fileInfo of prefabFiles) {
+  console.log(`\n${'='.repeat(60)}`);
+  console.log(`Migration Pass ${passNumber}`);
+  console.log(`${'='.repeat(60)}\n`);
+
+  // Migrate scenes first (must be done before prefabs to ensure engine can load new prefab data)
+  if (sceneFiles.length > 0) {
+    console.log('🌍 Migrating scenes...\n');
+    for (const fileInfo of sceneFiles) {
       const success = await migrateFile(fileInfo);
       if (success) {
         successCount++;
@@ -214,10 +220,10 @@ async function main() {
     }
   }
 
-  // Then migrate scenes
-  if (sceneFiles.length > 0) {
-    console.log('\n🌍 Migrating scenes...\n');
-    for (const fileInfo of sceneFiles) {
+  // Then migrate prefabs
+  if (prefabFiles.length > 0) {
+    console.log('\n📦 Migrating prefabs...\n');
+    for (const fileInfo of prefabFiles) {
       const success = await migrateFile(fileInfo);
       if (success) {
         successCount++;
@@ -225,8 +231,10 @@ async function main() {
         failCount++;
       }
     }
+  }
 
-    // Finally migrate materials
+  // Finally migrate materials
+  if (materialFiles.length > 0) {
     console.log('\n🎨 Migrating materials...\n');
     for (const fileInfo of materialFiles) {
       const success = await migrateFile(fileInfo);
@@ -238,14 +246,50 @@ async function main() {
     }
   }
 
+  return { successCount, failCount };
+}
+
+async function main() {
+  // Game classes are registered via the top-level import of dist/src/game.js
+  // Make sure to run `pnpm build` first!
+
+  const projectRoot = getProjectRoot();
+  const assetsFolder = path.join(projectRoot, 'assets');
+  console.log(`📁 Scanning for scene and prefab files in: ${assetsFolder}\n`);
+
+  // Find all scene and prefab files in the assets folder
+  const files = findScenesAndPrefabs(assetsFolder);
+
+  if (files.length === 0) {
+    console.log('⚠️  No scene or prefab files found.');
+    return;
+  }
+
+  const prefabFiles = files.filter(f => f.type === 'prefab');
+  const sceneFiles = files.filter(f => f.type === 'scene');
+  const materialFiles = files.filter(f => f.type === 'material');
+  console.log(`Found ${files.length} files to migrate:`);
+  console.log(`  - ${sceneFiles.length} scene file(s)`);
+  console.log(`  - ${prefabFiles.length} prefab file(s)`);
+  console.log(`  - ${materialFiles.length} material file(s)`);
+
+  // Run migration twice to ensure prefab instances in scenes are saved properly
+  // (prefab instances are only saved correctly when both prefab and scene data are the same version)
+  const pass1 = await runMigrationPass(sceneFiles, prefabFiles, materialFiles, 1);
+  const pass2 = await runMigrationPass(sceneFiles, prefabFiles, materialFiles, 2);
+
+  const totalSuccess = pass1.successCount + pass2.successCount;
+  const totalFail = pass1.failCount + pass2.failCount;
+
   console.log(`\n${'='.repeat(60)}`);
   console.log('Migration Summary:');
-  console.log(`  Total files: ${files.length}`);
-  console.log(`  Successful: ${successCount}`);
-  console.log(`  Failed: ${failCount}`);
+  console.log(`  Total files per pass: ${files.length}`);
+  console.log(`  Pass 1 - Successful: ${pass1.successCount}, Failed: ${pass1.failCount}`);
+  console.log(`  Pass 2 - Successful: ${pass2.successCount}, Failed: ${pass2.failCount}`);
+  console.log(`  Total - Successful: ${totalSuccess}, Failed: ${totalFail}`);
   console.log(`${'='.repeat(60)}`);
 
-  if (failCount > 0) {
+  if (totalFail > 0) {
     process.exit(1);
   }
 }