hytopia 0.3.14 → 0.3.16

package/bin/scripts.js

@@ -3,10 +3,36 @@
 const { execSync } = require('child_process');
 const fs = require('fs');
 const path = require('path');
+const readline = require('readline');
 
+// Store command-line flags
+const flags = {};
+
+// Main function to handle command execution
 (async () => {
   const command = process.argv[2];
-  const flags = {};
+  
+  // Parse command-line flags
+  parseCommandLineFlags();
+  
+  // Execute the appropriate command
+  const commandHandlers = {
+    'init': init,
+    'init-mcp': initMcp
+  };
+  
+  const handler = commandHandlers[command];
+  if (handler) {
+    handler();
+  } else {
+    displayAvailableCommands(command);
+  }
+})();
+
+/**
+ * Parses command-line flags in the format --flag value
+ */
+function parseCommandLineFlags() {
   for (let i = 3; i < process.argv.length; i += 2) {
     if (i % 2 === 1) { // Odd indices are flags
       const flag = process.argv[i].replace('--', '');
@@ -14,65 +40,202 @@ const path = require('path');
       flags[flag] = value;
     }
   }
+}
 
-  /**
-   * Init command
-   * 
-   * Initializes a new HYTOPIA project. Accepting an optional
-   * project name as an argument.
-   * 
-   * @example
-   * `bunx hytopia init my-project-name`
-   */
-  if (command === 'init') {
-    const destDir = process.cwd();
-
-    // Grab the latest dependencies
-    execSync('bun init --yes');
-    execSync('bun add hytopia@latest');
-    execSync('bun add @hytopia.com/assets');
-
-    // Initialize project with latest HYTOPIA SDK
-    console.log('🔧 Initializing project with latest HYTOPIA SDK...');
-   
-    if (flags.template) {
-      // Init from example template
-      console.log(`🖨️ Initializing project with examples template "${flags.template}"...`);
-
-      const templateDir = path.join(destDir, 'node_modules', 'hytopia', 'examples', flags.template);
-
-      if (!fs.existsSync(templateDir)) {
-        console.error(`Examples template ${flags.template} does not exist in the examples directory, could not initialize project! Tried directory: ${templateDir}`);
-        return;
-      }
-
-      fs.cpSync(templateDir, destDir, { recursive: true });
-
-      execSync('bun install');
-    } else {
-      // Init from boilerplate
-      console.log('🧑‍💻 Initializing project with boilerplate...');
+/**
+ * Displays available commands when an unknown command is entered
+ */
+function displayAvailableCommands(command) {
+  console.log('Unknown command: ' + command);
+  console.log('Supported commands: init, init-mcp');
+}
 
-      const srcDir = path.join(__dirname, '..', 'boilerplate');
-      
-      fs.cpSync(srcDir, destDir, { recursive: true });  
-    }
+/**
+ * Creates a readline interface for user input
+ */
+function createReadlineInterface() {
+  return readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+}
+
+/**
+ * Init command
+ * 
+ * Initializes a new HYTOPIA project. Accepting an optional
+ * project name as an argument.
+ * 
+ * @example
+ * `bunx hytopia init my-project-name`
+ */
+function init() {
+  const destDir = process.cwd();
+
+  // Install dependencies
+  installProjectDependencies();
+
+  // Initialize project with latest HYTOPIA SDK
+  console.log('🔧 Initializing project with latest HYTOPIA SDK...');
+ 
+  if (flags.template) {
+    initFromTemplate(destDir);
+  } else {
+    initFromBoilerplate(destDir);
+  }
+
+  // Copy assets into project, not overwriting existing files
+  copyAssets(destDir);
+
+  // Display success message
+  displayInitSuccessMessage();
+
+  // Prompt for MCP setup
+  promptForMcpSetup();
+
+  return;
+}
+
+/**
+ * Installs required dependencies for a new project
+ */
+function installProjectDependencies() {
+  execSync('bun init --yes');
+  execSync('bun add hytopia@latest');
+  execSync('bun add @hytopia.com/assets');
+}
+
+/**
+ * Initializes a project from a template
+ */
+function initFromTemplate(destDir) {
+  console.log(`🖨️  Initializing project with examples template "${flags.template}"...`);
+
+  const templateDir = path.join(destDir, 'node_modules', 'hytopia', 'examples', flags.template);
 
-    // Copy assets into project, not overwriting existing files
-    fs.cpSync(
-      path.join(destDir, 'node_modules', '@hytopia.com', 'assets'),
-      path.join(destDir, 'assets'),
-      { recursive: true, force: false }
-    );
-
-    // Done, lfg!
-    console.log('--------------------------------');
-    console.log('🚀 Hytopia project initialized successfully!');
-    console.log('💡 Start your development server with `bun --watch index.ts`!');
-    console.log('🎮 After you start your development server, play by opening your browser and visiting: https://play.hytopia.com/?join=localhost:8080')
+  if (!fs.existsSync(templateDir)) {
+    console.error(`❌ Examples template ${flags.template} does not exist in the examples directory, could not initialize project!`);
+    console.error(`   Tried directory: ${templateDir}`);
     return;
   }
+
+  fs.cpSync(templateDir, destDir, { recursive: true });
+  execSync('bun install');
+}
+
+/**
+ * Initializes a project from the default boilerplate
+ */
+function initFromBoilerplate(destDir) {
+  console.log('🧑‍💻 Initializing project with boilerplate...');
+  const srcDir = path.join(__dirname, '..', 'boilerplate');
+  fs.cpSync(srcDir, destDir, { recursive: true });  
+}
+
+/**
+ * Copies assets to the project directory
+ */
+function copyAssets(destDir) {
+  fs.cpSync(
+    path.join(destDir, 'node_modules', '@hytopia.com', 'assets'),
+    path.join(destDir, 'assets'),
+    { recursive: true, force: false }
+  );
+}
+
+/**
+ * Displays success message after project initialization
+ */
+function displayInitSuccessMessage() {
+  logDivider();
+  console.log('✅ HYTOPIA PROJECT INITIALIZED SUCCESSFULLY!');
+  console.log(' ');
+  console.log('💡 1. Start your development server with: bun --watch index.ts');
+  console.log('🎮 2. Play your game by opening: https://play.hytopia.com/?join=localhost:8080');
+  logDivider();
+}
+
+/**
+ * Prompts the user to set up MCP
+ */
+function promptForMcpSetup() {
+  console.log('📋 OPTIONAL: HYTOPIA MCP SETUP');
+  console.log(' ');
+  console.log('The HYTOPIA MCP enables Cursor and Claude Code editors to access');
+  console.log('HYTOPIA-specific capabilities, providing significantly better AI');
+  console.log('assistance and development experience for this HYTOPIA project.');
+  console.log(' ');
+
+  const rl = createReadlineInterface();
   
-  console.log('Unknown command: ' + command);
-})();
+  rl.question('Would you like to initialize the HYTOPIA MCP for this project? (y/n): ', (answer) => {
+    rl.close();
+
+    if (answer.trim().toLowerCase() === 'y') {
+      initMcp();
+    } else {
+      logDivider();
+      console.log('🎉 You\'re all set! Your HYTOPIA project is ready to use.');
+      logDivider();
+    }
+  });
+}
+
+/**
+ * Initializes the MCP for the selected editors
+ */
+function initMcp() {
+  const rl = createReadlineInterface();
+
+  logDivider();
+  console.log('🤖 HYTOPIA MCP SETUP');
+  console.log('Please select your code editor:');
+  console.log('  1. Cursor');
+  console.log('  2. Claude Code');
+  console.log('  3. Both');
+  console.log('  4. None / Cancel');
+
+  rl.question('Enter your selection (1-4): ', (answer) => {
+    const selection = parseInt(answer.trim());
+    
+    if (isNaN(selection) || selection < 1 || selection > 4) {
+      console.log('❌ Invalid selection. Please run `bunx hytopia init-mcp` again and select a number between 1 and 4.');
+      rl.close();
+      return;
+    }
+    
+    if ([1, 2, 3].includes(selection)) { logDivider(); }
+
+    if (selection === 1 || selection === 3) {
+      initEditorMcp('Cursor', 'cursor');
+    }
+
+    if (selection === 2 || selection === 3) {
+      initEditorMcp('Claude Code', 'claude');
+    }
+    
+    rl.close();
+    
+    if ([1, 2, 3].includes(selection)) {
+      console.log('🎉 You\'re all set! Your HYTOPIA project is ready to use.');
+      logDivider();
+    }
+  });
+}
+
+/**
+ * Initializes MCP for a specific editor
+ */
+function initEditorMcp(editorName, editorFlag) {
+  console.log(`🔧 Initializing HYTOPIA MCP for ${editorName}...`);
+  execSync(`bunx topia-mcp@latest init ${editorFlag}`);
+  console.log(`✅ ${editorName} MCP initialized successfully!`);
+  logDivider();
+}
 
+/**
+ * Prints a divider line for better console output readability
+ */
+function logDivider() {
+  console.log('--------------------------------');
+}

package/boilerplate/assets/ui/index.html

@@ -34,9 +34,9 @@ and also configure additional buttons for mobile compatibility.
 </script>
 
 <!--
-  HYTOPIA allows you to build completely custom UI uses HTML, CSS and Javascript.
+  HYTOPIA allows you to build completely custom UI using HTML, CSS and Javascript.
   You can build simple UIs, to highly complex ones. UI capabilities are as powerful
-  as building a regaulr web page - there are no limitations on what you can do.
+  as building a regular web page - there are close to no limitations on what is possible.
 
   Remember, HYTOPIA sandboxes your UI & UI scripts, so external network requests or
   other unsafe actions likely won't work as you expect in production.
@@ -60,7 +60,7 @@ and also configure additional buttons for mobile compatibility.
 
   /*
     We can use the body.mobile class to detect if we're on a mobile device.
-    HYTOPIA will always add this class to the body element when running on a mobile device.
+    The HYTOPIA game client will always add this class to the body element when running on a mobile device.
   */
   body.mobile .mobile-controls { /* If this css selector matches because we're on mobile, show the mobile controls */
     display: flex;

package/examples/hygrounds/classes/ItemEntity.ts

@@ -99,7 +99,7 @@ export default class ItemEntity extends Entity {
     }
 
     (new Audio({
-      attachedToEntity: this.parent,
+      attachedToEntity: this,
       uri: this.consumeAudioUri,
       volume: 0.5,
       referenceDistance: 5,

package/examples/mobile-controls/assets/ui/index.html

@@ -34,9 +34,9 @@ and also configure additional buttons for mobile compatibility.
 </script>
 
 <!--
-  HYTOPIA allows you to build completely custom UI uses HTML, CSS and Javascript.
+  HYTOPIA allows you to build completely custom UI using HTML, CSS and Javascript.
   You can build simple UIs, to highly complex ones. UI capabilities are as powerful
-  as building a regaulr web page - there are no limitations on what you can do.
+  as building a regular web page - there are close to no limitations on what is possible.
 
   Remember, HYTOPIA sandboxes your UI & UI scripts, so external network requests or
   other unsafe actions likely won't work as you expect in production.
@@ -60,7 +60,7 @@ and also configure additional buttons for mobile compatibility.
 
   /*
     We can use the body.mobile class to detect if we're on a mobile device.
-    HYTOPIA will always add this class to the body element when running on a mobile device.
+    The HYTOPIA game client will always add this class to the body element when running on a mobile device.
   */
   body.mobile .mobile-controls { /* If this css selector matches because we're on mobile, show the mobile controls */
     display: flex;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.3.14",
+  "version": "0.3.16",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "main": "server.js",
   "bin": {