@directivegames/genesys.sdk 3.2.2 → 3.2.4

package/README.md

@@ -1,60 +1,60 @@
-[![CI](https://github.com/directivegames/genesys.sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/directivegames/genesys.sdk/actions/workflows/ci.yml)
-[![Publish](https://github.com/directivegames/genesys.sdk/actions/workflows/publish.yml/badge.svg)](https://github.com/directivegames/genesys.sdk/actions/workflows/publish.yml)
-
-![Version](https://gist.githubusercontent.com/haowang1013/d024d16ac57a7bfd7038ae32bf239d07/raw/genesys.sdk.svg)
-
-# User Workflow
-- Download and install the latest version from the [Release](https://github.com/directivegames/genesys.sdk/releases) page.
-- Create an empty folder on your disk to store the project.
-- Open the empty folder created earlier in this app, select a template and create a project, then start the file server.
-- Launch the web editor and cursor to develop.
-
-# Developer
-
-## Run Locally
-- `pnpm install`
-- `pnpm dev`: to run the dev version, connects to localhost:3000 if available
-  - run `pnpm dev` on [genesys.ai](https://github.com/directivegames/genesys.ai) to start localhost:3000
-  - if localhost:3000 is started after the sdk, refresh the sdk with Ctrl+R/Ctrl+Shift+R
-- `pnpm dev:watch`: same as `pnpm dev` but with auto-restart on file changes using nodemon
-- `pnpm dev:hosted`: connects to the hosted genesys.ai site.
-- `pnpm dist`: to build the app locally. Installer will be generated in the `dist` folder that you can use to install the app directly on your machine.
-
-## CLI Tools
-The SDK includes command-line tools for creating and building projects without launching the GUI.
-
-### Available Commands
-```bash
-# Show help and available commands
-genesys-sdk --help
-
-# Show version
-genesys-sdk --version
-
-# Create a new project
-genesys-sdk new -n <project-name> -t <template-id> [-p <parent-path>]
-
-# Build an existing project (with TypeScript type checking)
-genesys-sdk build [-p <project-path>]
-
-# Build without type checking (faster)
-genesys-sdk build [-p <project-path>] --no-tsc
-
-# List available project templates
-genesys-sdk list-templates
-```
-
-## New Project Template
-- The logic to setup a new project is in [new-project.ts](src/backend/tools//new-project.ts), it contains a few steps:  
-  - Generate `game.ts` and `default.genesys-scene` based on the selected template.
-  - Generate `package.json` and `{project}.code-workspace` from code.
-  - Copy the files from `assets/new-project` to the project folder.
-  - Run `pnpm install` and `pnpm build` in the project folder.
-
-## Add Electron API
-Electron API is for exposing code that relies on the nodejs environment to the frontend environment.
-
-To add a new one, following this:
-- Define the API in [api.ts](src/api.ts)
-- Add the API wrapper in [preload.ts](src/preload.ts)
-- Implement the API in [handler.ts](src/backend/handler.ts)
+[![CI](https://github.com/directivegames/genesys.sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/directivegames/genesys.sdk/actions/workflows/ci.yml)
+[![Publish](https://github.com/directivegames/genesys.sdk/actions/workflows/publish.yml/badge.svg)](https://github.com/directivegames/genesys.sdk/actions/workflows/publish.yml)
+
+![Version](https://gist.githubusercontent.com/haowang1013/d024d16ac57a7bfd7038ae32bf239d07/raw/genesys.sdk.svg)
+
+# User Workflow
+- Download and install the latest version from the [Release](https://github.com/directivegames/genesys.sdk/releases) page.
+- Create an empty folder on your disk to store the project.
+- Open the empty folder created earlier in this app, select a template and create a project, then start the file server.
+- Launch the web editor and cursor to develop.
+
+# Developer
+
+## Run Locally
+- `pnpm install`
+- `pnpm dev`: to run the dev version, connects to localhost:3000 if available
+  - run `pnpm dev` on [genesys.ai](https://github.com/directivegames/genesys.ai) to start localhost:3000
+  - if localhost:3000 is started after the sdk, refresh the sdk with Ctrl+R/Ctrl+Shift+R
+- `pnpm dev:watch`: same as `pnpm dev` but with auto-restart on file changes using nodemon
+- `pnpm dev:hosted`: connects to the hosted genesys.ai site.
+- `pnpm dist`: to build the app locally. Installer will be generated in the `dist` folder that you can use to install the app directly on your machine.
+
+## CLI Tools
+The SDK includes command-line tools for creating and building projects without launching the GUI.
+
+### Available Commands
+```bash
+# Show help and available commands
+genesys-sdk --help
+
+# Show version
+genesys-sdk --version
+
+# Create a new project
+genesys-sdk new -n <project-name> -t <template-id> [-p <parent-path>]
+
+# Build an existing project (with TypeScript type checking)
+genesys-sdk build [-p <project-path>]
+
+# Build without type checking (faster)
+genesys-sdk build [-p <project-path>] --no-tsc
+
+# List available project templates
+genesys-sdk list-templates
+```
+
+## New Project Template
+- The logic to setup a new project is in [new-project.ts](src/backend/tools//new-project.ts), it contains a few steps:  
+  - Generate `game.ts` and `default.genesys-scene` based on the selected template.
+  - Generate `package.json` and `{project}.code-workspace` from code.
+  - Copy the files from `assets/new-project` to the project folder.
+  - Run `pnpm install` and `pnpm build` in the project folder.
+
+## Add Electron API
+Electron API is for exposing code that relies on the nodejs environment to the frontend environment.
+
+To add a new one, following this:
+- Define the API in [api.ts](src/api.ts)
+- Add the API wrapper in [preload.ts](src/preload.ts)
+- Implement the API in [handler.ts](src/backend/handler.ts)

package/dist/src/core/cli.js

@@ -276,28 +276,28 @@ async function main() {
         printTemplates();
     });
     // Add examples to help
-    program.addHelpText('after', `
-Examples:
-  # Create a new FPS game project in current directory
-  $ genesys-sdk new -n my-fps-game -t fps
-
-  # Create a new FPS game project in a specific directory
-  $ genesys-sdk new -p ./projects -n my-fps-game -t fps
-
-  # Build current directory project with type checking
-  $ genesys-sdk build
-
-  # Build a specific project with type checking
-  $ genesys-sdk build -p ./projects/my-game
-
-  # Create a new asset pack in current directory
-  $ genesys-sdk new-asset-pack -n my-asset-pack
-
-  # Create a new asset pack in a specific directory
-  $ genesys-sdk new-asset-pack -p ./packs -n my-asset-pack
-  
-  # List all available templates
-  $ genesys-sdk list-templates
+    program.addHelpText('after', `
+Examples:
+  # Create a new FPS game project in current directory
+  $ genesys-sdk new -n my-fps-game -t fps
+
+  # Create a new FPS game project in a specific directory
+  $ genesys-sdk new -p ./projects -n my-fps-game -t fps
+
+  # Build current directory project with type checking
+  $ genesys-sdk build
+
+  # Build a specific project with type checking
+  $ genesys-sdk build -p ./projects/my-game
+
+  # Create a new asset pack in current directory
+  $ genesys-sdk new-asset-pack -n my-asset-pack
+
+  # Create a new asset pack in a specific directory
+  $ genesys-sdk new-asset-pack -p ./packs -n my-asset-pack
+  
+  # List all available templates
+  $ genesys-sdk list-templates
 `);
     // Parse arguments
     await program.parseAsync(process.argv);

package/dist/src/templates/scripts/genesys/genesys-mcp.js

@@ -27,9 +27,9 @@ const server = new McpServer({
         logging: {} // to support sendLoggingMessage
     }
 });
-const classRule = `
-The class name should start with '${ENGINE.Prefix.GAME}' or '${ENGINE.Prefix.ENGINE}' to indicate if it is a class from game project or engine. 
-If it starts with neither, it will be matched against all registered classes. If none is found, an error will be returned.
+const classRule = `
+The class name should start with '${ENGINE.Prefix.GAME}' or '${ENGINE.Prefix.ENGINE}' to indicate if it is a class from game project or engine. 
+If it starts with neither, it will be matched against all registered classes. If none is found, an error will be returned.
 `;
 function requestEditorReload(editorId) {
     const ws = getClientWebSocket(editorId);
@@ -126,12 +126,12 @@ server.registerTool('addGltf', {
     inputSchema: {
         editorId: EditorIdSchema,
         gltfs: z.array(z.object({
-            path: z.string().describe(`Path or URL to the GLTF model to add. 
-Unless explicitly told by user, otherwise it should always be one of these
-- fetched from the result of searchAssets tool
-- copied from an existing path of an existing placed GLTF actor.
-- use a verified URL to a GLTF model
-Never make up a relative path to a file, because that won't be resolved by the editor.
+            path: z.string().describe(`Path or URL to the GLTF model to add. 
+Unless explicitly told by user, otherwise it should always be one of these
+- fetched from the result of searchAssets tool
+- copied from an existing path of an existing placed GLTF actor.
+- use a verified URL to a GLTF model
+Never make up a relative path to a file, because that won't be resolved by the editor.
 `),
             transform: TransformSchema.optional().describe('Transform of the GLTF model'),
             info: ActorInfoSchema.describe('Information about the GLTF model actor.'),
@@ -208,11 +208,11 @@ server.registerTool('placePrefab', {
     };
 });
 server.registerTool('searchAssets', {
-    description: `Search for assets in the project and engine directories.
-When the user requests to place something in the scene, unless it is clearly a primitive, always try calling this first to see if any assets are fitting the request.
-Before using the assets found, **always** call the \`getAssetsMetadata\` tool to get the metadata about the assets, unless the given metadata is already fetched.
-Here is the list of assets types, including:
-${Object.entries(assetDescriptions).map(([type, description]) => `- ${type}: ${description}`).join('\n')}
+    description: `Search for assets in the project and engine directories.
+When the user requests to place something in the scene, unless it is clearly a primitive, always try calling this first to see if any assets are fitting the request.
+Before using the assets found, **always** call the \`getAssetsMetadata\` tool to get the metadata about the assets, unless the given metadata is already fetched.
+Here is the list of assets types, including:
+${Object.entries(assetDescriptions).map(([type, description]) => `- ${type}: ${description}`).join('\n')}
 `,
     inputSchema: {
         acceptedTypes: z.array(z.enum(Object.values(AssetType))).describe('List of types of assets to search for. An empty array means all types.'),
@@ -261,10 +261,10 @@ server.registerTool('placeJsClassActor', {
         actors: z.array(z.object({
             className: z.string().describe(`The name of the JavaScript class to place. ${classRule}`),
             constructorParams: z.array(z.record(z.any())).optional()
-                .describe(`Optional constructor parameters to pass to the actor class.
-Use the getAssetsMetadata tool to discover what parameters each actor class requires,
-and the parameters should be an array that corresponds to the "jsClassConstructorParams" from the result of the getAssetsMetadata tool.
-If the actor class has no constructor parameters, the array should be empty.
+                .describe(`Optional constructor parameters to pass to the actor class.
+Use the getAssetsMetadata tool to discover what parameters each actor class requires,
+and the parameters should be an array that corresponds to the "jsClassConstructorParams" from the result of the getAssetsMetadata tool.
+If the actor class has no constructor parameters, the array should be empty.
           `),
             info: ActorInfoSchema.describe('Information about the actor.'),
         }).strict().describe('A JavaScript class actor to place.')).describe('A list of JavaScript class actors to place. Each actor can have a transform and constructor parameters.'),
@@ -290,8 +290,8 @@ server.registerTool('generateTemplateCode', {
     description: 'Generate template code for a class of actor or component. When the user asks to create a new actor or component, always try calling this first to see if any template code is available, and iterate on the code it generates until it is correct.',
     inputSchema: {
         className: z.string().describe('The name of the class to generate template code for.'),
-        filePath: z.string().describe(`The path to the file to generate the template code for.
-If it is a relative path, it will be relative to the 'src/' directory, so don't include the extra 'src/' in the path.
+        filePath: z.string().describe(`The path to the file to generate the template code for.
+If it is a relative path, it will be relative to the 'src/' directory, so don't include the extra 'src/' in the path.
 The file name should be lower camel case, such as 'myActor.ts', or 'fancyMovementComponent.ts'.`),
         baseClassName: z.string().describe(`The name of the base class to generate the template code for. ${classRule}`),
     },
@@ -324,11 +324,11 @@ The file name should be lower camel case, such as 'myActor.ts', or 'fancyMovemen
     };
 });
 server.registerTool('getSceneState', {
-    description: `
-Get the current state of the scene to understand the state of the current scene and its actors.
-**DO NOT** try reading the scene file directly unless explicitly asked by the user.
-The first time calling this tool, always call without specifiedActors and getDetailedComponentsInfo to have an overview of the scene.
-And then call this tool with \`specifiedActors\`, and set \`getDetailedComponentsInfo\` to true, to get more detailed information about specific actors, including their bounding boxes info, etc.
+    description: `
+Get the current state of the scene to understand the state of the current scene and its actors.
+**DO NOT** try reading the scene file directly unless explicitly asked by the user.
+The first time calling this tool, always call without specifiedActors and getDetailedComponentsInfo to have an overview of the scene.
+And then call this tool with \`specifiedActors\`, and set \`getDetailedComponentsInfo\` to true, to get more detailed information about specific actors, including their bounding boxes info, etc.
 `,
     inputSchema: {
         editorId: EditorIdSchema,

package/dist/src/templates/scripts/genesys/mcp/editor-functions.js

@@ -66,10 +66,10 @@ function shutdown() {
     });
     clients.clear();
 }
-export const EditorIdSchema = z.string().optional().describe(`
-ID of the editor that should respond.
-If not provided, will proceed if there is only one editor connected, will return error if there are multiple editors connected.
-Can always try without providing this, and only ask the user to provide it if there are multiple editors connected.
+export const EditorIdSchema = z.string().optional().describe(`
+ID of the editor that should respond.
+If not provided, will proceed if there is only one editor connected, will return error if there are multiple editors connected.
+Can always try without providing this, and only ask the user to provide it if there are multiple editors connected.
 `);
 export function getClientWebSocket(editorId) {
     if (clients.size === 0) {

package/dist/src/templates/src/templates/vehicle/src/ui-hints.js

@@ -44,36 +44,36 @@ let UIHints = class UIHints extends ENGINE.Actor {
             }
         });
         // Set the HTML content
-        this.uiElement.setHTML(`
-      <div style="display: flex; justify-content: space-between; align-items: center; margin-bottom: 15px;">
-        <div style="font-weight: bold; color: #4CAF50; font-size: 18px;">
-          🎮 Vehicle Game Controls
-        </div>
-        <button id="closeHints" style="
-          background: #f44336;
-          color: white;
-          border: none;
-          border-radius: 50%;
-          width: 30px;
-          height: 30px;
-          cursor: pointer;
-          font-size: 16px;
-          font-weight: bold;
-        ">×</button>
-      </div>
-      <div style="margin-bottom: 12px;">
-        <span style="color: #FFA726; font-weight: bold;">Movement:</span>
-        <br>• WASD or Arrow Keys - Move/Drive
-        <br>• Mouse - Camera control
-      </div>
-      <div style="margin-bottom: 12px;">
-        <span style="color: #FFA726; font-weight: bold;">Vehicle Interaction:</span>
-        <br>• E - Enter/Exit vehicle (when nearby)
-        <br>• F - Flip vehicle (when inside)
-      </div>
-      <div style="font-size: 14px; color: #CCCCCC; margin-top: 15px; text-align: center; font-style: italic;">
-        💡 Walk near a vehicle and press E to enter
-      </div>
+        this.uiElement.setHTML(`
+      <div style="display: flex; justify-content: space-between; align-items: center; margin-bottom: 15px;">
+        <div style="font-weight: bold; color: #4CAF50; font-size: 18px;">
+          🎮 Vehicle Game Controls
+        </div>
+        <button id="closeHints" style="
+          background: #f44336;
+          color: white;
+          border: none;
+          border-radius: 50%;
+          width: 30px;
+          height: 30px;
+          cursor: pointer;
+          font-size: 16px;
+          font-weight: bold;
+        ">×</button>
+      </div>
+      <div style="margin-bottom: 12px;">
+        <span style="color: #FFA726; font-weight: bold;">Movement:</span>
+        <br>• WASD or Arrow Keys - Move/Drive
+        <br>• Mouse - Camera control
+      </div>
+      <div style="margin-bottom: 12px;">
+        <span style="color: #FFA726; font-weight: bold;">Vehicle Interaction:</span>
+        <br>• E - Enter/Exit vehicle (when nearby)
+        <br>• F - Flip vehicle (when inside)
+      </div>
+      <div style="font-size: 14px; color: #CCCCCC; margin-top: 15px; text-align: center; font-style: italic;">
+        💡 Walk near a vehicle and press E to enter
+      </div>
     `);
         // Add close button functionality
         const closeButton = this.uiElement.querySelector('#closeHints');