hytopia 0.1.9 → 0.1.12

package/README.md

@@ -5,7 +5,7 @@
 
 ## What is HYTOPIA?
 
-![HYTOPIA Banner](./docs/assets/banner.png)
+![HYTOPIA Banner](./readme/assets/banner.png)
 HYTOPIA is a modern games platform inspired by Minecraft, Roblox, and Rec Room.
 
 HYTOPIA allows you to create your own highly-sharable, immersive, massively multiplayer games in a voxel-like style. All playable in a web browser on any device!
@@ -51,7 +51,7 @@ bunx hytopia init
 bun --watch index.ts
 ```
 
-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.
+6. Visit https://play.hytopia.com - when prompted, enter `localhost:8080` - this is the hostname 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

@@ -25,6 +25,7 @@
 
 import {
   startServer,
+  GameServer,
   PlayerEntity,
 } from 'hytopia';
 
@@ -41,6 +42,17 @@ import worldMap from './assets/map.json';
  */
 
 startServer(world => {
+  /**
+   * Enable SSL for local development. This allows you to
+   * connect to your local game server from https://play.hytopia.com
+   * without having to manually set up SSL.
+   * 
+   * If you are using a reverse proxy like ngrok (IE, `ngrok http 8080`)
+   * so others can connect to your local game server via the ngrok
+   * provided URL, make sure to remove this or comment it out.
+   */
+  GameServer.instance.webServer.enableLocalSSL();
+
   /**
    * Enable debug rendering of the physics simulation.
    * This will overlay lines in-game representing colliders,

package/docs/server.gameserver.md

@@ -84,6 +84,27 @@ The singleton instance of the game server.
 The player manager for the game server.
 
 
+</td></tr>
+<tr><td>
+
+[webServer](./server.gameserver.webserver.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[WebServer](./server.webserver.md)
+
+
+</td><td>
+
+The web server for the game server.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.gameserver.webserver.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; [GameServer](./server.gameserver.md) &gt; [webServer](./server.gameserver.webserver.md)
+
+## GameServer.webServer property
+
+The web server for the game server.
+
+**Signature:**
+
+```typescript
+get webServer(): WebServer;
+```

package/docs/server.hytopia.gameserver.md

@@ -84,6 +84,27 @@ The singleton instance of the game server.
 The player manager for the game server.
 
 
+</td></tr>
+<tr><td>
+
+[webServer](./server.hytopia.gameserver.webserver.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[WebServer](./server.webserver.md)
+
+
+</td><td>
+
+The web server for the game server.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.hytopia.gameserver.webserver.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; [GameServer](./server.hytopia.gameserver.md) &gt; [webServer](./server.hytopia.gameserver.webserver.md)
+
+## HYTOPIA.GameServer.webServer property
+
+The web server for the game server.
+
+**Signature:**
+
+```typescript
+get webServer(): WebServer;
+```

package/docs/server.hytopia.md

@@ -236,6 +236,17 @@ Represents a rigid body in a world's physics simulation.
 Represents the physics simulation for a world.
 
 
+</td></tr>
+<tr><td>
+
+[WebServer](./server.hytopia.webserver.md)
+
+
+</td><td>
+
+Manages the internal HTTP server for the game server.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.hytopia.webserver.enablelocalssl.md

@@ -0,0 +1,17 @@
+<!-- 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; [WebServer](./server.hytopia.webserver.md) &gt; [enableLocalSSL](./server.hytopia.webserver.enablelocalssl.md)
+
+## HYTOPIA.WebServer.enableLocalSSL() method
+
+Enables SSL for local development. The server will be available at https://localhost:8080. This is intended for local development without a reverse proxy. Don't use it when using tunnels like ngrok.com that already handle SSL. Usage of this method will be ignored in production. Must be called in init function of [startServer()](./server.startserver.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+enableLocalSSL(): void;
+```
+**Returns:**
+
+void
+

package/docs/server.hytopia.webserver.md

@@ -0,0 +1,54 @@
+<!-- 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; [WebServer](./server.hytopia.webserver.md)
+
+## HYTOPIA.WebServer class
+
+Manages the internal HTTP server for the game server.
+
+**Signature:**
+
+```typescript
+export default class WebServer implements Readyable 
+```
+**Implements:** Readyable
+
+## Remarks
+
+This class is used as a singleton and should be accessed via the GameServer.webServer property.
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `WebServer` class.
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[enableLocalSSL()](./server.hytopia.webserver.enablelocalssl.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Enables SSL for local development. The server will be available at https://localhost:8080. This is intended for local development without a reverse proxy. Don't use it when using tunnels like ngrok.com that already handle SSL. Usage of this method will be ignored in production. Must be called in init function of [startServer()](./server.startserver.md)<!-- -->.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.md

@@ -236,6 +236,17 @@ Represents a rigid body in a world's physics simulation.
 Represents the physics simulation for a world.
 
 
+</td></tr>
+<tr><td>
+
+[WebServer](./server.webserver.md)
+
+
+</td><td>
+
+Manages the internal HTTP server for the game server.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.webserver.enablelocalssl.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [WebServer](./server.webserver.md) &gt; [enableLocalSSL](./server.webserver.enablelocalssl.md)
+
+## WebServer.enableLocalSSL() method
+
+Enables SSL for local development. The server will be available at https://localhost:8080. This is intended for local development without a reverse proxy. Don't use it when using tunnels like ngrok.com that already handle SSL. Usage of this method will be ignored in production. Must be called in init function of [startServer()](./server.startserver.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+enableLocalSSL(): void;
+```
+**Returns:**
+
+void
+

package/docs/server.webserver.md

@@ -0,0 +1,54 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [WebServer](./server.webserver.md)
+
+## WebServer class
+
+Manages the internal HTTP server for the game server.
+
+**Signature:**
+
+```typescript
+export default class WebServer implements Readyable 
+```
+**Implements:** Readyable
+
+## Remarks
+
+This class is used as a singleton and should be accessed via the GameServer.webServer property.
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `WebServer` class.
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[enableLocalSSL()](./server.webserver.enablelocalssl.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Enables SSL for local development. The server will be available at https://localhost:8080. This is intended for local development without a reverse proxy. Don't use it when using tunnels like ngrok.com that already handle SSL. Usage of this method will be ignored in production. Must be called in init function of [startServer()](./server.startserver.md)<!-- -->.
+
+
+</td></tr>
+</tbody></table>

package/package.json

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

@@ -11284,6 +11284,37 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!GameServer#webServer:member",
+              "docComment": "/**\n * The web server for the game server.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get webServer(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "WebServer",
+                  "canonicalReference": "server!WebServer:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "webServer",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!GameServer#worlds:member",
@@ -22611,6 +22642,37 @@
                   "isProtected": false,
                   "isAbstract": false
                 },
+                {
+                  "kind": "Property",
+                  "canonicalReference": "server!HYTOPIA.GameServer#webServer:member",
+                  "docComment": "/**\n * The web server for the game server.\n */\n",
+                  "excerptTokens": [
+                    {
+                      "kind": "Content",
+                      "text": "get webServer(): "
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "WebServer",
+                      "canonicalReference": "server!WebServer:class"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ";"
+                    }
+                  ],
+                  "isReadonly": true,
+                  "isOptional": false,
+                  "releaseTag": "Public",
+                  "name": "webServer",
+                  "propertyTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isStatic": false,
+                  "isProtected": false,
+                  "isAbstract": false
+                },
                 {
                   "kind": "Property",
                   "canonicalReference": "server!HYTOPIA.GameServer#worlds:member",
@@ -28593,6 +28655,70 @@
               ],
               "extendsTokenRanges": []
             },
+            {
+              "kind": "Class",
+              "canonicalReference": "server!HYTOPIA.WebServer:class",
+              "docComment": "/**\n * Manages the internal HTTP server for the game server.\n *\n * @remarks\n *\n * This class is used as a singleton and should be accessed via the GameServer.webServer property.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `WebServer` class.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "export default class WebServer implements "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Readyable",
+                  "canonicalReference": "server!~Readyable:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " "
+                }
+              ],
+              "fileUrlPath": "src/networking/WebServer.ts",
+              "releaseTag": "Public",
+              "isAbstract": false,
+              "name": "WebServer",
+              "preserveMemberOrder": false,
+              "members": [
+                {
+                  "kind": "Method",
+                  "canonicalReference": "server!HYTOPIA.WebServer#enableLocalSSL:member(1)",
+                  "docComment": "/**\n * Enables SSL for local development. The server will be available at https://localhost:8080. This is intended for local development without a reverse proxy. Don't use it when using tunnels like ngrok.com that already handle SSL. Usage of this method will be ignored in production. Must be called in init function of {@link startServer}.\n */\n",
+                  "excerptTokens": [
+                    {
+                      "kind": "Content",
+                      "text": "enableLocalSSL(): "
+                    },
+                    {
+                      "kind": "Content",
+                      "text": "void"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ";"
+                    }
+                  ],
+                  "isStatic": false,
+                  "returnTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "releaseTag": "Public",
+                  "isProtected": false,
+                  "overloadIndex": 1,
+                  "parameters": [],
+                  "isOptional": false,
+                  "isAbstract": false,
+                  "name": "enableLocalSSL"
+                }
+              ],
+              "implementsTokenRanges": [
+                {
+                  "startIndex": 1,
+                  "endIndex": 2
+                }
+              ]
+            },
             {
               "kind": "Class",
               "canonicalReference": "server!HYTOPIA.World:class",
@@ -35330,6 +35456,70 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Class",
+          "canonicalReference": "server!WebServer:class",
+          "docComment": "/**\n * Manages the internal HTTP server for the game server.\n *\n * @remarks\n *\n * This class is used as a singleton and should be accessed via the GameServer.webServer property.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `WebServer` class.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export default class WebServer implements "
+            },
+            {
+              "kind": "Reference",
+              "text": "Readyable",
+              "canonicalReference": "server!~Readyable:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/networking/WebServer.ts",
+          "releaseTag": "Public",
+          "isAbstract": false,
+          "name": "WebServer",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Method",
+              "canonicalReference": "server!WebServer#enableLocalSSL:member(1)",
+              "docComment": "/**\n * Enables SSL for local development. The server will be available at https://localhost:8080. This is intended for local development without a reverse proxy. Don't use it when using tunnels like ngrok.com that already handle SSL. Usage of this method will be ignored in production. Must be called in init function of {@link startServer}.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "enableLocalSSL(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "enableLocalSSL"
+            }
+          ],
+          "implementsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            }
+          ]
+        },
         {
           "kind": "Class",
           "canonicalReference": "server!World:class",

package/server.d.ts

@@ -1528,7 +1528,8 @@ export declare class GameServer {
     /** The player manager for the game server. */
     get playerManager(): PlayerManager;
 
-
+    /** The web server for the game server. */
+    get webServer(): WebServer;
     /** The worlds managed by the game server. */
     get worlds(): {
         [id: string]: World;
@@ -1616,6 +1617,7 @@ declare namespace HYTOPIA {
         RigidBodyAdditionalMassProperties,
         RigidBodyOptions,
         Simulation,
+        WebServer,
         World,
         WorldMap,
         WorldOptions,
@@ -2367,6 +2369,43 @@ export declare interface Vector3Boolean {
     x: boolean;
     y: boolean;
     z: boolean;
+}
+
+/**
+ * Manages the internal HTTP server for the game server.
+ *
+ * @remarks
+ * This class is used as a singleton and should be
+ * accessed via the GameServer.webServer property.
+ *
+ * @public
+ */
+export declare class WebServer implements Readyable {
+
+
+
+
+
+
+
+
+
+    /**
+     * Enables SSL for local development. The server will be
+     * available at https://localhost:8080. This is intended
+     * for local development without a reverse proxy. Don't
+     * use it when using tunnels like ngrok.com that already
+     * handle SSL. Usage of this method will be ignored
+     * in production. Must be called in init function of
+     * {@link startServer}.
+     */
+    enableLocalSSL(): void;
+
+
+
+
+
+
 }
 
 /**