hytopia 0.1.30 → 0.1.32

package/README.md

@@ -1,7 +1,7 @@
 # HYTOPIA SDK
 
 ## Quick Links
-[Quickstart](#quickstart) • [Developer Docs](https://dev.hytopia.com/) • [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)
+[Quickstart (Start Here)](#quickstart-start-here) • [Developer Docs](https://dev.hytopia.com/) • [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?
 
@@ -28,32 +28,9 @@ Available as a simple NPM package, this SDK provides everything you need to get
 
 With these resources, you can quickly build and share immersive, voxel-style multiplayer games on HYTOPIA.
 
-## Quickstart
+## Quickstart (Start Here)
 
-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. Create a new project directory somewhere on your machine and navigate into it.
-```bash
-mkdir my-project-directory && cd my-project-directory
-```
-
-3. Initialize a hytopia project from boilerplate or an existing example. Sets up package.json and all dependencies, copies assets and an index.ts game script into your project.
-```bash
-# Option 1: Initialize a boilerplate project
-bunx hytopia init
-
-# Option 2: Initialize a project from any of the examples in the examples directory like so:
-bunx hytopia init --template payload-game
-```
-
-3. Start the server, use --watch for hot reloads as you make changes.
-```bash
-bun --watch index.ts
-```
-
-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.
-
-**Note: If you'd prefer to use JavaScript instead of TypeScript, simply change the file extension of index.ts to index.js - Your editor will highlight the TypeScript syntax errors, simple delete the type annotations and everything should work the same without any TypeScript usage.**
+**[Follow the Initial Setup guide, here](https://dev.hytopia.com/getting-started/initial-setup).**
 
 Once you're up and running, here's some other resources to go further:
 - [Developer Docs](https://dev.hytopia.com/)

package/bin/scripts.js

@@ -27,28 +27,34 @@ const path = require('path');
   if (command === 'init') {
     const destDir = process.cwd();
 
+    // Initialize project with latest HYTOPIA SDK
+    console.log('🔧 Initializing project with latest HYTOPIA SDK...');
+    execSync('bun init --yes');
+    execSync('bun add hytopia@latest');
+    
     if (flags.template) {
-      console.log(`🔧 Initializing project with examples template ${flags.template}`);
+      // Init from example template
+      console.log(`🖨️ Initializing project with examples template "${flags.template}"...`);
 
-      const templateDir = path.join(__dirname, '..', 'examples', flags.template);
+      const templateDir = path.join(destDir, 'node_modules', 'hytopia', 'examples', flags.template);
 
       if (!fs.existsSync(templateDir)) {
-        console.error(`Examples template ${flags.template} does not exist in the examples directory, could not initialize project!`);
+        console.error(`Examples template ${flags.template} does not exist in the examples directory, could not initialize project! Tried directory: ${templateDir}`);
         return;
       }
 
       fs.cpSync(templateDir, destDir, { recursive: true });
-      execSync('bun install');
     } else {
-      console.log('🔧 Initializing project');
-      execSync('bun init --yes');
-      execSync('bun add hytopia@latest');
-      
+      // Init from boilerplate
+      console.log('🧑‍💻 Initializing project with boilerplate...');
+
       const srcDir = path.join(__dirname, '..', 'boilerplate');
+      
       fs.cpSync(srcDir, destDir, { recursive: true });  
     }
 
     // Done, lfg!
+    console.log('--------------------------------');
     console.log('🚀 Hytopia project initialized successfully!');
     console.log('💡 Start your development server with `bun --watch index.ts`!');
     console.log('🎮 After you start your development server, play by opening your browser and visiting: https://play.hytopia.com/?join=localhost:8080')

package/boilerplate/assets/map.json

@@ -108,7 +108,7 @@
     {
       "id": 22,
       "name": "water_still",
-      "textureUri": "textures/water_still.png"
+      "textureUri": "textures/water.png"
     }
   ],
   "blocks": {
@@ -2620,4 +2620,4 @@
     "3,3,-11": 19,
     "-1,1,12": 11
   }
-}
+}

package/docs/server.entity.md

@@ -278,7 +278,7 @@ The name of the entity.
 
 </td><td>
 
-(entity: [Entity](./server.entity.md)<!-- -->, block: [BlockType](./server.blocktype.md)<!-- -->, started: boolean) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, blockType: [BlockType](./server.blocktype.md)<!-- -->, started: boolean) =&gt; void
 
 
 </td><td>
@@ -297,7 +297,7 @@ _(Optional)_ A function that is called when the entity collides with a block.
 
 </td><td>
 
-(entity: [Entity](./server.entity.md)<!-- -->, block: [BlockType](./server.blocktype.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, blockType: [BlockType](./server.blocktype.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
 
 
 </td><td>

package/docs/server.entity.onblockcollision.md

@@ -9,5 +9,5 @@ A function that is called when the entity collides with a block.
 **Signature:**
 
 ```typescript
-onBlockCollision?: (entity: Entity, block: BlockType, started: boolean) => void;
+onBlockCollision?: (entity: Entity, blockType: BlockType, started: boolean) => void;
 ```

package/docs/server.entity.onblockcontactforce.md

@@ -9,5 +9,5 @@ A function that is called when the entity collides with a block.
 **Signature:**
 
 ```typescript
-onBlockContactForce?: (entity: Entity, block: BlockType, contactForceData: ContactForceData) => void;
+onBlockContactForce?: (entity: Entity, blockType: BlockType, contactForceData: ContactForceData) => void;
 ```

package/docs/server.hytopia.entity.md

@@ -278,7 +278,7 @@ The name of the entity.
 
 </td><td>
 
-(entity: [Entity](./server.entity.md)<!-- -->, block: [BlockType](./server.blocktype.md)<!-- -->, started: boolean) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, blockType: [BlockType](./server.blocktype.md)<!-- -->, started: boolean) =&gt; void
 
 
 </td><td>
@@ -297,7 +297,7 @@ _(Optional)_ A function that is called when the entity collides with a block.
 
 </td><td>
 
-(entity: [Entity](./server.entity.md)<!-- -->, block: [BlockType](./server.blocktype.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, blockType: [BlockType](./server.blocktype.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
 
 
 </td><td>

package/docs/server.hytopia.entity.onblockcollision.md

@@ -9,5 +9,5 @@ A function that is called when the entity collides with a block.
 **Signature:**
 
 ```typescript
-onBlockCollision?: (entity: Entity, block: BlockType, started: boolean) => void;
+onBlockCollision?: (entity: Entity, blockType: BlockType, started: boolean) => void;
 ```

package/docs/server.hytopia.entity.onblockcontactforce.md

@@ -9,5 +9,5 @@ A function that is called when the entity collides with a block.
 **Signature:**
 
 ```typescript
-onBlockContactForce?: (entity: Entity, block: BlockType, contactForceData: ContactForceData) => void;
+onBlockContactForce?: (entity: Entity, blockType: BlockType, contactForceData: ContactForceData) => void;
 ```

package/docs/server.hytopia.md

@@ -192,6 +192,17 @@ Manages the game and associated worlds and systems.
 A player in the game.
 
 
+</td></tr>
+<tr><td>
+
+[PlayerCamera](./server.hytopia.playercamera.md)
+
+
+</td><td>
+
+The camera for a Player.
+
+
 </td></tr>
 <tr><td>
 
@@ -409,6 +420,26 @@ Event types an Entity instance can emit.
 Event types a GameServer instance can emit.
 
 
+</td></tr>
+<tr><td>
+
+[PlayerCameraEventType](./server.hytopia.playercameraeventtype.md)
+
+
+</td><td>
+
+Event types a PlayerCamera can emit.
+
+
+</td></tr>
+<tr><td>
+
+[PlayerCameraMode](./server.hytopia.playercameramode.md)
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 
@@ -718,6 +749,17 @@ Payloads for events an Entity instance can emit.
 Payloads for events emitted by a GameServer instance.
 
 
+</td></tr>
+<tr><td>
+
+[PlayerCameraEventPayload](./server.hytopia.playercameraeventpayload.md)
+
+
+</td><td>
+
+Payloads for events a PlayerCamera can emit.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.hytopia.player.camera.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; [Player](./server.hytopia.player.md) &gt; [camera](./server.hytopia.player.camera.md)
+
+## HYTOPIA.Player.camera property
+
+The camera for the player.
+
+**Signature:**
+
+```typescript
+readonly camera: PlayerCamera;
+```

package/docs/server.hytopia.player.md

@@ -43,6 +43,27 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[camera](./server.hytopia.player.camera.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[PlayerCamera](./server.playercamera.md)
+
+
+</td><td>
+
+The camera for the player.
+
+
+</td></tr>
+<tr><td>
+
 [id](./server.hytopia.player.id.md)
 
 

package/docs/server.hytopia.playercamera.attachedtoentity.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; [PlayerCamera](./server.hytopia.playercamera.md) &gt; [attachedToEntity](./server.hytopia.playercamera.attachedtoentity.md)
+
+## HYTOPIA.PlayerCamera.attachedToEntity property
+
+The entity the camera is attached to.
+
+**Signature:**
+
+```typescript
+get attachedToEntity(): Entity | undefined;
+```

package/docs/server.hytopia.playercamera.attachedtoposition.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; [PlayerCamera](./server.hytopia.playercamera.md) &gt; [attachedToPosition](./server.hytopia.playercamera.attachedtoposition.md)
+
+## HYTOPIA.PlayerCamera.attachedToPosition property
+
+The position the camera is attached to.
+
+**Signature:**
+
+```typescript
+get attachedToPosition(): Vector3 | undefined;
+```

package/docs/server.hytopia.playercamera.filmoffset.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; [PlayerCamera](./server.hytopia.playercamera.md) &gt; [filmOffset](./server.hytopia.playercamera.filmoffset.md)
+
+## HYTOPIA.PlayerCamera.filmOffset property
+
+The film offset of the camera. A positive value shifts the camera right, a negative value shifts it left.
+
+**Signature:**
+
+```typescript
+get filmOffset(): number;
+```

package/docs/server.hytopia.playercamera.forwardoffset.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; [PlayerCamera](./server.hytopia.playercamera.md) &gt; [forwardOffset](./server.hytopia.playercamera.forwardoffset.md)
+
+## HYTOPIA.PlayerCamera.forwardOffset property
+
+Only used in first-person mode. The forward offset of the camera. A positive number shifts the camera forward, a negative number shifts it backward.
+
+**Signature:**
+
+```typescript
+get forwardOffset(): number;
+```

package/docs/server.hytopia.playercamera.fov.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; [PlayerCamera](./server.hytopia.playercamera.md) &gt; [fov](./server.hytopia.playercamera.fov.md)
+
+## HYTOPIA.PlayerCamera.fov property
+
+The field of view of the camera.
+
+**Signature:**
+
+```typescript
+get fov(): number;
+```

package/docs/server.hytopia.playercamera.hiddenmodelnodes.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; [PlayerCamera](./server.hytopia.playercamera.md) &gt; [hiddenModelNodes](./server.hytopia.playercamera.hiddenmodelnodes.md)
+
+## HYTOPIA.PlayerCamera.hiddenModelNodes property
+
+The nodes of the model the camera is attached to that will not be rendered for the player. Uses case insensitive substring matching.
+
+**Signature:**
+
+```typescript
+get hiddenModelNodes(): Set<string>;
+```

package/docs/server.hytopia.playercamera.lookatentity.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; [PlayerCamera](./server.hytopia.playercamera.md) &gt; [lookAtEntity](./server.hytopia.playercamera.lookatentity.md)
+
+## HYTOPIA.PlayerCamera.lookAtEntity() method
+
+Makes the camera look at an entity. If the camera was previously tracking an entity or position, it will stop tracking.
+
+**Signature:**
+
+```typescript
+lookAtEntity(entity: Entity): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+entity
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+The entity to look at.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.playercamera.lookatposition.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; [PlayerCamera](./server.hytopia.playercamera.md) &gt; [lookAtPosition](./server.hytopia.playercamera.lookatposition.md)
+
+## HYTOPIA.PlayerCamera.lookAtPosition() method
+
+Makes the camera look at a position. If the camera was previously tracking an entity or position, it will stop tracking.
+
+**Signature:**
+
+```typescript
+lookAtPosition(position: Vector3): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+position
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The position to look at.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+