hytopia 0.1.5 → 0.1.9

package/bin/scripts.js

@@ -2,17 +2,50 @@
 
 const fs = require('fs');
 const path = require('path');
-const command = process.argv[2];
+const mkcert = require('mkcert');
 
-if (command === 'init') {
-  const srcDir = path.join(__dirname, '..', 'boilerplate');
-  const destDir = process.cwd();
+(async () => {
+  const command = process.argv[2];
 
-  fs.cpSync(srcDir, destDir, { recursive: true });
+  /**
+   * Init command
+   * 
+   * Initializes a new HYTOPIA project.
+   */
+  if (command === 'init') {
+    const srcDir = path.join(__dirname, '..', 'boilerplate');
+    const destDir = process.cwd();
+  
+    // Copy boilerplate
+    console.log(`🖨️ Copying boilerplate to ${destDir}`);
+    fs.cpSync(srcDir, destDir, { recursive: true });
+  
+    // Generate SSL cert and allow mkcert to auto handle CA/Cert setup
+    console.log(`🔒 Generating SSL cert for local development`);
+    const validity = 3650; // 10 years
+    const ca = await mkcert.createCA({
+      organization: 'HYTOPIA',
+      countryCode: 'US',
+      state: 'Washington',
+      locality: 'Seattle',
+      validity,
+    });
 
-  console.log('🚀 Hytopia project initialized successfully!');
-  console.log('💡 Start your development server with `bun --watch index.ts`!');
-  return;
-}
+    const cert = await mkcert.createCert({
+      ca: { key: ca.key, cert: ca.cert },
+      domains: ['localhost', '127.0.0.1'],
+      validity,
+    });
+
+    fs.writeFileSync(path.join(destDir, 'assets', 'certs', 'localhost.crt'), cert.cert);
+    fs.writeFileSync(path.join(destDir, 'assets', 'certs', 'localhost.key'), cert.key);
+
+    // Done, lfg!
+    console.log('🚀 Hytopia project initialized successfully!');
+    console.log('💡 Start your development server with `bun --watch index.ts`!');
+    return;
+  }
+  
+  console.log('Unknown command: ' + command);
+})();
 
-console.log('Unknown command: ' + command);

package/boilerplate/assets/certs/README.md

@@ -0,0 +1,6 @@
+For local development, mkcert generated certs will be stored here.
+We do this to allow https://localhost & wss://localhost support. 
+Without this, play.hytopia.com requires a bunch of funky browser 
+flag workarounds in order to connect to our local server.
+This is only used for local development and will be ignored
+when your game is deployed to HYTOPIA servers.

package/boilerplate/index.ts

@@ -42,15 +42,15 @@ import worldMap from './assets/map.json';
 
 startServer(world => {
   /**
-   * Enable debugging of the physics simulation.
+   * Enable debug rendering of the physics simulation.
    * This will overlay lines in-game representing colliders,
    * rigid bodies, and raycasts. This is useful for debugging
-   * physics-related issues and is very frequently used.
+   * physics-related issues in a development environment.
    * For larger worlds, enabling this can cause performance
    * issues, which will be noticed as dropped frame rates
    * and higher RTT times.
    */
-  world.simulation.enableDebug(true);
+  world.simulation.enableDebugRendering(true);
 
   /**
    * Load our map.
@@ -84,7 +84,7 @@ startServer(world => {
     world.chatManager.sendPlayerMessage(player, 'Use WASD to move around.');
     world.chatManager.sendPlayerMessage(player, 'Press space to jump.');
     world.chatManager.sendPlayerMessage(player, 'Hold shift to sprint.');
-    world.chatManager.sendPlayerMessage(player, 'Type /rocket for a little surprise!');
+    world.chatManager.sendPlayerMessage(player, 'Press \\ to enter or exit debug view.');
   };
 
   /**

package/docs/{server.hytopia.simulation.enabledebug.md → server.hytopia.simulation.enabledebugrendering.md}

@@ -1,15 +1,15 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Simulation](./server.hytopia.simulation.md) &gt; [enableDebug](./server.hytopia.simulation.enabledebug.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Simulation](./server.hytopia.simulation.md) &gt; [enableDebugRendering](./server.hytopia.simulation.enabledebugrendering.md)
 
-## HYTOPIA.Simulation.enableDebug() method
+## HYTOPIA.Simulation.enableDebugRendering() method
 
-Enables or disables debug rendering for the simulation. When enabled, all colliders and rigid bodies will be rendered in the world. Do not enable this in production. In large worlds this can cause noticable lag and RTT spikes.
+Enables or disables debug rendering for the simulation. When enabled, all colliders, rigid body and raycast outlines will be rendered in the world. Do not enable this in production. In large worlds enabling this can cause noticable lag and RTT spikes.
 
 **Signature:**
 
 ```typescript
-enableDebug(enabled: boolean): void;
+enableDebugRendering(enabled: boolean): void;
 ```
 
 ## Parameters

package/docs/{server.hytopia.simulation.isdebugenabled.md → server.hytopia.simulation.isdebugrenderingenabled.md}

@@ -1,13 +1,13 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Simulation](./server.hytopia.simulation.md) &gt; [isDebugEnabled](./server.hytopia.simulation.isdebugenabled.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Simulation](./server.hytopia.simulation.md) &gt; [isDebugRenderingEnabled](./server.hytopia.simulation.isdebugrenderingenabled.md)
 
-## HYTOPIA.Simulation.isDebugEnabled property
+## HYTOPIA.Simulation.isDebugRenderingEnabled property
 
 Whether the simulation has debug rendering enabled.
 
 **Signature:**
 
 ```typescript
-get isDebugEnabled(): boolean;
+get isDebugRenderingEnabled(): boolean;
 ```

package/docs/server.hytopia.simulation.md

@@ -64,7 +64,7 @@ The gravity vector for the simulation.
 </td></tr>
 <tr><td>
 
-[isDebugEnabled](./server.hytopia.simulation.isdebugenabled.md)
+[isDebugRenderingEnabled](./server.hytopia.simulation.isdebugrenderingenabled.md)
 
 
 </td><td>
@@ -161,7 +161,7 @@ Casts a ray through the simulation.
 </td></tr>
 <tr><td>
 
-[enableDebug(enabled)](./server.hytopia.simulation.enabledebug.md)
+[enableDebugRendering(enabled)](./server.hytopia.simulation.enabledebugrendering.md)
 
 
 </td><td>
@@ -169,7 +169,7 @@ Casts a ray through the simulation.
 
 </td><td>
 
-Enables or disables debug rendering for the simulation. When enabled, all colliders and rigid bodies will be rendered in the world. Do not enable this in production. In large worlds this can cause noticable lag and RTT spikes.
+Enables or disables debug rendering for the simulation. When enabled, all colliders, rigid body and raycast outlines will be rendered in the world. Do not enable this in production. In large worlds enabling this can cause noticable lag and RTT spikes.
 
 
 </td></tr>

package/docs/{server.simulation.enabledebug.md → server.simulation.enabledebugrendering.md}

@@ -1,15 +1,15 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [Simulation](./server.simulation.md) &gt; [enableDebug](./server.simulation.enabledebug.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [Simulation](./server.simulation.md) &gt; [enableDebugRendering](./server.simulation.enabledebugrendering.md)
 
-## Simulation.enableDebug() method
+## Simulation.enableDebugRendering() method
 
-Enables or disables debug rendering for the simulation. When enabled, all colliders and rigid bodies will be rendered in the world. Do not enable this in production. In large worlds this can cause noticable lag and RTT spikes.
+Enables or disables debug rendering for the simulation. When enabled, all colliders, rigid body and raycast outlines will be rendered in the world. Do not enable this in production. In large worlds enabling this can cause noticable lag and RTT spikes.
 
 **Signature:**
 
 ```typescript
-enableDebug(enabled: boolean): void;
+enableDebugRendering(enabled: boolean): void;
 ```
 
 ## Parameters

package/docs/{server.simulation.isdebugenabled.md → server.simulation.isdebugrenderingenabled.md}

@@ -1,13 +1,13 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [Simulation](./server.simulation.md) &gt; [isDebugEnabled](./server.simulation.isdebugenabled.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [Simulation](./server.simulation.md) &gt; [isDebugRenderingEnabled](./server.simulation.isdebugrenderingenabled.md)
 
-## Simulation.isDebugEnabled property
+## Simulation.isDebugRenderingEnabled property
 
 Whether the simulation has debug rendering enabled.
 
 **Signature:**
 
 ```typescript
-get isDebugEnabled(): boolean;
+get isDebugRenderingEnabled(): boolean;
 ```

package/docs/server.simulation.md

@@ -64,7 +64,7 @@ The gravity vector for the simulation.
 </td></tr>
 <tr><td>
 
-[isDebugEnabled](./server.simulation.isdebugenabled.md)
+[isDebugRenderingEnabled](./server.simulation.isdebugrenderingenabled.md)
 
 
 </td><td>
@@ -161,7 +161,7 @@ Casts a ray through the simulation.
 </td></tr>
 <tr><td>
 
-[enableDebug(enabled)](./server.simulation.enabledebug.md)
+[enableDebugRendering(enabled)](./server.simulation.enabledebugrendering.md)
 
 
 </td><td>
@@ -169,7 +169,7 @@ Casts a ray through the simulation.
 
 </td><td>
 
-Enables or disables debug rendering for the simulation. When enabled, all colliders and rigid bodies will be rendered in the world. Do not enable this in production. In large worlds this can cause noticable lag and RTT spikes.
+Enables or disables debug rendering for the simulation. When enabled, all colliders, rigid body and raycast outlines will be rendered in the world. Do not enable this in production. In large worlds enabling this can cause noticable lag and RTT spikes.
 
 
 </td></tr>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.1.5",
+  "version": "0.1.9",
   "description": "The HYTOPIA SDK makes it easy for developers to create multiplayer games on the HYTOPIA platform using JavaScript or TypeScript.",
   "main": "server.js",
   "bin": {
@@ -46,5 +46,8 @@
   "bugs": {
     "url": "https://github.com/hytopiagg/sdk/issues"
   },
-  "homepage": "https://github.com/hytopiagg/sdk#readme"
+  "homepage": "https://github.com/hytopiagg/sdk#readme",
+  "dependencies": {
+    "mkcert": "^3.2.0"
+  }
 }

package/server.api.json

@@ -28116,12 +28116,12 @@
                 },
                 {
                   "kind": "Method",
-                  "canonicalReference": "server!HYTOPIA.Simulation#enableDebug:member(1)",
-                  "docComment": "/**\n * Enables or disables debug rendering for the simulation. When enabled, all colliders and rigid bodies will be rendered in the world. Do not enable this in production. In large worlds this can cause noticable lag and RTT spikes.\n *\n * @param enabled - Whether to enable debug rendering.\n */\n",
+                  "canonicalReference": "server!HYTOPIA.Simulation#enableDebugRendering:member(1)",
+                  "docComment": "/**\n * Enables or disables debug rendering for the simulation. When enabled, all colliders, rigid body and raycast outlines will be rendered in the world. Do not enable this in production. In large worlds enabling this can cause noticable lag and RTT spikes.\n *\n * @param enabled - Whether to enable debug rendering.\n */\n",
                   "excerptTokens": [
                     {
                       "kind": "Content",
-                      "text": "enableDebug(enabled: "
+                      "text": "enableDebugRendering(enabled: "
                     },
                     {
                       "kind": "Content",
@@ -28160,7 +28160,7 @@
                   ],
                   "isOptional": false,
                   "isAbstract": false,
-                  "name": "enableDebug"
+                  "name": "enableDebugRendering"
                 },
                 {
                   "kind": "Property",
@@ -28195,12 +28195,12 @@
                 },
                 {
                   "kind": "Property",
-                  "canonicalReference": "server!HYTOPIA.Simulation#isDebugEnabled:member",
+                  "canonicalReference": "server!HYTOPIA.Simulation#isDebugRenderingEnabled:member",
                   "docComment": "/**\n * Whether the simulation has debug rendering enabled.\n */\n",
                   "excerptTokens": [
                     {
                       "kind": "Content",
-                      "text": "get isDebugEnabled(): "
+                      "text": "get isDebugRenderingEnabled(): "
                     },
                     {
                       "kind": "Content",
@@ -28214,7 +28214,7 @@
                   "isReadonly": true,
                   "isOptional": false,
                   "releaseTag": "Public",
-                  "name": "isDebugEnabled",
+                  "name": "isDebugRenderingEnabled",
                   "propertyTypeTokenRange": {
                     "startIndex": 1,
                     "endIndex": 2
@@ -34853,12 +34853,12 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "server!Simulation#enableDebug:member(1)",
-              "docComment": "/**\n * Enables or disables debug rendering for the simulation. When enabled, all colliders and rigid bodies will be rendered in the world. Do not enable this in production. In large worlds this can cause noticable lag and RTT spikes.\n *\n * @param enabled - Whether to enable debug rendering.\n */\n",
+              "canonicalReference": "server!Simulation#enableDebugRendering:member(1)",
+              "docComment": "/**\n * Enables or disables debug rendering for the simulation. When enabled, all colliders, rigid body and raycast outlines will be rendered in the world. Do not enable this in production. In large worlds enabling this can cause noticable lag and RTT spikes.\n *\n * @param enabled - Whether to enable debug rendering.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "enableDebug(enabled: "
+                  "text": "enableDebugRendering(enabled: "
                 },
                 {
                   "kind": "Content",
@@ -34897,7 +34897,7 @@
               ],
               "isOptional": false,
               "isAbstract": false,
-              "name": "enableDebug"
+              "name": "enableDebugRendering"
             },
             {
               "kind": "Property",
@@ -34932,12 +34932,12 @@
             },
             {
               "kind": "Property",
-              "canonicalReference": "server!Simulation#isDebugEnabled:member",
+              "canonicalReference": "server!Simulation#isDebugRenderingEnabled:member",
               "docComment": "/**\n * Whether the simulation has debug rendering enabled.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "get isDebugEnabled(): "
+                  "text": "get isDebugRenderingEnabled(): "
                 },
                 {
                   "kind": "Content",
@@ -34951,7 +34951,7 @@
               "isReadonly": true,
               "isOptional": false,
               "releaseTag": "Public",
-              "name": "isDebugEnabled",
+              "name": "isDebugRenderingEnabled",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2

package/server.d.ts

@@ -2299,7 +2299,7 @@ export declare class Simulation {
 
 
     /** Whether the simulation has debug rendering enabled. */
-    get isDebugEnabled(): boolean;
+    get isDebugRenderingEnabled(): boolean;
     /** The gravity vector for the simulation. */
     get gravity(): RAPIER.Vector3;
     /** The fixed timestep for the simulation. */
@@ -2319,12 +2319,12 @@ export declare class Simulation {
 
     /**
      * Enables or disables debug rendering for the simulation.
-     * When enabled, all colliders and rigid bodies will be rendered
-     * in the world. Do not enable this in production. In large
-     * worlds this can cause noticable lag and RTT spikes.
+     * When enabled, all colliders, rigid body and raycast outlines
+     * will be rendered in the world. Do not enable this in production.
+     * In large worlds enabling this can cause noticable lag and RTT spikes.
      * @param enabled - Whether to enable debug rendering.
      */
-    enableDebug(enabled: boolean): void;
+    enableDebugRendering(enabled: boolean): void;