@hytopia.com/server-protocol 1.2.4 → 1.2.6

package/package.json

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

package/packets/PacketCore.ts

@@ -26,12 +26,13 @@ export enum PacketId {
 
   // Standard Outbound Packet Types: 32 - 127 range
   SYNC_RESPONSE = 32,
-  BLOCKS = 33,
-  BLOCK_TYPES = 34,
-  CHAT_MESSAGES = 35,
-  CHUNKS = 36,
-  ENTITIES = 37,
-  WORLD = 38,
+  AUDIOS = 33,
+  BLOCKS = 34,
+  BLOCK_TYPES = 35,
+  CHAT_MESSAGES = 36,
+  CHUNKS = 37,
+  ENTITIES = 38,
+  WORLD = 39,
 
   // Debug Inbound Packet Types: 128 - 191 range
   DEBUG_CONFIG = 128,

package/packets/outbound/Audios.ts

@@ -0,0 +1,12 @@
+import { definePacket, PacketId } from '../PacketCore';
+import type { IPacket } from '../PacketCore';
+import { audiosSchema } from '../../schemas/Audios';
+import type { AudiosSchema } from '../../schemas/Audios';
+import type { WorldTick } from '../PacketCore';
+
+export type AudiosPacket = IPacket<typeof PacketId.AUDIOS, AudiosSchema> & [WorldTick];
+
+export const audiosPacketDefinition = definePacket(
+  PacketId.AUDIOS,
+  audiosSchema,
+);

package/packets/outbound/index.ts

@@ -1,3 +1,4 @@
+export * from './Audios';
 export * from './Blocks';
 export * from './BlockTypes';
 export * from './ChatMessages';

package/schemas/Audio.ts

@@ -0,0 +1,37 @@
+import { vectorSchema } from './Vector';
+import type { JSONSchemaType } from 'ajv';
+import type { VectorSchema } from './Vector';
+
+export type AudioSchema = {
+  a?: string;       // audio uri
+  c?: VectorSchema; // coordinate of spatial audio origin
+  d?: number;       // duration
+  de?: number;      // detune
+  g?: number;       // gain (0 to 1, or 1+ for distortion)
+  l?: boolean;      // loop
+  o?: boolean;      // one shot
+  of?: number;      // offset
+  p?: number;       // playback rate (0+)
+  r?: boolean;      // restart
+  s?: boolean;      // stop
+  v?: number;       // volume (0 to 1)
+}
+
+export const audioSchema: JSONSchemaType<AudioSchema> = {
+  type: 'object',
+  properties: {
+    a: { type: 'string', nullable: true },
+    c: { ...vectorSchema, nullable: true },
+    d: { type: 'number', nullable: true },
+    de: { type: 'number', nullable: true },
+    g: { type: 'number', minimum: 0, nullable: true },
+    l: { type: 'boolean', nullable: true },
+    o: { type: 'boolean', nullable: true },
+    of: { type: 'number', nullable: true },
+    p: { type: 'number', minimum: 0, nullable: true },
+    r: { type: 'boolean', nullable: true },
+    s: { type: 'boolean', nullable: true },
+    v: { type: 'number', minimum: 0, maximum: 1, nullable: true },
+  },
+  additionalProperties: false,
+}

package/schemas/Audios.ts

@@ -0,0 +1,10 @@
+import { audioSchema } from './Audio';
+import type { JSONSchemaType } from 'ajv';
+import type { AudioSchema } from './Audio';
+
+export type AudiosSchema = AudioSchema[];
+
+export const audiosSchema: JSONSchemaType<AudiosSchema> = {
+  type: 'array',
+  items: { ...audioSchema },
+}

package/schemas/index.ts

@@ -1,3 +1,5 @@
+export * from './Audio';
+export * from './Audios';
 export * from './Block';
 export * from './Blocks';
 export * from './BlockType';