@hytopia.com/server-protocol 1.1.4 → 1.2.0

package/package.json

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

package/packets/PacketCore.ts

@@ -26,16 +26,12 @@ export enum PacketId {
 
   // Standard Outbound Packet Types: 32 - 127 range
   SYNC_RESPONSE = 32,
-  BLOCK = 33,
-  BLOCK_BATCH = 34,
-  BLOCK_TYPE = 35,
-  BLOCK_TYPE_BATCH = 36,
-  CHUNK = 37,
-  CHUNK_BATCH = 38,
-  ENTITY = 39,
-  ENTITY_BATCH = 40,
-  WORLD = 41,
-  CHAT_MESSAGE = 42,
+  BLOCKS = 33,
+  BLOCK_TYPES = 34,
+  CHAT_MESSAGES = 35,
+  CHUNKS = 36,
+  ENTITIES = 37,
+  WORLD = 38,
 
   // Debug Inbound Packet Types: 128 - 191 range
   DEBUG_CONFIG = 128,

package/packets/outbound/BlockTypes.ts

@@ -0,0 +1,12 @@
+import { definePacket, PacketId } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
+import { blockTypesSchema } from '../../schemas/BlockTypes';
+import type { BlockTypesSchema } from '../../schemas/BlockTypes';
+import type { WorldTick } from '../PacketCore';
+
+export type BlockTypesPacket = IPacket<typeof PacketId.BLOCK_TYPES, BlockTypesSchema> & [WorldTick];
+
+export const blockTypesPacketDefinition = definePacket(
+  PacketId.BLOCK_TYPES,
+  blockTypesSchema,
+);

package/packets/outbound/Blocks.ts

@@ -0,0 +1,12 @@
+import { definePacket, PacketId } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
+import { blocksSchema } from '../../schemas/Blocks';
+import type { BlocksSchema } from '../../schemas/Blocks';
+import type { WorldTick } from '../PacketCore';
+
+export type BlocksPacket = IPacket<typeof PacketId.BLOCKS, BlocksSchema> & [WorldTick];
+
+export const blocksPacketDefinition = definePacket(
+  PacketId.BLOCKS,
+  blocksSchema,
+);

package/packets/outbound/ChatMessages.ts

@@ -0,0 +1,12 @@
+import { definePacket, PacketId } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
+import { chatMessagesSchema } from '../../schemas/ChatMessages';
+import type { ChatMessagesSchema } from '../../schemas/ChatMessages';
+import type { WorldTick } from '../PacketCore';
+
+export type ChatMessagesPacket = IPacket<typeof PacketId.CHAT_MESSAGES, ChatMessagesSchema> & [WorldTick];
+
+export const chatMessagesPacketDefinition = definePacket(
+  PacketId.CHAT_MESSAGES,
+  chatMessagesSchema,
+);

package/packets/outbound/Chunks.ts

@@ -0,0 +1,12 @@
+import { definePacket, PacketId } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
+import { chunksSchema } from '../../schemas/Chunks';
+import type { ChunksSchema } from '../../schemas/Chunks';
+import type { WorldTick } from '../PacketCore';
+
+export type ChunksPacket = IPacket<typeof PacketId.CHUNKS, ChunksSchema> & [WorldTick];
+
+export const chunksPacketDefinition = definePacket(
+  PacketId.CHUNKS,
+  chunksSchema,
+);

package/packets/outbound/Entities.ts

@@ -0,0 +1,12 @@
+import { definePacket, PacketId } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
+import { entitiesSchema } from '../../schemas/Entities';
+import type { EntitiesSchema } from '../../schemas/Entities';
+import type { WorldTick } from '../PacketCore';
+
+export type EntitiesPacket = IPacket<typeof PacketId.ENTITIES, EntitiesSchema> & [WorldTick];
+
+export const entitiesPacketDefinition = definePacket(
+  PacketId.ENTITIES,
+  entitiesSchema,
+);

package/packets/outbound/index.ts

@@ -1,12 +1,8 @@
-export * from './Block';
-export * from './BlockBatch';
-export * from './BlockType';
-export * from './BlockTypeBatch';
-export * from './ChatMessage';
-export * from './Chunk';
-export * from './ChunkBatch';
-export * from './Entity';
-export * from './EntityBatch';
+export * from './Blocks';
+export * from './BlockTypes';
+export * from './ChatMessages';
+export * from './Chunks';
+export * from './Entities';
 export * from './PhysicsDebugRender';
 export * from './SyncResponse';
 export * from './World';

package/schemas/Block.ts

@@ -4,7 +4,7 @@ import type { VectorSchema } from './Vector';
 
 export type BlockSchema = {
   i: number;        // block id
-  c: VectorSchema;  // coordinate
+  c: VectorSchema;  // block global coordinate
 };
 
 export const blockSchema: JSONSchemaType<BlockSchema> = {

package/schemas/{BlockTypeBatch.ts → BlockTypes.ts}

@@ -2,9 +2,9 @@ import { blockTypeSchema } from './BlockType';
 import type { JSONSchemaType } from 'ajv';
 import type { BlockTypeSchema } from './BlockType';
 
-export type BlockTypeBatchSchema = BlockTypeSchema[];
+export type BlockTypesSchema = BlockTypeSchema[];
 
-export const blockTypeBatchSchema: JSONSchemaType<BlockTypeBatchSchema> = {
+export const blockTypesSchema: JSONSchemaType<BlockTypesSchema> = {
   type: 'array',
   items: { ...blockTypeSchema },
 }

package/schemas/{BlockBatch.ts → Blocks.ts}

@@ -2,9 +2,9 @@ import { blockSchema } from './Block';
 import type { JSONSchemaType } from 'ajv';
 import type { BlockSchema } from './Block';
 
-export type BlockBatchSchema = BlockSchema[];
+export type BlocksSchema = BlockSchema[];
 
-export const blockBatchSchema: JSONSchemaType<BlockBatchSchema> = {
+export const blocksSchema: JSONSchemaType<BlocksSchema> = {
   type: 'array',
   items: { ...blockSchema },
 }

package/schemas/ChatMessages.ts

@@ -0,0 +1,10 @@
+import { chatMessageSchema } from './ChatMessage';
+import type { JSONSchemaType } from 'ajv';
+import type { ChatMessageSchema } from './ChatMessage';
+
+export type ChatMessagesSchema = ChatMessageSchema[];
+
+export const chatMessagesSchema: JSONSchemaType<ChatMessagesSchema> = {
+  type: 'array',
+  items: { ...chatMessageSchema },
+}

package/schemas/Chunk.ts

@@ -3,8 +3,9 @@ import type { JSONSchemaType } from 'ajv';
 import type { VectorSchema } from './Vector';
 
 export type ChunkSchema = {
-  c: VectorSchema;          // chunk coordinate [ 16n, 16n, 16n ]
-  b: Uint8Array | number[]; // block ids in chunk, 16^3 entries, registry block ids 1-255, 0 = none
+  c: VectorSchema;           // chunk origin coordinate [ 16n, 16n, 16n ]
+  b?: Uint8Array | number[]; // block ids in chunk, 16^3 entries, registry block ids 1-255, 0 = none
+  rm?: boolean;              // removed/remove
 };
 
 export const chunkSchema: JSONSchemaType<ChunkSchema> = {
@@ -19,9 +20,11 @@ export const chunkSchema: JSONSchemaType<ChunkSchema> = {
         maximum: 255
       },
       minItems: 4096,
-      maxItems: 4096
-    }
+      maxItems: 4096,
+      nullable: true,
+    },
+    rm: { type: 'boolean', nullable: true },
   },
-  required: [ 'c', 'b' ],
+  required: [ 'c' ],
   additionalProperties: false,
 }

package/schemas/{ChunkBatch.ts → Chunks.ts}

@@ -2,9 +2,9 @@ import { chunkSchema } from './Chunk';
 import type { JSONSchemaType } from 'ajv';
 import type { ChunkSchema } from './Chunk';
 
-export type ChunkBatchSchema = ChunkSchema[];
+export type ChunksSchema = ChunkSchema[];
 
-export const chunkBatchSchema: JSONSchemaType<ChunkBatchSchema> = {
+export const chunksSchema: JSONSchemaType<ChunksSchema> = {
   type: 'array',
   items: { ...chunkSchema },
 }

package/schemas/{EntityBatch.ts → Entities.ts}

@@ -2,9 +2,9 @@ import { entitySchema } from './Entity';
 import type { JSONSchemaType } from 'ajv';
 import type { EntitySchema } from './Entity';
 
-export type EntityBatchSchema = EntitySchema[];
+export type EntitiesSchema = EntitySchema[];
 
-export const entityBatchSchema: JSONSchemaType<EntityBatchSchema> = {
+export const entitiesSchema: JSONSchemaType<EntitiesSchema> = {
   type: 'array',
   items: { ...entitySchema },
 }

package/schemas/Entity.ts

@@ -4,20 +4,18 @@ import type { JSONSchemaType } from 'ajv';
 import type { QuaternionSchema } from './Quaternion';
 import type { VectorSchema } from './Vector';
 
-
 export type EntitySchema = {
   i: number;            // entity id
-  al?: string[];        // animations looped
-  ao?: string[];        // animations one shot
-  as?: string[];        // animations stop
-  b?: VectorSchema;     // model visual bounding box half extents
+  al?: string[];        // model animations looped
+  ao?: string[];        // model animations one shot
+  as?: string[];        // model animations stop
   f?: boolean;          // focused
   m?: string;           // model uri
   n?: string;           // name
   p?: VectorSchema;     // position
   r?: QuaternionSchema; // rotation
   rm?: boolean;         // removed/remove
-  s?: VectorSchema;     // model scale relative to visual bounding box
+  s?: number;           // model scale
 }
 
 export const entitySchema: JSONSchemaType<EntitySchema> = {
@@ -27,14 +25,13 @@ export const entitySchema: JSONSchemaType<EntitySchema> = {
     al: { type: 'array', items: { type: 'string' }, nullable: true },
     ao: { type: 'array', items: { type: 'string' }, nullable: true },
     as: { type: 'array', items: { type: 'string' }, nullable: true },
-    b: { ...vectorSchema, nullable: true },
     f: { type: 'boolean', nullable: true },
     m: { type: 'string', nullable: true },
     n: { type: 'string', nullable: true },
     p: { ...vectorSchema, nullable: true },
     r: { ...quaternionSchema, nullable: true },
     rm: { type: 'boolean', nullable: true },
-    s: { ...vectorSchema, nullable: true },
+    s: { type: 'number', nullable: true },
   },
   required: [ 'i' ],
   additionalProperties: false,

package/schemas/index.ts

@@ -1,13 +1,14 @@
 export * from './Block';
-export * from './BlockBatch';
+export * from './Blocks';
 export * from './BlockType';
-export * from './BlockTypeBatch';
+export * from './BlockTypes';
 export * from './ChatMessage';
+export * from './ChatMessages';
 export * from './Chunk';
-export * from './ChunkBatch';
+export * from './Chunks';
 export * from './DebugConfig';
 export * from './Entity';
-export * from './EntityBatch';
+export * from './Entities';
 export * from './HexColor';
 export * from './Input';
 export * from './PhysicsDebugRender';

package/packets/outbound/Block.ts

@@ -1,12 +0,0 @@
-import { definePacket, PacketId } from '../PacketCore';
-import type { IPacket } from '../PacketCore';
-import { blockSchema } from '../../schemas/Block';
-import type { BlockSchema } from '../../schemas/Block';
-import type { WorldTick } from '../PacketCore';
-
-export type BlockPacket = IPacket<typeof PacketId.BLOCK, BlockSchema> & [WorldTick];
-
-export const blockPacketDefinition = definePacket(
-  PacketId.BLOCK,
-  blockSchema,
-);

package/packets/outbound/BlockBatch.ts

@@ -1,12 +0,0 @@
-import { definePacket, PacketId } from '../PacketCore';
-import type { IPacket } from '../PacketCore';
-import { blockBatchSchema } from '../../schemas/BlockBatch';
-import type { BlockBatchSchema } from '../../schemas/BlockBatch';
-import type { WorldTick } from '../PacketCore';
-
-export type BlockBatchPacket = IPacket<typeof PacketId.BLOCK_BATCH, BlockBatchSchema> & [WorldTick];
-
-export const blockBatchPacketDefinition = definePacket(
-  PacketId.BLOCK_BATCH,
-  blockBatchSchema,
-);

package/packets/outbound/BlockType.ts

@@ -1,12 +0,0 @@
-import { definePacket, PacketId } from '../PacketCore';
-import type { IPacket } from '../PacketCore';
-import { blockTypeSchema } from '../../schemas/BlockType';
-import type { BlockTypeSchema } from '../../schemas/BlockType';
-import type { WorldTick } from '../PacketCore';
-
-export type BlockTypePacket = IPacket<typeof PacketId.BLOCK_TYPE, BlockTypeSchema> & [WorldTick];
-
-export const blockTypePacketDefinition = definePacket(
-  PacketId.BLOCK_TYPE,
-  blockTypeSchema,
-);

package/packets/outbound/BlockTypeBatch.ts

@@ -1,12 +0,0 @@
-import { definePacket, PacketId } from '../PacketCore';
-import type { IPacket } from '../PacketCore';
-import { blockTypeBatchSchema } from '../../schemas/BlockTypeBatch';
-import type { BlockTypeBatchSchema } from '../../schemas/BlockTypeBatch';
-import type { WorldTick } from '../PacketCore';
-
-export type BlockTypeBatchPacket = IPacket<typeof PacketId.BLOCK_TYPE_BATCH, BlockTypeBatchSchema> & [WorldTick];
-
-export const blockTypeBatchPacketDefinition = definePacket(
-  PacketId.BLOCK_TYPE_BATCH,
-  blockTypeBatchSchema,
-);

package/packets/outbound/ChatMessage.ts

@@ -1,12 +0,0 @@
-import { definePacket, PacketId } from '../PacketCore';
-import type { IPacket } from '../PacketCore';
-import { chatMessageSchema } from '../../schemas/ChatMessage';
-import type { ChatMessageSchema } from '../../schemas/ChatMessage';
-import type { WorldTick } from '../PacketCore';
-
-export type ChatMessagePacket = IPacket<typeof PacketId.CHAT_MESSAGE, ChatMessageSchema> & [WorldTick];
-
-export const chatMessagePacketDefinition = definePacket(
-  PacketId.CHAT_MESSAGE,
-  chatMessageSchema,
-);

package/packets/outbound/Chunk.ts

@@ -1,12 +0,0 @@
-import { definePacket, PacketId } from '../PacketCore';
-import type { IPacket } from '../PacketCore';
-import { chunkSchema } from '../../schemas/Chunk';
-import type { ChunkSchema } from '../../schemas/Chunk';
-import type { WorldTick } from '../PacketCore';
-
-export type ChunkPacket = IPacket<typeof PacketId.CHUNK, ChunkSchema> & [WorldTick];
-
-export const chunkPacketDefinition = definePacket(
-  PacketId.CHUNK,
-  chunkSchema,
-);

package/packets/outbound/ChunkBatch.ts

@@ -1,12 +0,0 @@
-import { definePacket, PacketId } from '../PacketCore';
-import type { IPacket } from '../PacketCore';
-import { chunkBatchSchema } from '../../schemas/ChunkBatch';
-import type { ChunkBatchSchema } from '../../schemas/ChunkBatch';
-import type { WorldTick } from '../PacketCore';
-
-export type ChunkBatchPacket = IPacket<typeof PacketId.CHUNK_BATCH, ChunkBatchSchema> & [WorldTick];
-
-export const chunkBatchPacketDefinition = definePacket(
-  PacketId.CHUNK_BATCH,
-  chunkBatchSchema,
-);

package/packets/outbound/Entity.ts

@@ -1,12 +0,0 @@
-import { definePacket, PacketId } from '../PacketCore';
-import type { IPacket } from '../PacketCore';
-import { entitySchema } from '../../schemas/Entity';
-import type { EntitySchema } from '../../schemas/Entity';
-import type { WorldTick } from '../PacketCore';
-
-export type EntityPacket = IPacket<typeof PacketId.ENTITY, EntitySchema> & [WorldTick];
-
-export const entityPacketDefinition = definePacket(
-  PacketId.ENTITY,
-  entitySchema,
-);

package/packets/outbound/EntityBatch.ts

@@ -1,12 +0,0 @@
-import { definePacket, PacketId } from '../PacketCore';
-import type { IPacket } from '../PacketCore';
-import { entityBatchSchema } from '../../schemas/EntityBatch';
-import type { EntityBatchSchema } from '../../schemas/EntityBatch';
-import type { WorldTick } from '../PacketCore';
-
-export type EntityBatchPacket = IPacket<typeof PacketId.ENTITY_BATCH, EntityBatchSchema> & [WorldTick];
-
-export const entityBatchPacketDefinition = definePacket(
-  PacketId.ENTITY_BATCH,
-  entityBatchSchema,
-);