@hytopia.com/server-protocol 1.0.12 → 1.0.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hytopia.com/server-protocol",
-  "version": "1.0.12",
+  "version": "1.0.15",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/packets/PacketCore.ts

@@ -20,11 +20,13 @@ import type { JSONSchemaType, ValidateFunction } from 'ajv';
 export enum PacketId {
   // Standard Inbound Packet Types: 0 - 31 range
   HEARTBEAT = 0,
-  INPUT = 1,
+  DEBUG_CONFIG = 1,
+  INPUT = 2,
+  STATE_REQUEST = 3,
 
   // Standard Outbound Packet Types: 32 - 127 range
   BLOCK = 32,
-  BLOCK_REGISTRY = 33,
+  BLOCK_TYPE_REGISTRY = 33,
   BLOCK_TYPE = 34,
   CHUNK = 35,
   ENTITY = 36,

package/packets/inbound/DebugConfig.ts

@@ -0,0 +1,11 @@
+import { definePacket, PacketId } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
+import { debugConfigSchema } from '../../schemas/DebugConfig';
+import type { DebugConfigSchema } from '../../schemas/DebugConfig';
+
+export type DebugConfigPacket = IPacket<typeof PacketId.DEBUG_CONFIG, DebugConfigSchema>;
+
+export const debugConfigPacketDefinition = definePacket(
+  PacketId.DEBUG_CONFIG,
+  debugConfigSchema
+);

package/packets/inbound/StateRequest.ts

@@ -0,0 +1,11 @@
+import { definePacket, PacketId } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
+import { stateRequestSchema } from '../../schemas/StateRequest';
+import type { StateRequestSchema } from '../../schemas/StateRequest';
+
+export type StateRequestPacket = IPacket<typeof PacketId.STATE_REQUEST, StateRequestSchema>;
+
+export const stateRequestPacketDefinition = definePacket(
+  PacketId.STATE_REQUEST,
+  stateRequestSchema
+);

package/packets/inbound/index.ts

@@ -1,2 +1,3 @@
+export * from './DebugConfig';
 export * from './Heartbeat';
 export * from './Input';

package/packets/outbound/BlockTypeRegistry.ts

@@ -0,0 +1,11 @@
+import { definePacket, PacketId } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
+import { blockTypeRegistrySchema } from '../../schemas/BlockTypeRegistry';
+import type { BlockTypeRegistrySchema } from '../../schemas/BlockTypeRegistry';
+
+export type BlockTypeRegistryPacket = IPacket<typeof PacketId.BLOCK_TYPE_REGISTRY, BlockTypeRegistrySchema>;
+
+export const blockTypeRegistryPacketDefinition = definePacket(
+  PacketId.BLOCK_TYPE_REGISTRY,
+  blockTypeRegistrySchema,
+);

package/packets/outbound/index.ts

@@ -1,5 +1,5 @@
 export * from './Block';
-export * from './BlockRegistry';
+export * from './BlockTypeRegistry';
 export * from './BlockType';
 export * from './Chunk';
 export * from './Entity';

package/schemas/Block.ts

@@ -3,7 +3,7 @@ import type { JSONSchemaType } from 'ajv';
 import type { VectorSchema } from './Vector';
 
 export type BlockSchema = {
-  wi: string;       // world id
+  wi: number;       // world id
   i: number;        // block id
   c: VectorSchema;  // coordinate
 };
@@ -11,7 +11,7 @@ export type BlockSchema = {
 export const blockSchema: JSONSchemaType<BlockSchema> = {
   type: 'object',
   properties: {
-    wi: { type: 'string' },
+    wi: { type: 'number' },
     i: { type: 'number' },
     c: vectorSchema,
   },

package/schemas/BlockType.ts

@@ -3,7 +3,7 @@ import type { JSONSchemaType } from 'ajv';
 import type { ColliderDescSchema } from './ColliderDesc';
 
 export type BlockTypeSchema = {
-  wi: string;             // world id
+  wi: number;             // world id
   i: number;              // block type id
   d: boolean;             // delta
   t?: string;             // textureUri
@@ -15,7 +15,7 @@ export type BlockTypeSchema = {
 export const blockTypeSchema: JSONSchemaType<BlockTypeSchema> = {
   type: 'object',
   properties: {
-    wi: { type: 'string' },
+    wi: { type: 'number' },
     i: { type: 'number' },
     d: { type: 'boolean' },
     t: { type: 'string', nullable: true },

package/schemas/{BlockRegistry.ts → BlockTypeRegistry.ts}

@@ -2,15 +2,15 @@ import { blockTypeSchema } from './BlockType';
 import type { JSONSchemaType } from 'ajv';
 import type { BlockTypeSchema } from './BlockType';
 
-export type BlockRegistrySchema = {
-  wi: string;           // world id
+export type BlockTypeRegistrySchema = {
+  wi: number;           // world id
   b: BlockTypeSchema[]; // block types
 }
 
-export const blockRegistrySchema: JSONSchemaType<BlockRegistrySchema> = {
+export const blockTypeRegistrySchema: JSONSchemaType<BlockTypeRegistrySchema> = {
   type: 'object',
   properties: {
-    wi: { type: 'string' },
+    wi: { type: 'number' },
     b: {
       type: 'array',
       items: blockTypeSchema,

package/schemas/Chunk.ts

@@ -3,7 +3,7 @@ import type { JSONSchemaType } from 'ajv';
 import type { VectorSchema } from './Vector';
 
 export type ChunkSchema = {
-  wi: string;               // world id
+  wi: number;               // world id
   c: VectorSchema;          // chunk coordinate [ 16n, 16n, 16n ]
   b: Uint8Array | number[]; // block ids in chunk, 16^3 entries, registry block ids 1-255, 0 = none
 };
@@ -11,7 +11,7 @@ export type ChunkSchema = {
 export const chunkSchema: JSONSchemaType<ChunkSchema> = {
   type: 'object',
   properties: {
-    wi: { type: 'string' },
+    wi: { type: 'number' },
     c: vectorSchema,
     b: {
       type: 'array',

package/schemas/Collider.ts

@@ -4,12 +4,14 @@ import type { ColliderDescSchema } from './ColliderDesc';
 
 export type ColliderSchema = {
   h?: number; // collider handle for rapier
+  rm?: boolean;         // removed
 } & ColliderDescSchema;
 
 export const colliderSchema: JSONSchemaType<ColliderSchema> = {
   type: 'object',
   properties: {
     h: { type: 'number', nullable: true },
+    rm: { type: 'boolean', nullable: true },
     ...colliderDescSchema.properties
   },
   additionalProperties: false,

package/schemas/DebugConfig.ts

@@ -0,0 +1,17 @@
+import { JSONSchemaType } from 'ajv';
+
+export type DebugConfigSchema = {
+  // physics debug render enabled,
+  // setting true will cause the
+  // server to send a PhysicsDebugRender
+  // packet per tick.
+  pdr?: boolean; 
+}
+
+export const debugConfigSchema: JSONSchemaType<DebugConfigSchema> = {
+  type: 'object',
+  properties: {
+    pdr: { type: 'boolean', nullable: true },
+  },
+  additionalProperties: false,
+}

package/schemas/Entity.ts

@@ -3,10 +3,11 @@ import type { JSONSchemaType } from 'ajv';
 import type { RigidBodySchema } from './RigidBody';
 
 export type EntitySchema = {
-  wi: string;          // world id
+  wi: number;          // world id
   i: number;           // entity id
   d: boolean;          // delta
   f?: boolean;         // focused
+  rm?: boolean;        // removed
   n?: string;          // name
   m?: string;          // model uri
   t?: string;          // texture uri
@@ -16,10 +17,11 @@ export type EntitySchema = {
 export const entitySchema: JSONSchemaType<EntitySchema> = {
   type: 'object',
   properties: {
-    wi: { type: 'string' },
+    wi: { type: 'number' },
     i: { type: 'number' },
     d: { type: 'boolean' },
     f: { type: 'boolean', nullable: true },
+    rm: { type: 'boolean', nullable: true },
     n: { type: 'string', nullable: true },
     m: { type: 'string', nullable: true },
     t: { type: 'string', nullable: true },

package/schemas/PhysicsDebugRender.ts

@@ -1,7 +1,7 @@
 import { JSONSchemaType } from 'ajv';
 
 export type PhysicsDebugRenderSchema = {
-  wi: string;  // world id
+  wi: number;  // world id
   v: number[]; // rapier debug render vertices
   c: number[]; // rapier debug render colors
 }
@@ -9,7 +9,7 @@ export type PhysicsDebugRenderSchema = {
 export const physicsDebugRenderSchema: JSONSchemaType<PhysicsDebugRenderSchema> = {
   type: 'object',
   properties: {
-    wi: { type: 'string' },
+    wi: { type: 'number' },
     v: { type: 'array', items: { type: 'number' } },
     c: { type: 'array', items: { type: 'number' } },
   },

package/schemas/RigidBody.ts

@@ -4,12 +4,14 @@ import { RigidBodyDescSchema } from './RigidBodyDesc';
 
 export type RigidBodySchema = {
   h?: number; // rigid body handle for rapier
+  rm?: boolean; // removed
 } & RigidBodyDescSchema;
 
 export const rigidBodySchema: JSONSchemaType<RigidBodySchema> = {
   type: 'object',
   properties: {
     h: { type: 'number', nullable: true },
+    rm: { type: 'boolean', nullable: true },
     ...rigidBodyDescSchema.properties,
   },
   additionalProperties: false,

package/schemas/StateRequest.ts

@@ -0,0 +1,13 @@
+import { JSONSchemaType } from 'ajv';
+
+export type StateRequestSchema = {
+  
+}
+
+export const stateRequestSchema: JSONSchemaType<StateRequestSchema> = {
+  type: 'object',
+  properties: {
+    
+  },
+  additionalProperties: false,
+}

package/schemas/index.ts

@@ -1,5 +1,5 @@
 export * from './Block';
-export * from './BlockRegistry';
+export * from './BlockTypeRegistry';
 export * from './BlockType';
 export * from './Chunk';
 export * from './Collider';

package/packets/outbound/BlockRegistry.ts

@@ -1,11 +0,0 @@
-import { definePacket, PacketId } from '../PacketCore';
-import type { IPacket } from '../PacketCore';
-import { blockRegistrySchema } from '../../schemas/BlockRegistry';
-import type { BlockRegistrySchema } from '../../schemas/BlockRegistry';
-
-export type BlockRegistryPacket = IPacket<typeof PacketId.BLOCK_REGISTRY, BlockRegistrySchema>;
-
-export const blockRegistryPacketDefinition = definePacket(
-  PacketId.BLOCK_REGISTRY,
-  blockRegistrySchema,
-);