hytopia 0.8.12 → 0.9.0-prerelease-2

package/bin/{scripts.mjs → scripts.js}

@@ -7,6 +7,11 @@ import path from 'path';
 import readline from 'readline';
 import { fileURLToPath } from 'url';
 
+if (!('Deno' in globalThis)) {
+  console.error('❌ Error: HYTOPIA scripts must be run with Deno as of version SDK 0.9.0.');
+  process.exit(1);
+}
+
 // Store command-line flags
 const flags = {};
 
@@ -21,9 +26,10 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
   
   // Execute the appropriate command
   const commandHandlers = {
+    'dev': dev,
     'init': init,
     'init-mcp': initMcp,
-    'package': packageProject
+    'package': packageProject,
   };
   
   const handler = commandHandlers[command];
@@ -52,12 +58,21 @@ function parseCommandLineFlags() {
   }
 }
 
+/**
+ * Runs a hytopia project's index file using 
+ * deno compatibility mode, allow-all permissions,
+ * and watches for changes.
+ */
+function dev() {
+  execSync('DENO_COMPAT=1 deno run -A --watch index.ts')
+}
+
 /**
  * Displays available commands when an unknown command is entered
  */
 function displayAvailableCommands(command) {
   console.log('Unknown command: ' + command);
-  console.log('Supported commands: init, init-mcp, package');
+  console.log('Supported commands: dev, init, init-mcp, package, start');
 }
 
 /**
@@ -77,7 +92,7 @@ function createReadlineInterface() {
  * project name as an argument.
  * 
  * @example
- * `bunx hytopia init my-project-name`
+ * `hytopia init my-project-name`
  */
 function init() {
   const destDir = process.cwd();
@@ -112,11 +127,30 @@ function init() {
  * Installs required dependencies for a new project
  */
 function installProjectDependencies() {
-  execSync('bun init --yes');
-  execSync('bun add hytopia@latest --force');
-  execSync('bun add @hytopia.com/assets --force');
-  try { execSync('bun pm trust mediasoup'); } catch {  console.log('Failed to install optional dependency "mediasoup", skipping for local development...'); }
-  try { execSync('bun pm trust sharp'); } catch {  console.log('Failed to install optional dependency "sharp", skipping for local development...'); }
+  // init project
+  execSync('deno init --quiet');
+ 
+  // remove deno boilerplate
+  Deno.removeSync('main.ts');
+  Deno.removeSync('main_test.ts');
+
+  // create deno.json with nodeModulesDir set to auto
+  Deno.writeTextFile('deno.json', JSON.stringify({ nodeModulesDir: "auto" }, null, 2));
+
+  // create package.json
+  Deno.writeTextFile('package.json', JSON.stringify({
+    name: 'hytopia-project',
+    version: '1.0.0',
+    description: 'My HYTOPIA project',
+    main: 'index.ts',
+    scripts: {
+      dev: 'hytopia dev'
+    }
+  }, null, 2));  
+
+  // install hytopia sdk and hytopia assets
+  denoAddPackage('hytopia@latest', '--quiet');
+  denoAddPackage('@hytopia.com/assets@latest', '--quiet');
 }
 
 /**
@@ -125,7 +159,7 @@ function installProjectDependencies() {
 function initFromTemplate(destDir) {
   console.log(`🖨️  Initializing project with examples template "${flags.template}"...`);
 
-  execSync('bun add @hytopia.com/examples@latest --force');
+  denoAddPackage('@hytopia.com/examples@latest');
 
   const templateDir = path.join(destDir, 'node_modules', '@hytopia.com', 'examples', flags.template);
 
@@ -136,7 +170,7 @@ function initFromTemplate(destDir) {
   }
 
   fs.cpSync(templateDir, destDir, { recursive: true });
-  execSync('bun install');
+  execSync('deno install');
 }
 
 /**
@@ -166,7 +200,7 @@ 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('💡 1. Start your development server by running the command `hytopia dev`');
   console.log('🎮 2. Play your game by opening: https://hytopia.com/play/?join=localhost:8080');
   logDivider();
 }
@@ -215,7 +249,7 @@ function initMcp() {
     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.');
+      console.log('❌ Invalid selection. Please run `hytopia init-mcp` again and select a number between 1 and 4.');
       rl.close();
       return;
     }
@@ -279,14 +313,18 @@ function initCursorLocalMcp() {
   logDivider();
 }
 
+function denoAddPackage(packageName, flags ='') {
+  execSync(`deno add --allow-scripts --npm ${flags} ${packageName}`);
+}
+
 /**
  * Package command
  * 
  * Creates a zip file of the project directory, excluding node_modules,
- * package-lock.json, bun.lock, and bun.lockb files.
+ * package-lock.json, deno.lock, and deno.json files.
  * 
  * @example
- * `bunx hytopia package`
+ * `hytopia package`
  */
 function packageProject() {
   const sourceDir = process.cwd();
@@ -347,7 +385,7 @@ function packageProject() {
     if (!hasOptimizedDir) {
       console.warn('❌ Error: No .optimized directories found in the assets folder.');
       console.warn('   Make sure your server has ran the optimizer for your models.');
-      console.warn('   This can be done by running your server with: bun --watch index.ts');
+      console.warn('   This can be done by running your server with the command `hytopia dev`');
       return;
     }
   } else {
@@ -398,8 +436,8 @@ function packageProject() {
     '.git',
     'node_modules',
     'package-lock.json',
-    'bun.lock',
-    'bun.lockb',
+    'deno.lock',
+    'deno.json'
     `${projectName}.zip` // Exclude the output file itself
   ];
   

package/bin/writeVersion.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+
+// Ran from root as prepublishOnly hook to replace __SDK_DEV_VERSION__ with the actual SDK version.
+import fs from 'fs';
+
+const sdkPackage = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
+const server = fs.readFileSync('./server.js', 'utf8');
+
+if (!server.includes('__DEV_SDK_VERSION__')) {
+  throw new Error('__DEV_SDK_VERSION__ not found in server.js. Please create a fresh build before publishing! You can do this by running: cd ../server && bun run build.');
+}
+
+fs.writeFileSync('./server.js', server.replace(/__DEV_SDK_VERSION__/g, sdkPackage.version));

package/docs/index.md

@@ -27,3 +27,4 @@ Description
 
 </td></tr>
 </tbody></table>
+

package/docs/server.audio._constructor_.md

@@ -47,3 +47,4 @@ The options for the Audio instance.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.audio.md

@@ -630,3 +630,4 @@ Sets the volume of the audio.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.audio.play.md

@@ -63,6 +63,7 @@ _(Optional)_ If true, the audio will restart from the beginning if it is already
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.audio.setattachedtoentity.md

@@ -47,6 +47,7 @@ The entity to attach the Audio to.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.audio.setcutoffdistance.md

@@ -47,6 +47,7 @@ The cutoff distance.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.audio.setdetune.md

@@ -47,6 +47,7 @@ The detune in cents.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.audio.setdistortion.md

@@ -47,6 +47,7 @@ The distortion amount.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.audio.setplaybackrate.md

@@ -47,6 +47,7 @@ The playback rate.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.audio.setposition.md

@@ -47,6 +47,7 @@ The position in the world.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.audio.setreferencedistance.md

@@ -47,6 +47,7 @@ The reference distance.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.audio.setvolume.md

@@ -47,6 +47,7 @@ The volume level.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.audioevent.md

@@ -185,3 +185,4 @@ SET\_VOLUME
 
 </td></tr>
 </tbody></table>
+

package/docs/server.audioeventpayloads.md

@@ -245,3 +245,4 @@ Emitted when the audio's volume is set.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.audiomanager.getallentityattachedaudios.md

@@ -47,6 +47,7 @@ The entity to get attached audio instances for.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Audio](./server.audio.md)<!-- -->\[\]

package/docs/server.audiomanager.md

@@ -176,3 +176,4 @@ Unregisters and stops all audio instances attached to a specific entity.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.audiomanager.unregisteraudio.md

@@ -47,6 +47,7 @@ The audio instance to pause and unregister.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.audiomanager.unregisterentityattachedaudios.md

@@ -47,6 +47,7 @@ The entity to pause and unregister audio instances for.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.audiooptions.md

@@ -264,3 +264,4 @@ _(Optional)_ The volume level of the audio. Defaults to 0.5.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.ballcollideroptions.md

@@ -73,3 +73,4 @@ _(Optional)_ The radius of the ball collider.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.basecollideroptions.md

@@ -340,3 +340,4 @@ _(Optional)_ An arbitrary identifier tag of the collider. Useful for your own lo
 
 </td></tr>
 </tbody></table>
+

package/docs/server.baseentitycontroller.attach.md

@@ -47,6 +47,7 @@ The entity to attach the controller to.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.baseentitycontroller.despawn.md

@@ -47,6 +47,7 @@ The entity to despawn.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.baseentitycontroller.detach.md

@@ -47,6 +47,7 @@ The entity to detach.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.baseentitycontroller.md

@@ -124,3 +124,4 @@ Override this method to handle entity movements based on player input for your e
 
 </td></tr>
 </tbody></table>
+

package/docs/server.baseentitycontroller.spawn.md

@@ -47,6 +47,7 @@ The entity to spawn.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.baseentitycontroller.tick.md

@@ -61,6 +61,7 @@ The delta time in milliseconds since the last tick.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.baseentitycontroller.tickwithplayerinput.md

@@ -95,6 +95,7 @@ The delta time in milliseconds since the last tick.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.baseentitycontrollerevent.md

@@ -115,3 +115,4 @@ TICK\_WITH\_PLAYER\_INPUT
 
 </td></tr>
 </tbody></table>
+

package/docs/server.baseentitycontrollereventpayloads.md

@@ -150,3 +150,4 @@ Emitted when an entity is ticked.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.baseentityoptions.md

@@ -207,3 +207,4 @@ _(Optional)_ The tint color of the entity as a hex code.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.baserigidbodyoptions.md

@@ -150,3 +150,4 @@ _(Optional)_ The type of the rigid body, defaults to [RigidBodyType.DYNAMIC](./s
 
 </td></tr>
 </tbody></table>
+

package/docs/server.block.getneighborglobalcoordinatefromhitpoint.md

@@ -47,6 +47,7 @@ The hit point on this block to get the neighbor coordinate from.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Vector3Like](./server.vector3like.md)

package/docs/server.block.md

@@ -118,3 +118,4 @@ Gets the most adjacent neighbor global coordinate of this block based on a relat
 
 </td></tr>
 </tbody></table>
+

package/docs/server.blockcollideroptions.md

@@ -73,3 +73,4 @@ _(Optional)_ The half extents of the block collider.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.blockentityoptions.md

@@ -75,3 +75,4 @@ _(Optional)_ The texture uri of a entity if the entity is a block entity, if set
 
 </td></tr>
 </tbody></table>
+

package/docs/server.blocktype._constructor_.md

@@ -47,3 +47,4 @@ _(Optional)_ The options for the block type.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.blocktype.md

@@ -285,3 +285,4 @@ The URI of the texture for the block type.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.blocktypeevent.md

@@ -59,3 +59,4 @@ ENTITY\_CONTACT\_FORCE
 
 </td></tr>
 </tbody></table>
+

package/docs/server.blocktypeeventpayloads.md

@@ -74,3 +74,4 @@ Emitted when an entity's contact force is applied to a block type.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.blocktypeoptions.md

@@ -169,3 +169,4 @@ The URI of the texture asset for the block type.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.blocktyperegistry.getblocktype.md

@@ -47,6 +47,7 @@ The id of the block type to get.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [BlockType](./server.blocktype.md)

package/docs/server.blocktyperegistry.md

@@ -157,3 +157,4 @@ Register a generic block type.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.blocktyperegistry.registerblocktype.md

@@ -47,6 +47,7 @@ The block type to register.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.blocktyperegistry.registergenericblocktype.md

@@ -47,6 +47,7 @@ The options for the block type.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [BlockType](./server.blocktype.md)

package/docs/server.blocktyperegistryevent.md

@@ -45,3 +45,4 @@ REGISTER\_BLOCK\_TYPE
 
 </td></tr>
 </tbody></table>
+

package/docs/server.blocktyperegistryeventpayloads.md

@@ -55,3 +55,4 @@ Emitted when a block type is registered.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.capsulecollideroptions.md

@@ -92,3 +92,4 @@ _(Optional)_ The radius of the capsule collider.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.chatevent.md

@@ -59,3 +59,4 @@ PLAYER\_MESSAGE
 
 </td></tr>
 </tbody></table>
+

package/docs/server.chateventpayloads.md

@@ -74,3 +74,4 @@ Emitted when a message is sent to a specific player.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.chatmanager.md

@@ -115,3 +115,4 @@ Unregister a command.
 
 </td></tr>
 </tbody></table>
+

package/docs/server.chatmanager.registercommand.md

@@ -63,6 +63,7 @@ The callback function to execute when the command is used.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.chatmanager.sendbroadcastmessage.md

@@ -63,6 +63,7 @@ _(Optional)_ The color of the message as a hex color code, excluding \#.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.chatmanager.sendplayermessage.md

@@ -79,6 +79,7 @@ _(Optional)_ The color of the message as a hex color code, excluding \#.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.chatmanager.unregistercommand.md

@@ -47,6 +47,7 @@ The command to unregister.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 void

package/docs/server.chunk._constructor_.md

@@ -45,3 +45,4 @@ originCoordinate
 
 </td></tr>
 </tbody></table>
+

package/docs/server.chunk.blockindextolocalcoordinate.md

@@ -47,6 +47,7 @@ The index of the block to convert.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Vector3Like](./server.vector3like.md)

package/docs/server.chunk.getblockid.md

@@ -47,6 +47,7 @@ The local coordinate of the block to get.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 number

package/docs/server.chunk.globalcoordinatetolocalcoordinate.md

@@ -47,6 +47,7 @@ The global coordinate to convert.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Vector3Like](./server.vector3like.md)

package/docs/server.chunk.globalcoordinatetoorigincoordinate.md

@@ -47,6 +47,7 @@ The global coordinate to convert.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [Vector3Like](./server.vector3like.md)

package/docs/server.chunk.hasblock.md

@@ -47,6 +47,7 @@ The local coordinate of the block to check.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 boolean