hytopia 0.1.19 → 0.1.21

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Create a bug report. Use this for unexpected behaviors that we can reproduce so we can fix them in the SDK. If we find your issue is not an SDK bug, we'll provide clarity on a fix for your code.
+title: <Concise title for this bug> [BUG]
+labels: bug
+assignees: iamarkdev
+
+---
+
+**What were you trying to do, what did you expect to happen?**
+Let us know what you were trying to do, and what you expected your code to do that it did not.
+
+**What actually happened?**
+What did your code actually do? Explain the bug/issue clearly.
+
+**To Reproduce**
+For SDK specific bugs, please provide the HYTOPIA SDK version you're using and a complete snippet of your code so we can reproduce this issue locally.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

package/README.md

@@ -1,7 +1,7 @@
 # HYTOPIA SDK
 
 ## Quick Links
-[Quickstart](#quickstart) • [API Reference](./docs/server.md) • [Report Bugs or Request Features](https://github.com/hytopiagg/sdk/issues)
+[Quickstart](#quickstart) • [API Reference](./docs/server.md) • [Examples](./examples) • [Join Our Developer Discord](https://discord.gg/hytopia-developers) • [Report Bugs or Request Features](https://github.com/hytopiagg/sdk/issues)
 
 ## What is HYTOPIA?
 

package/bin/scripts.js

@@ -43,7 +43,8 @@ const path = require('path');
       console.log('🔧 Initializing project');
       execSync('bun init --yes');
       execSync('bun add hytopia');
-
+      
+      const srcDir = path.join(__dirname, '..', 'boilerplate');
       fs.cpSync(srcDir, destDir, { recursive: true });  
     }
 

package/boilerplate/assets/certs/README.md

@@ -1,7 +1,6 @@
 For local development self-signed certs are stored here.
-The server when GameServer.instance.webServer.enableLocalSSL();
-is used, will look for assets/certs/localhost.key and
-assets/certs/localhost.cert and use those for SSL.
+The server will look for assets/certs/localhost.key and
+assets/certs/localhost.cert and use those for localhost SSL.
 
 We use these self-signed certs to allow https://localhost
 & wss://localhost support. Without this, play.hytopia.com

package/boilerplate/index.ts

@@ -42,17 +42,6 @@ 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.hytopia.webserver.md

@@ -19,36 +19,3 @@ This class is used as a singleton and should be accessed via the GameServer.webS
 
 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.webserver.md

@@ -19,36 +19,3 @@ This class is used as a singleton and should be accessed via the GameServer.webS
 
 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/examples/README.md

@@ -0,0 +1,22 @@
+# HYTOPIA SDK Examples
+
+HYTOPIA SDK examples are a collection of HYTOPIA SDK projects that demonstrate full games or specific features using the SDK.
+
+In each folder, you'll find an index.ts file - this is the main entry point and where you'll find the code for each example.
+
+Here's an overview of the examples available:
+- [`payload-game`](./payload-game): A simple game where players must stay near a payload for it to move towards its destination while enemies spawn and swarm the players.
+- [`character-controller`](./character-controller): A simple example of how to implement your own character controller class.
+- [`entity-spawn`](./entity-spawn): A simple example of how to spawn an entity and set some of its properties.
+
+## Use Examples As Templates For Your Projects
+
+If you want to init a new HYTOPIA project based on an example in this directory, you can use the `hytopia init` command with the `--template` flag. 
+
+For example, to create a new project based on the `payload-game` example, you can run:
+
+```bash
+bunx hytopia init --template payload-game
+```
+
+The value passed to the `--template` flag should be the name of the folder in the examples directory.

package/examples/character-controller/assets/certs/README.md

@@ -1,7 +1,6 @@
 For local development self-signed certs are stored here.
-The server when GameServer.instance.webServer.enableLocalSSL();
-is used, will look for assets/certs/localhost.key and
-assets/certs/localhost.cert and use those for SSL.
+The server will look for assets/certs/localhost.key and
+assets/certs/localhost.cert and use those for localhost SSL.
 
 We use these self-signed certs to allow https://localhost
 & wss://localhost support. Without this, play.hytopia.com

package/examples/character-controller/index.ts

@@ -9,7 +9,6 @@ import MyCharacterController from './MyCharacterController';
 import worldMap from './assets/map.json';
 
 startServer(world => {
-  GameServer.instance.webServer.enableLocalSSL();
   world.simulation.enableDebugRendering(true);
   world.loadMap(worldMap);
 

package/examples/entity-spawn/assets/certs/README.md

@@ -1,7 +1,6 @@
 For local development self-signed certs are stored here.
-The server when GameServer.instance.webServer.enableLocalSSL();
-is used, will look for assets/certs/localhost.key and
-assets/certs/localhost.cert and use those for SSL.
+The server will look for assets/certs/localhost.key and
+assets/certs/localhost.cert and use those for localhost SSL.
 
 We use these self-signed certs to allow https://localhost
 & wss://localhost support. Without this, play.hytopia.com

package/examples/entity-spawn/index.ts

@@ -68,8 +68,6 @@ startServer(world => {
  * Boilerplate setup for our example
  */
 function setup(world: World) {
-  GameServer.instance.webServer.enableLocalSSL();
-
   world.simulation.enableDebugRendering(true);
   world.loadMap(worldMap);
 

package/examples/payload-game/assets/certs/README.md

@@ -1,7 +1,6 @@
 For local development self-signed certs are stored here.
-The server when GameServer.instance.webServer.enableLocalSSL();
-is used, will look for assets/certs/localhost.key and
-assets/certs/localhost.cert and use those for SSL.
+The server will look for assets/certs/localhost.key and
+assets/certs/localhost.cert and use those for localhost SSL.
 
 We use these self-signed certs to allow https://localhost
 & wss://localhost support. Without this, play.hytopia.com

package/examples/payload-game/index.ts

@@ -1,5 +1,19 @@
 /**
+ * payload-game is a simple game that encompasses a number of core HYTOPIA SDK systems.
+ * This example utilizes entities, spawning, rigid body, colliders and sensors, 
+ * collision groups, audio, character controller hooks, and more.
  * 
+ * This example is a quick and dirty implementation of an overwatch style push the payload
+ * in a multiplayer PvE style. Players start the game around the payload and must stay near it
+ * for it to move towards the next waypoint. Enemies spawn near the next arget waypoint of 
+ * the payload and swarm towards the players. Players can left click to shoot spiders with
+ * bullets.
+ * 
+ * This example is not meant to be a polished game, but rather a demonstration of how to use
+ * the SDK to build your own games. 
+ * 
+ * In a polished implementation, we'd be using multiple files and not just index.ts to
+ * break out and properly organize game behavior and mechanics.
  */
 
 import {
@@ -75,11 +89,6 @@ let targetWaypointCoordinateIndex = 0; // Current waypoint coordinate index for
 startServer(world => { // Perform our game setup logic in the startServer init callback here.
   const chatManager = world.chatManager;
 
-  // Enable local ssl, so we can connect to https://localhost:8080 from play.hytopia.com for testing
-  // If using NGROK or a reverse proxy that handles SSL, you need to comment this out to be able to
-  // connect to the server from the client using the reverse proxy URL.
-  GameServer.instance.webServer.enableLocalSSL();
-
   // Load Map
   world.loadMap(map);
 

package/package.json

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

@@ -28702,39 +28702,7 @@
               "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"
-                }
-              ],
+              "members": [],
               "implementsTokenRanges": [
                 {
                   "startIndex": 1,
@@ -35526,39 +35494,7 @@
           "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"
-            }
-          ],
+          "members": [],
           "implementsTokenRanges": [
             {
               "startIndex": 1,

package/server.d.ts

@@ -2401,16 +2401,6 @@ 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;