hytopia 0.1.13 → 0.1.15

package/README.md

@@ -29,29 +29,24 @@ 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.
+2. Create a new project directory somewhere on your machine and navigate into it.
 ```bash
-bun init
+mkdir my-project-directory && cd my-project-directory
 ```
 
-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.
+3. Initialize a hytopia project. Sets up package.json and all dependencies, copies assets and an index.ts game script into your project.
 ```bash
 bunx hytopia init
 ```
 
-5. Start the server, use --watch for hot reloads as you make changes.
+3. Start the server, use --watch for hot reloads as you make changes.
 ```bash
 bun --watch index.ts
 ```
 
-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.
+4. 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/bin/scripts.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
+const { execSync } = require('child_process');
 const fs = require('fs');
 const path = require('path');
-const mkcert = require('mkcert');
 
 (async () => {
   const command = process.argv[2];
@@ -10,35 +10,23 @@ const mkcert = require('mkcert');
   /**
    * Init command
    * 
-   * Initializes a new HYTOPIA project.
+   * Initializes a new HYTOPIA project. Accepting an optional
+   * project name as an argument.
+   * 
+   * @example
+   * `bunx hytopia init my-project-name`
    */
   if (command === 'init') {
     const srcDir = path.join(__dirname, '..', 'boilerplate');
     const destDir = process.cwd();
-  
+ 
+    // Initialize project
+    execSync('bun init --yes');
+    execSync('bun add hytopia');
+
     // 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,
-    });
-
-    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!');

package/boilerplate/assets/certs/README.md

@@ -1,6 +1,11 @@
-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.
+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.
+
+We use these self-signed certs 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 your local server. This is only used
+for local development and will be ignored when your game
+is deployed to HYTOPIA servers.

package/boilerplate/assets/certs/localhost.crt

@@ -0,0 +1,20 @@
+-----BEGIN CERTIFICATE-----
+MIIDRjCCAi6gAwIBAgIFOTEzNTIwDQYJKoZIhvcNAQELBQAwWDEQMA4GA1UEAxMH
+SFlUT1BJQTELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNV
+BAcTB1NlYXR0bGUxEDAOBgNVBAoTB0hZVE9QSUEwHhcNMjQxMTEzMjIyMjEwWhcN
+MzQxMTExMjIyMjEwWjAUMRIwEAYDVQQDEwlsb2NhbGhvc3QwggEiMA0GCSqGSIb3
+DQEBAQUAA4IBDwAwggEKAoIBAQCo2i9L13+4KxvR9dxBeE3Xrj5WtoGFBwbUZkeV
+3B8n+ehJ2LWD13sGvCuHvSDovbSOxLxqbESQzWBRVrmfJMR1qe+o7kd/SMaLHosC
+2BWASn1oV9rGLktvd2Xs6xRf75cejzrr/OrNoTpICp3j1Z0Kd+73TuYyVFPfCbqH
+N6mwS+yCmG2/w3sXwbOGymNuYpaPoD8XVcIhO7GPZsCVqqSKP2xsGF+oP5+Isma+
+y3usNUnFnVW5ckk6SWWdxP9kuOW2xXoFFwj43STaE4OvXbTPCG7jowUpDH1aMvFA
+ceXUfuaE7H8QfZqoUNu8jCb8LiqTL+uL5kHbl2kQ7sQCN9gjAgMBAAGjWzBZMAwG
+A1UdEwEB/wQCMAAwDgYDVR0PAQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMB
+BggrBgEFBQcDAjAaBgNVHREEEzARgglsb2NhbGhvc3SHBH8AAAEwDQYJKoZIhvcN
+AQELBQADggEBAHSINJsVuu11kmzx7/2yEiDSIQVzdzk/+hnx0iQt6rDy9ZNVdI8w
+JOUYaPjxDFfZ5gaPqrlb0n248lBMdGrp6xmhbgXL8eWkXRDcR6kuYBQrQmFitg7G
+KFFWnzCuQMLn5Mn6VA+sBf9n2LVaOQCci9jU0awRpaQTUNf894USjILo+PvbcUGU
+XlMtqc1abkN4NehDdaXsxMwyPgUCPkN5X80s8hxx5NgzwtwDtoTYj/PBRBXBddA+
+oN1rwkugWiTpIPU0wKb0ufLsq96I24UDQWd2jJGbD2W23Z0lwVz/Bq6uc4aOJn68
+JbejJgFyF3/m6oFDxgqMnuV5q5olVZHAWL8=
+-----END CERTIFICATE-----

package/boilerplate/assets/certs/localhost.key

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEowIBAAKCAQEAqNovS9d/uCsb0fXcQXhN164+VraBhQcG1GZHldwfJ/noSdi1
+g9d7Brwrh70g6L20jsS8amxEkM1gUVa5nyTEdanvqO5Hf0jGix6LAtgVgEp9aFfa
+xi5Lb3dl7OsUX++XHo866/zqzaE6SAqd49WdCnfu907mMlRT3wm6hzepsEvsgpht
+v8N7F8GzhspjbmKWj6A/F1XCITuxj2bAlaqkij9sbBhfqD+fiLJmvst7rDVJxZ1V
+uXJJOkllncT/ZLjltsV6BRcI+N0k2hODr120zwhu46MFKQx9WjLxQHHl1H7mhOx/
+EH2aqFDbvIwm/C4qky/ri+ZB25dpEO7EAjfYIwIDAQABAoIBAA6dvGRbRiICEUlu
+d99u84YM/jZxW+rQ/eVa6S1uvX+vYU0rJiNAftTJaxc35uZerYeCPjEUKCdEr+a6
+lBzTiPIKgMVlwuiguxcF0NCxNcNCL3Ld0AFBtqPyeO82NjBLxBAQI/CTlxuvriTY
+TmyPbCWg1h2wRbrrk8sFw5C638Rz2evbBfsUcTICr6QQa51YXgxawtew3Xy3aR3G
+PPuS7zlvjJYDApQs3+nakEj3DnM2nz5oJNS2YEsMKQRhmNrhen6Ose5G0jf6F6up
+8HVpN3XW01D7qVT1Og6Y5dE2EM/l3isKZWXif6CcFKoOy87z8HRMIoZJS62WtKtu
+liBmYxkCgYEA4VDPtFAGnChCTGLVwo7MKmH6/KU5Qj2fuufGNw8jcW3H0Ea52OFC
+qOGA9pRJVXCap7Wa7XCJXENLYWpSfB7H7GnhFLwHw7jAVB52DLDCdUnRv5fP3o8K
+xEseMJQaJm95eFVfTETcnjDixWtIzNbXULQbGjF3AY74aFjc1fhc/yUCgYEAv9jj
+Zrc+UzR0oi00Ip8O5C5Uvu2W35M+j2XoV/xPkX+Hcr12U40Gnc/rnzVp2lGTwNZS
+ImQcjLEd31qLOy90F9lcaKvOfgcx0JvGEp5SdzQQaS3RJqn0xWLh1O4NMsiVbLNi
+Zi5qFv7pW/DO174xSa7cMVE8qp8YHAOZdpcqm6cCgYB9FL2ZnetteTQE78E3NsrE
+pIwPATIeQdOQkOaK3k6Qw57vUrQNYE//LODJAl0Ln21buQd+1MCMhZctRzbvTK8z
+4TtgpVmyH7g1eouSU/Y/4nEcaYyuQr55ZjImSbGSsMPAN7SlxHytHPpnGj3Z6VKy
+rKl3CwrDxLjGRL6j0jLeOQKBgBiu3xMoIGy0Iw16o2qQ7GmPTHgEOZUqbLImem5X
+mCUwM00f80lsq51CUx540NW2CTyWVpr2JnYzk5RZIfDLejRXUvxknny4kEA2ypU6
+qYGMwU/HBVHkLAn5XvT2a9xM0mzZ558d+ahbw8qAgRxg7BZ+2PW/bf7F2WRBUk1f
+xauhAoGBALEspoxQozwohGQnP7EMF0/0JoKNpdNv0b0qCVvNiMo0+N297lI2mFQp
+6xYlW/1l9afLokklF/J2IsyBrTCZoY7SaEk/lMMrQSyra+y0z71ogZ8A4ny9fxsj
+0dDYJZGllL+3E/MQfd7k+KnOM/+A+cPoAnci76+L3vdkUb2P8SJk
+-----END RSA PRIVATE KEY-----

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.15",
   "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,8 +46,5 @@
   "bugs": {
     "url": "https://github.com/hytopiagg/sdk/issues"
   },
-  "homepage": "https://github.com/hytopiagg/sdk#readme",
-  "dependencies": {
-    "mkcert": "^3.2.0"
-  }
+  "homepage": "https://github.com/hytopiagg/sdk#readme"
 }

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;