hytopia 0.1.13 → 0.1.14

package/README.md

@@ -29,7 +29,7 @@ With these resources, you can quickly build and share immersive, voxel-style mul
 
 ## Quickstart
 
-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.
+1. Install a compatible JavaScript runtime. We recommend you use [Bun](https://bun.sh/), but [Node.js](https://nodejs.org/) and [Deno](https://deno.com/) can work with additional configuration. All examples will be given using Bun.
 
 2. If you're starting a new project, initialize it.
 ```bash

package/docs/server.hytopia.md

@@ -733,6 +733,17 @@ Description
 The default rigid body options when EntityOptions.rigidBodyOptions is not provided.
 
 
+</td></tr>
+<tr><td>
+
+[PORT](./server.hytopia.port.md)
+
+
+</td><td>
+
+The port the server will listen on. You can override this in your .env by setting PORT.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.hytopia.port.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; [PORT](./server.hytopia.port.md)
+
+## HYTOPIA.PORT variable
+
+The port the server will listen on. You can override this in your .env by setting PORT.
+
+**Signature:**
+
+```typescript
+PORT: string | number
+```

package/docs/server.md

@@ -742,6 +742,17 @@ Description
 The default rigid body options when EntityOptions.rigidBodyOptions is not provided.
 
 
+</td></tr>
+<tr><td>
+
+[PORT](./server.port.md)
+
+
+</td><td>
+
+The port the server will listen on. You can override this in your .env by setting PORT.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.port.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; [PORT](./server.port.md)
+
+## PORT variable
+
+The port the server will listen on. You can override this in your .env by setting PORT.
+
+**Signature:**
+
+```typescript
+PORT: string | number
+```

package/package.json

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

@@ -23998,6 +23998,29 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "Variable",
+              "canonicalReference": "server!HYTOPIA.PORT:var",
+              "docComment": "/**\n * The port the server will listen on. You can override this in your .env by setting PORT.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "PORT: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string | number"
+                }
+              ],
+              "fileUrlPath": "src/networking/WebServer.ts",
+              "isReadonly": true,
+              "releaseTag": "Public",
+              "name": "PORT",
+              "variableTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "TypeAlias",
               "canonicalReference": "server!HYTOPIA.RawCollisionGroups:type",
@@ -30799,6 +30822,29 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "server!PORT:var",
+          "docComment": "/**\n * The port the server will listen on. You can override this in your .env by setting PORT.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "PORT: "
+            },
+            {
+              "kind": "Content",
+              "text": "string | number"
+            }
+          ],
+          "fileUrlPath": "src/networking/WebServer.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "PORT",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "server!RawCollisionGroups:type",

package/server.d.ts

@@ -1618,6 +1618,7 @@ declare namespace HYTOPIA {
         RigidBodyOptions,
         Simulation,
         WebServer,
+        PORT,
         World,
         WorldMap,
         WorldOptions,
@@ -1800,6 +1801,9 @@ export declare type PlayerOrientationState = {
     yaw: number;
 };
 
+/** The port the server will listen on. You can override this in your .env by setting PORT. */
+export declare const PORT: string | number;
+
 /** A raw set of collision groups represented as a 32-bit number. @public */
 export declare type RawCollisionGroups = RAPIER.InteractionGroups;