@directivegames/genesys.sdk 3.2.2

package/src/templates/scripts/genesys/validate-prefabs.ts

@@ -0,0 +1,138 @@
+import fs from 'fs';
+import path from 'path';
+
+import Ajv, { type ErrorObject } from 'ajv';
+
+import { getProjectRoot } from './common.js';
+
+interface ValidationError {
+  file: string;
+  errors: string[];
+}
+
+function findPrefabFiles(dir: string, prefabFiles: string[] = []): string[] {
+  const files = fs.readdirSync(dir);
+
+  for (const file of files) {
+    const filePath = path.join(dir, file);
+    const stat = fs.statSync(filePath);
+
+    if (stat.isDirectory()) {
+      // Skip node_modules and other common directories that shouldn't contain prefabs
+      if (file === 'node_modules' || file === 'dist' || file === '.git') {
+        continue;
+      }
+      findPrefabFiles(filePath, prefabFiles);
+    } else if (file.endsWith('.prefab.json')) {
+      prefabFiles.push(filePath);
+    }
+  }
+
+  return prefabFiles;
+}
+
+function validatePrefabs() {
+  const projectRoot = getProjectRoot();
+  const schemaPath = path.join(__dirname, 'prefab.schema.json');
+
+  // Load the schema
+  let schema: any;
+  try {
+    const schemaContent = fs.readFileSync(schemaPath, 'utf-8');
+    schema = JSON.parse(schemaContent);
+  } catch (error) {
+    console.error(`❌ Failed to load schema from ${schemaPath}`);
+    console.error(error);
+    process.exit(1);
+  }
+
+  // Initialize Ajv
+  const ajv = new (Ajv as any)({
+    allErrors: true,
+    validateSchema: false // Don't validate the schema itself
+  });
+
+  // Process $ref in the schema to use proper format
+  const processedSchema = JSON.parse(JSON.stringify(schema), (key, value) => {
+    if (key === '$ref' && typeof value === 'string' && !value.startsWith('#')) {
+      return `#/definitions/${value}`;
+    }
+    return value;
+  });
+
+  const validate = ajv.compile(processedSchema);
+
+  // Find all prefab files
+  const prefabFiles = findPrefabFiles(projectRoot);
+
+  if (prefabFiles.length === 0) {
+    console.log('⚠️  No prefab files found in the project.');
+    return;
+  }
+
+  console.log(`Found ${prefabFiles.length} prefab file(s) to validate:\n`);
+
+  const validationErrors: ValidationError[] = [];
+  let validCount = 0;
+
+  // Validate each prefab file
+  for (const prefabPath of prefabFiles) {
+    const relativePath = path.relative(projectRoot, prefabPath);
+
+    try {
+      const prefabContent = fs.readFileSync(prefabPath, 'utf-8');
+      const prefabData = JSON.parse(prefabContent);
+
+      const valid = validate(prefabData);
+
+      if (valid) {
+        console.log(`✅ ${relativePath}`);
+        validCount++;
+      } else {
+        console.log(`❌ ${relativePath}`);
+        const errors = validate.errors?.map((err: ErrorObject) => {
+          const path = (err as any).instancePath ?? '/';
+          const message = err.message ?? 'unknown error';
+          return `  - ${path}: ${message}`;
+        }) ?? [];
+        validationErrors.push({
+          file: relativePath,
+          errors
+        });
+      }
+    } catch (error) {
+      console.log(`❌ ${relativePath} (parse error)`);
+      validationErrors.push({
+        file: relativePath,
+        errors: [`Failed to parse JSON: ${error instanceof Error ? error.message : String(error)}`]
+      });
+    }
+  }
+
+  // Print summary
+  console.log(`\n${'='.repeat(60)}`);
+  console.log('Validation Summary:');
+  console.log(`  Total files: ${prefabFiles.length}`);
+  console.log(`  Valid: ${validCount}`);
+  console.log(`  Invalid: ${validationErrors.length}`);
+  console.log(`${'='.repeat(60)}\n`);
+
+  // Print detailed errors if any
+  if (validationErrors.length > 0) {
+    console.log('Validation Errors:\n');
+    for (const { file, errors } of validationErrors) {
+      console.log(`${file}:`);
+      for (const error of errors) {
+        console.log(error);
+      }
+      console.log('');
+    }
+    process.exit(1);
+  } else {
+    console.log('🎉 All prefab files are valid!');
+  }
+}
+
+// Run validation
+validatePrefabs();
+

package/src/templates/src/index.ts

@@ -0,0 +1,22 @@
+// which items will be copied to the new project, includes files and folders
+export const sharedTemplateItems: string[] = [
+  '.cursor',
+  '.vscode',
+  'scripts/genesys',
+  'gitignore', // npm excludes .gitignore files from packages, so we rename it when copying
+  '.gitattributes',
+  '.cursorignore',
+  'eslint.config.js',
+  'tsconfig.json',
+  'AGENTS.md',
+  'CLAUDE.md',
+  'index.html',
+  'vite.config.ts',
+];
+
+// which items will be deleted from the project, if exists
+export const deletedTemplateItems: string[] = [
+  '.cursorrules'
+];
+
+export * as ENGINE from 'genesys.js';

package/src/templates/src/templates/firstPerson/assets/default.genesys-scene

@@ -0,0 +1,166 @@
+{
+  "$version": 0,
+  "class": "ENGINE.World",
+  "uuid": "c0ae85792bc3b946",
+  "ctor": {
+    "backgroundColor": 3026478,
+    "navigationOptions": {
+      "engine": "recast-navigation",
+      "debug": false,
+      "generateOnStartUp": false
+    },
+    "physicsOptions": {
+      "gravity": [
+        0,
+        -9.81,
+        0,
+        "v"
+      ],
+      "engine": "rapier"
+    },
+    "useManifold": true
+  },
+  "actors": [
+    {
+      "uuid": "9a86d389088b361c",
+      "class": "ENGINE.Actor",
+      "properties": {
+        "editorData": {
+          "displayName": "Directional Light",
+          "hidden": false
+        }
+      },
+      "ctor": {
+        "rootComponent": {
+          "class": "ENGINE.DirectionalLightComponent",
+          "uuid": "cfe05433-9edc-4dfe-a535-c71f33e92d78",
+          "ctor": {
+            "color": 16777215,
+            "intensity": 1,
+            "castShadow": true,
+            "shadowMapSize": 2048,
+            "shadowBias": 0,
+            "shadowNormalBias": 0,
+            "shadowNear": 0.1,
+            "shadowFar": 100
+          },
+          "properties": {
+            "position": [
+              10,
+              50,
+              -10,
+              "v"
+            ],
+            "castShadow": true
+          }
+        }
+      }
+    },
+    {
+      "uuid": "9d428f2a16e5374a",
+      "class": "ENGINE.Actor",
+      "properties": {
+        "editorData": {
+          "displayName": "Ground",
+          "hidden": false
+        }
+      },
+      "ctor": {
+        "rootComponent": {
+          "class": "ENGINE.MeshComponent",
+          "uuid": "71caea24-62d7-4e45-a76e-4c7519de2c3c",
+          "ctor": {
+            "geometry": {
+              "class": "THREE.BoxGeometry",
+              "ctor": [
+                500,
+                0.1,
+                500
+              ]
+            },
+            "material": {
+              "@external": "DefaultMaterial"
+            },
+            "uvScaleTilesPerUnit": 0.2,
+            "physicsOptions": {
+              "enabled": true,
+              "motionType": "static",
+              "collisionProfile": "BlockAll"
+            }
+          },
+          "properties": {
+            "position": [
+              0,
+              -0.9,
+              0,
+              "v"
+            ],
+            "receiveShadow": true
+          }
+        }
+      }
+    },
+    {
+      "uuid": "b87cbc5e60a2e54c",
+      "class": "ENGINE.PlayerStart",
+      "properties": {
+        "editorData": {
+          "displayName": "Player Start",
+          "hidden": false
+        }
+      },
+      "ctor": {
+        "rootComponent": {
+          "class": "ENGINE.SceneComponent",
+          "uuid": "b4d5f8f7-2512-45e1-9157-c7ff6772402d",
+          "ctor": {},
+          "properties": {
+            "position": [
+              0,
+              0.9,
+              0,
+              "v"
+            ]
+          }
+        }
+      }
+    },
+    {
+      "uuid": "0ba1f4677e8370d1",
+      "class": "ENGINE.Actor",
+      "properties": {
+        "editorData": {
+          "displayName": "Skybox",
+          "hidden": false
+        }
+      },
+      "ctor": {
+        "rootComponent": {
+          "class": "ENGINE.SceneComponent",
+          "uuid": "195e88df-73ff-4f4b-82ae-7fb58671463d",
+          "ctor": {},
+          "properties": {},
+          "children": [
+            {
+              "class": "ENGINE.SkyboxComponent",
+              "uuid": "f7e33ae7d5ac74f9",
+              "ctor": {
+                "textureUrl": "@engine/assets/textures/skybox/citrus_orchard_road_puresky_2k.hdr",
+                "width": 2048,
+                "height": 1024,
+                "bottomColor": "#E6F3FF",
+                "middleColor": "#4A90E2",
+                "topColor": "#0F1B3C",
+                "envMapIntensity": 1
+              },
+              "properties": {}
+            }
+          ]
+        }
+      }
+    }
+  ],
+  "properties": {
+    "editorData": {}
+  }
+}

package/src/templates/src/templates/firstPerson/src/game.ts

@@ -0,0 +1,39 @@
+
+import * as ENGINE from 'genesys.js';
+import * as THREE from 'three';
+
+import { FirstPersonPlayer } from './player.js';
+import './auto-imports.js';
+
+class FirstPersonGame extends ENGINE.BaseGameLoop {
+  private pawn: FirstPersonPlayer | null = null;
+  private controller: ENGINE.PlayerController | null = null;
+
+  protected override createLoadingScreen(): ENGINE.ILoadingScreen | null {
+    // enable the default loading screen
+    return new ENGINE.DefaultLoadingScreen();
+  }
+
+  protected override async preStart(): Promise<void> {
+    // default spawn location
+    const position = new THREE.Vector3(0, ENGINE.CHARACTER_HEIGHT / 2, 0);
+
+    // now create the pawn
+    this.pawn = new FirstPersonPlayer({ position });
+
+    // create the controller and possess the pawn
+    this.controller = new ENGINE.PlayerController();
+    this.controller.possess(this.pawn);
+
+    // add both to the world
+    this.world.addActors(this.pawn, this.controller);
+  }
+}
+
+export function main(container: HTMLElement, gameId: string): ENGINE.IGameLoop {
+  const game = new FirstPersonGame(container, {
+    ...ENGINE.BaseGameLoop.DEFAULT_OPTIONS,
+    gameId
+  });
+  return game;
+}

package/src/templates/src/templates/firstPerson/src/player.ts

@@ -0,0 +1,63 @@
+import * as ENGINE from 'genesys.js';
+import * as THREE from 'three';
+
+/**
+ * Options for the FirstPersonPlayer class.
+ * Currently empty, can be extended if needed.
+ */
+export interface FirstPersonPlayerOptions extends ENGINE.PawnOptions {
+}
+
+/**
+ * A first person player class.
+ *
+ * Key points:
+ * - No need to provide movementComponent and camera, they are created internally
+ * - The pawn is set to be transient so it's never saved in the level
+ * - The directional light follows the player for consistent shadows
+ *
+ */
+@ENGINE.GameClass()
+export class FirstPersonPlayer extends ENGINE.Pawn<FirstPersonPlayerOptions> {
+  // No need to provide rootComponent, movementComponent and camera, they are created internally
+  constructor(options: Omit<FirstPersonPlayerOptions, 'rootComponent' | 'movementComponent' | 'camera'>) {
+    // simple camera component - contains a perspective camera by default
+    const camera = new THREE.PerspectiveCamera(ENGINE.CAMERA_FOV, 1, ENGINE.CAMERA_NEAR, ENGINE.CAMERA_FAR);
+    // set proper camera height for first person view
+    camera.position.set(0, ENGINE.CHARACTER_HEIGHT * 0.4, 0);
+
+    // use a simple capsule geometry as the root component
+    const rootComponent = new ENGINE.MeshComponent({
+      geometry: ENGINE.GameBuilder.createDefaultPawnCapsuleGeometry(),
+      material: new THREE.MeshStandardMaterial({ color: ENGINE.Color.YELLOW }),
+      physicsOptions: {
+        enabled: true,
+        // KinematicVelocityBased is required to use the physics character controller
+        motionType: ENGINE.PhysicsMotionType.KinematicVelocityBased,
+        collisionProfile: ENGINE.DefaultCollisionProfile.Pawn,
+        generateCollisionEvents: true,
+      }
+    });
+    // hide the mesh in first person view
+    rootComponent.getMesh().visible = false;
+
+    // create the movement component
+    const movementComponent = new ENGINE.CharacterMovementComponent({
+      ...ENGINE.CharacterMovementComponent.DEFAULT_OPTIONS,
+      movementType: ENGINE.CharacterMovementType.FirstPerson,
+    });
+
+    // construct the pawn
+    super({
+      ...options,
+      rootComponent,
+      movementComponent,
+      // make sure the directional light follows the player for consistent shadows
+      enableDirectionalLightFollowing: true,
+      camera,
+    });
+
+    // set the pawn to be transient so it's never saved in the level
+    this.setTransient(true);
+  }
+}