hytopia 0.1.4 → 0.1.5

package/README.md

@@ -12,6 +12,8 @@ HYTOPIA allows you to create your own highly-sharable, immersive, massively mult
 
 ## What is this SDK?
 
+*Note: This SDK is currently in alpha development. Expect breaking changes with new version releases.*
+
 The HYTOPIA SDK makes it easy for developers to create multiplayer games on the HYTOPIA platform using JavaScript or TypeScript. 
 
 Available as a simple NPM package, this SDK provides everything you need to get started:
@@ -29,17 +31,27 @@ With these resources, you can quickly build and share immersive, voxel-style mul
 
 1. Install a compatible JavaScript runtime. We recommend [Bun (recommended)](https://bun.sh/), but [Node.js](https://nodejs.org/) and [Deno](https://deno.com/) are also supported. All examples will be given using Bun.
 
-2. Install the SDK in a new or existing project.
+2. If you're starting a new project, initialize it.
+```bash
+bun init
+```
+
+3. Install the SDK in a new or existing project.
+```bash
+bun add hytopia
+```
+
+4. Initialize boilerplate. Copies assets and an index.ts game script into your project.
 ```bash
-npm install hytopia
+bunx hytopia init
 ```
 
-2. Run a local HYTOPIA server using an example game included in the SDK. The following command will start the Zombie Arena example game on port 8080.
+5. Start the server, use --watch for hot reloads as you make changes.
 ```bash
-bun hytopia examples/zombie-arena
+bun --watch index.ts
 ```
 
-3. Visit https://play.hytopia.com - when prompted, enter the local server your game is running on, which is `http://localhost:8080`.
+4. Visit https://play.hytopia.com - when prompted, enter `localhost:8080` - this is the default port of the local server you started in the previous step.
 
 Once you're up and running, here's some other resources to go further:
 - [Game Examples](./examples)

package/boilerplate/index.ts

@@ -41,6 +41,17 @@ import worldMap from './assets/map.json';
  */
 
 startServer(world => {
+  /**
+   * Enable debugging 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.
+   * 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);
+
   /**
    * Load our map.
    * You can build your own map using https://build.hytopia.com

package/docs/server.hytopia.simulation.enabledebug.md

@@ -0,0 +1,53 @@
+<!-- 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)
+
+## HYTOPIA.Simulation.enableDebug() 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.
+
+**Signature:**
+
+```typescript
+enableDebug(enabled: boolean): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+enabled
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether to enable debug rendering.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.simulation.isdebugenabled.md

@@ -0,0 +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)
+
+## HYTOPIA.Simulation.isDebugEnabled property
+
+Whether the simulation has debug rendering enabled.
+
+**Signature:**
+
+```typescript
+get isDebugEnabled(): boolean;
+```

package/docs/server.hytopia.simulation.md

@@ -61,6 +61,27 @@ RAPIER.Vector3
 The gravity vector for the simulation.
 
 
+</td></tr>
+<tr><td>
+
+[isDebugEnabled](./server.hytopia.simulation.isdebugenabled.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the simulation has debug rendering enabled.
+
+
 </td></tr>
 <tr><td>
 
@@ -137,5 +158,19 @@ Description
 Casts a ray through the simulation.
 
 
+</td></tr>
+<tr><td>
+
+[enableDebug(enabled)](./server.hytopia.simulation.enabledebug.md)
+
+
+</td><td>
+
+
+</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.
+
+
 </td></tr>
 </tbody></table>

package/docs/server.simulation.enabledebug.md

@@ -0,0 +1,53 @@
+<!-- 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)
+
+## Simulation.enableDebug() 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.
+
+**Signature:**
+
+```typescript
+enableDebug(enabled: boolean): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+enabled
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether to enable debug rendering.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.simulation.isdebugenabled.md

@@ -0,0 +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)
+
+## Simulation.isDebugEnabled property
+
+Whether the simulation has debug rendering enabled.
+
+**Signature:**
+
+```typescript
+get isDebugEnabled(): boolean;
+```

package/docs/server.simulation.md

@@ -61,6 +61,27 @@ RAPIER.Vector3
 The gravity vector for the simulation.
 
 
+</td></tr>
+<tr><td>
+
+[isDebugEnabled](./server.simulation.isdebugenabled.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the simulation has debug rendering enabled.
+
+
 </td></tr>
 <tr><td>
 
@@ -137,5 +158,19 @@ Description
 Casts a ray through the simulation.
 
 
+</td></tr>
+<tr><td>
+
+[enableDebug(enabled)](./server.simulation.enabledebug.md)
+
+
+</td><td>
+
+
+</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.
+
+
 </td></tr>
 </tbody></table>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "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": {

package/server.api.json

@@ -28114,6 +28114,54 @@
                   "isAbstract": false,
                   "name": "castRay"
                 },
+                {
+                  "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",
+                  "excerptTokens": [
+                    {
+                      "kind": "Content",
+                      "text": "enableDebug(enabled: "
+                    },
+                    {
+                      "kind": "Content",
+                      "text": "boolean"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": "): "
+                    },
+                    {
+                      "kind": "Content",
+                      "text": "void"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ";"
+                    }
+                  ],
+                  "isStatic": false,
+                  "returnTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "releaseTag": "Public",
+                  "isProtected": false,
+                  "overloadIndex": 1,
+                  "parameters": [
+                    {
+                      "parameterName": "enabled",
+                      "parameterTypeTokenRange": {
+                        "startIndex": 1,
+                        "endIndex": 2
+                      },
+                      "isOptional": false
+                    }
+                  ],
+                  "isOptional": false,
+                  "isAbstract": false,
+                  "name": "enableDebug"
+                },
                 {
                   "kind": "Property",
                   "canonicalReference": "server!HYTOPIA.Simulation#gravity:member",
@@ -28145,6 +28193,36 @@
                   "isProtected": false,
                   "isAbstract": false
                 },
+                {
+                  "kind": "Property",
+                  "canonicalReference": "server!HYTOPIA.Simulation#isDebugEnabled:member",
+                  "docComment": "/**\n * Whether the simulation has debug rendering enabled.\n */\n",
+                  "excerptTokens": [
+                    {
+                      "kind": "Content",
+                      "text": "get isDebugEnabled(): "
+                    },
+                    {
+                      "kind": "Content",
+                      "text": "boolean"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ";"
+                    }
+                  ],
+                  "isReadonly": true,
+                  "isOptional": false,
+                  "releaseTag": "Public",
+                  "name": "isDebugEnabled",
+                  "propertyTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isStatic": false,
+                  "isProtected": false,
+                  "isAbstract": false
+                },
                 {
                   "kind": "Property",
                   "canonicalReference": "server!HYTOPIA.Simulation#timestepS:member",
@@ -34773,6 +34851,54 @@
               "isAbstract": false,
               "name": "castRay"
             },
+            {
+              "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",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "enableDebug(enabled: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "enabled",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "enableDebug"
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!Simulation#gravity:member",
@@ -34804,6 +34930,36 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!Simulation#isDebugEnabled:member",
+              "docComment": "/**\n * Whether the simulation has debug rendering enabled.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get isDebugEnabled(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "isDebugEnabled",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!Simulation#timestepS:member",

package/server.d.ts

@@ -2297,6 +2297,9 @@ export declare class Simulation {
 
 
 
+
+    /** Whether the simulation has debug rendering enabled. */
+    get isDebugEnabled(): boolean;
     /** The gravity vector for the simulation. */
     get gravity(): RAPIER.Vector3;
     /** The fixed timestep for the simulation. */
@@ -2314,6 +2317,14 @@ export declare class Simulation {
     castRay(origin: RAPIER.Vector3, direction: RAPIER.Vector3, length: number, options?: RayCastOptions): Block | Entity | null;
 
 
+    /**
+     * 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.
+     * @param enabled - Whether to enable debug rendering.
+     */
+    enableDebug(enabled: boolean): void;