@vaitosoi/minejs 0.2.2 → 0.3.1

package/dist/world/state.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SharedState = exports.ConnectionState = exports.ClientStatus = exports.GameMode = void 0;
+const error_1 = require("../base/error");
+var GameMode;
+(function (GameMode) {
+    GameMode[GameMode["Survival"] = 0] = "Survival";
+    GameMode[GameMode["Creative"] = 1] = "Creative";
+    GameMode[GameMode["Adventure"] = 2] = "Adventure";
+    GameMode[GameMode["Spectator"] = 3] = "Spectator";
+})(GameMode || (exports.GameMode = GameMode = {}));
+var ClientStatus;
+(function (ClientStatus) {
+    ClientStatus[ClientStatus["Disconnected"] = 0] = "Disconnected";
+    ClientStatus[ClientStatus["Connecting"] = 1] = "Connecting";
+    ClientStatus[ClientStatus["Logining"] = 2] = "Logining";
+    ClientStatus[ClientStatus["Ready"] = 3] = "Ready";
+})(ClientStatus || (exports.ClientStatus = ClientStatus = {}));
+var ConnectionState;
+(function (ConnectionState) {
+    ConnectionState[ConnectionState["Disconnected"] = 0] = "Disconnected";
+    ConnectionState[ConnectionState["Handshake"] = 1] = "Handshake";
+    ConnectionState[ConnectionState["Login"] = 2] = "Login";
+    ConnectionState[ConnectionState["Configure"] = 3] = "Configure";
+    ConnectionState[ConnectionState["Play"] = 4] = "Play";
+})(ConnectionState || (exports.ConnectionState = ConnectionState = {}));
+class SharedState {
+    clientOptions;
+    getUuid;
+    mutationQueue = [];
+    eventQueue = [];
+    sendQueue = [];
+    state = ConnectionState.Disconnected;
+    status = ClientStatus.Disconnected;
+    compressionThreshold = 0;
+    sharedSecret = undefined;
+    cipher = undefined;
+    decipher = undefined;
+    server = undefined;
+    registry = undefined;
+    world = null;
+    player = null;
+    constructor(clientOptions, getUuid) {
+        this.clientOptions = clientOptions;
+        this.getUuid = getUuid;
+    }
+    isReady() {
+        return this.status === ClientStatus.Ready;
+    }
+    checkReady() {
+        if (!this.isReady())
+            throw new error_1.ClientNotReady();
+    }
+    pruneStates() {
+        this.mutationQueue = [];
+        this.eventQueue = [];
+        this.sendQueue = [];
+        this.state = ConnectionState.Disconnected;
+        this.compressionThreshold = 0;
+        this.sharedSecret = undefined;
+        this.cipher = undefined;
+        this.decipher = undefined;
+        this.server = undefined;
+        this.registry = undefined;
+        this.world = undefined;
+        this.player = undefined;
+    }
+    enqueueMutation(mutation) { this.mutationQueue.push(mutation); }
+    enqueuePacket(packet, data) {
+        if (typeof packet === "string")
+            this.sendQueue.push({
+                id: packet,
+                data: data
+            });
+        else
+            this.sendQueue.push(packet);
+    }
+    enqueueEvent(event, ...args) {
+        if (typeof event === "string")
+            this.eventQueue.push({
+                event,
+                args: args
+            });
+        else
+            this.eventQueue.push(event);
+    }
+    drainMutation() {
+        while (true) {
+            const mutation = this.mutationQueue.shift();
+            if (mutation)
+                mutation(this);
+            else
+                break;
+        }
+    }
+    drainEvent() {
+        const events = structuredClone(this.eventQueue);
+        this.eventQueue = [];
+        return events;
+    }
+    drainPacket() {
+        const packets = structuredClone(this.sendQueue);
+        this.sendQueue = [];
+        return packets;
+    }
+}
+exports.SharedState = SharedState;
+//# sourceMappingURL=state.js.map

package/dist/world/state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.js","sourceRoot":"","sources":["../../src/world/state.ts"],"names":[],"mappings":";;;AAGA,yCAA+C;AAkF/C,IAAY,QAKX;AALD,WAAY,QAAQ;IAChB,+CAAY,CAAA;IACZ,+CAAY,CAAA;IACZ,iDAAa,CAAA;IACb,iDAAa,CAAA;AACjB,CAAC,EALW,QAAQ,aAAR,QAAQ,GAAR,QAAQ,QAKnB;AAoBD,IAAY,YAKX;AALD,WAAY,YAAY;IACpB,+DAAY,CAAA;IACZ,2DAAU,CAAA;IACV,uDAAQ,CAAA;IACR,iDAAK,CAAA;AACT,CAAC,EALW,YAAY,aAAZ,YAAY,GAAZ,YAAY,QAKvB;AAED,IAAY,eAMX;AAND,WAAY,eAAe;IACvB,qEAAY,CAAA;IACZ,+DAAS,CAAA;IACT,uDAAK,CAAA;IACL,+DAAS,CAAA;IACT,qDAAI,CAAA;AACR,CAAC,EANW,eAAe,aAAf,eAAe,GAAf,eAAe,QAM1B;AAgBD;IAmBe,aAAa;IACb,OAAO;IAnBV,aAAa,GAAkB,EAAE,CAAC;IAClC,UAAU,GAAmB,EAAE,CAAC;IAChC,SAAS,GAAoB,EAAE,CAAC;IAEjC,KAAK,GAAoB,eAAe,CAAC,YAAY,CAAC;IACtD,MAAM,GAAiB,YAAY,CAAC,YAAY,CAAC;IACjD,oBAAoB,GAAW,CAAC,CAAC;IAEjC,YAAY,GAAuB,SAAS,CAAC;IAC7C,MAAM,GAAyB,SAAS,CAAC;IACzC,QAAQ,GAA2B,SAAS,CAAC;IAE7C,MAAM,GAAuB,SAAS,CAAC;IACvC,QAAQ,GAAsD,SAAS,CAAC;IACxE,KAAK,GAA6B,IAAW,CAAC;IAC9C,MAAM,GAA8B,IAAW,CAAC;IAEvD,YACW,aAA2B,EAC3B,OAAqB;6BADrB,aAAa;uBACb,OAAO;IACd,CAAC;IAEE,OAAO;QACV,OAAO,IAAI,CAAC,MAAM,KAAK,YAAY,CAAC,KAAK,CAAC;IAC9C,CAAC;IAEM,UAAU;QACb,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACf,MAAM,IAAI,sBAAc,EAAE,CAAC;IACnC,CAAC;IAEM,WAAW;QACd,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,eAAe,CAAC,YAAY,CAAC;QAC1C,IAAI,CAAC,oBAAoB,GAAG,CAAC,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,KAAK,GAAG,SAAgB,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,SAAgB,CAAC;IACnC,CAAC;IAEM,eAAe,CAAC,QAAqB,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAI7E,aAAa,CAAC,MAA8B,EAAE,IAAa;QAC9D,IAAI,OAAO,MAAM,KAAK,QAAQ;YAC1B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,EAAE,EAAE,MAAM;gBACV,IAAI,EAAE,IAAK;aACd,CAAC,CAAC;;YAEH,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IAIM,YAAY,CAAC,KAAmB,EAAE,GAAG,IAAW;QACnD,IAAI,OAAO,KAAK,KAAK,QAAQ;YACzB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;gBACjB,KAAK;gBACL,IAAI,EAAE,IAAW;aACpB,CAAC,CAAC;;YAEH,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAEM,aAAa;QAChB,OAAO,IAAI,EAAE,CAAC;YACV,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;YAC5C,IAAI,QAAQ;gBACR,QAAQ,CAAC,IAAI,CAAC,CAAC;;gBAEf,MAAM;QACd,CAAC;IACL,CAAC;IACM,UAAU;QACb,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,OAAO,MAAM,CAAC;IAClB,CAAC;IACM,WAAW;QACd,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAChD,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ"}

package/dist/world/tick.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tick.d.ts","sourceRoot":"","sources":["../../src/world/tick.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,qBAAa,QAAQ;IAUb,OAAO,CAAC,MAAM;IATlB,gBAAuB,OAAO,MAAM;IACpC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAqC;IACpE,gBAAuB,iBAAiB,MAAM;IAE9C,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,KAAK,CAAa;IAE1B,YACY,MAAM,EAAE,MAAM,GAAG,EAI5B;IAEM,KAAK,SAIX;IAEM,IAAI,SAIV;IAED,OAAO,CAAC,IAAI;CAiBf"}

package/dist/world/tick.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tick.js","sourceRoot":"","sources":["../../src/world/tick.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH;IAUgB,MAAM;IATX,MAAM,CAAU,OAAO,GAAG,EAAE,CAAC;IAC5B,MAAM,CAAU,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,QAAU,CAAC;IAC7D,MAAM,CAAU,iBAAiB,GAAG,EAAE,CAAC;IAEtC,OAAO,CAAU;IACjB,YAAY,CAAS;IACrB,KAAK,GAAQ,IAAI,CAAC;IAE1B,YACY,MAAiB;sBAAjB,MAAM;QAEd,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IAEM,KAAK;QACR,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QAC5C,IAAI,CAAC,IAAI,EAAE,CAAC;IAChB,CAAC;IAEM,IAAI;QACP,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IAEO,IAAI;QACR,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,IAAI,CAAC,IAAI,EAAE,CAAC;QAE/B,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACpC,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,OAAO,IAAI,CAAC,YAAY,GAAG,GAAG,IAAI,QAAQ,GAAG,QAAQ,CAAC,iBAAiB,EAAE,CAAC;YACtE,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,IAAI,CAAC,YAAY,IAAI,QAAQ,CAAC,OAAO,CAAC;YACtC,QAAQ,EAAE,CAAC;QACf,CAAC;QAED,IAAI,QAAQ,IAAI,QAAQ,CAAC,iBAAiB;YACtC,IAAI,CAAC,YAAY,GAAG,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC;QAE/C,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;QAClF,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IACrE,CAAC;CACJ"}

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@vaitosoi/minejs",
-  "version": "0.2.2",
+  "version": "0.3.1",
   "description": "A Minecraft client package",
   "license": "MIT",
   "repository": {
     "url": "git+https://github.com/VaitoSoi/minejs"
   },
+  "homepage": "https://minejs.vaito.dev/",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -23,6 +24,9 @@
   "engines": {
     "node": ">=22"
   },
+  "scripts": {
+    "prepare": "eslint . --fix && tsc --noEmit"
+  },
   "devDependencies": {
     "@clean-jsdoc-theme/typedoc": "5.0.5",
     "@eslint/js": "^10.0.1",
@@ -38,7 +42,8 @@
     "typescript-eslint": "^8.60.1"
   },
   "dependencies": {
-    "bitset": "^5.2.3"
+    "bitset": "^5.2.3",
+    "zod": "^4.4.3"
   },
   "packageManager": "pnpm@11.15.1+sha512.81350b07e53c9538a02f1f2303b4290fa2d7be04e56e2a970c4cc4b417dc761de196edabd49d55c7dc9580db81007c44143e4e3d7e462b3000d23c255122d065"
 }

package/src/base/error.ts

@@ -115,4 +115,40 @@ export class ClientNotReady extends Error {
     constructor() {
         super(`client is not ready`);
     }
+}
+
+/** @hidden */
+export class VersionNotSupport extends Error {
+    constructor(public version: string) {
+        super(`version ${version} is not supported`);
+    }
+}
+
+/** @hidden */
+export class CantReadFile extends Error {
+    constructor(public path: string) {
+        super(`can't read file at "${path}"`);
+    }
+}
+
+/** @hidden */
+export class InvalidPacketStructure extends Error {
+    constructor(public path: string, public zodIssue?: any[]) {
+        super(`packet structure in file "${path}" is invalid` + (zodIssue?.length ? ", zod issue: " + JSON.stringify(zodIssue, null, 4) : ""));
+    }
+}
+
+
+/** @hidden */
+export class MissingPacketField extends Error {
+    constructor(public packetId: number, public field: string, public need: string) {
+        super(`${packetId}: ${field} need ${need}, but not found`);
+    }
+}
+
+/** @hidden */
+export class MissingField extends Error {
+    constructor(public field: string, public where: string) {
+        super(`missing ${field} in ${where}`);
+    }
 }

package/src/base/typing.ts

@@ -1,2 +1,10 @@
 /** @hidden */
-export type If<Condition extends boolean, True, False = null> = Condition extends true ? True : False;
+export type If<Condition extends boolean, True, False = null> = Condition extends true ? True : Condition extends false ? False : True | False;
+
+
+/**
+ * Representing a TextComponent
+ * 
+ * @see https://minecraft.wiki/w/Text_component_format
+ */
+export type TextComponent = Record<string, any>;

package/src/client/client.ts

@@ -1,15 +1,26 @@
 import { EventEmitter } from "node:stream";
-import { BlockManager, BlockState } from "../base/block";
-import { EntitiesManager } from "../base/entity";
-import { MoveDirection, Player } from "../base/player";
-import { TickLoop } from "../base/tick";
-import { Entity, Message, TCPClient, TCPClientEvents, TCPClientOption, TextComponent } from "./tcp";
-import { TypedEmmiter } from "../base/event";
-import { BlockRegistry, EntityRegistry } from "../base/registry";
-import { BaseVec3, Vec3 } from "../base/direction";
+import { BlockManager, BlockState } from "../world/block";
+import { EntitiesManager } from "../world/entity";
+import { MoveDirection, Player } from "../physics/player";
+import { TickLoop } from "../world/tick";
+import { Message, TCPClient, TCPClientOption } from "./tcp";
+import { TypedEmmiter as TypedEmitter } from "../base/event";
+import { BlockRegistry, EntityRegistry, PacketRegistry, ProtocolVersionMapping } from "../version/registry";
+import { BaseVec3, Vec3 } from "../physics/direction";
+import { TextComponent } from "../base/typing";
+import { EmittedEvent as EmittedEvent, Entity, SharedState } from "../world/state";
+import { Dispatcher } from "../packet/dispatcher";
+import { VersionCodec } from "../version/codec";
+import { AuthClient } from "./auth";
+import { computeUUID } from "../base/math";
+
+export type ClientOption = Omit<TCPClientOption, "protocolVersion"> & { version: string }
 
 export interface ClientEvents {
-    ready: [readyClient: Client<true>],
+    connect: [],
+    destroy: [],
+
+    ready: [],
     disconnect: [reason: string],
     disconnectRaw: [textComponent: TextComponent],
 
@@ -19,7 +30,7 @@ export interface ClientEvents {
     unloadChunk: [chunkX: number, chunkZ: number],
 
     spawnEntity: [entity: Entity],
-    updateEntity: [entity: Entity],
+    updateEntity: [entityId: number],
     removeEntity: [entityId: number],
 
     // Chat
@@ -33,60 +44,106 @@ export interface ClientEvents {
 /**
  * High-level client.
  */
-export class Client<IsTCPReady extends boolean = boolean> extends (EventEmitter as new () => TypedEmmiter<ClientEvents>) {
+export class Client<IsReady extends boolean = boolean> extends (EventEmitter as new () => TypedEmitter<ClientEvents>) {
+    private static loadRegistry: boolean = false;
+
     private tickLoop: TickLoop;
 
-    private tcp: TCPClient<IsTCPReady>;
     private blocks: BlockManager;
     private entities: EntitiesManager;
     private player: Player;
+    private uuid: Buffer = Buffer.alloc(0);
+
+    private tcp: TCPClient;
+    private state: SharedState<IsReady>;
 
-    constructor(options: TCPClientOption) {
+    constructor(private options: ClientOption) {
         super();
-        BlockRegistry.load();
-        EntityRegistry.load();
-
-        this.tcp = new TCPClient(options);
-        this.blocks = new BlockManager(this.tcp);
-        this.entities = new EntitiesManager(this.tcp);
-        this.player = new Player(this.entities, this.blocks, this.tcp);
-        this.tickLoop = new TickLoop(() => this.player.tick());
-        this.forwardEvents();
+
+        // For managing shared data
+        this.state = new SharedState(options, () => this.uuid);
+        // For handling packet
+        const dispatcher = new Dispatcher(this.state, this.emit.bind(this));
+        // For reading packet
+        const versionCodec = new VersionCodec(this.state);
+        // For throwing packet through internet
+        this.tcp = new TCPClient(
+            this.state,
+            {
+                ...options,
+                protocolVersion: ProtocolVersionMapping[options.version]!
+            }
+        );
+
+        this.tcp.forwardPacket = versionCodec.handlePacket.bind(versionCodec);
+        this.tcp.parsePacket = versionCodec.encodePacket.bind(versionCodec);
+        this.tcp.sendInitPacket = () => {
+            dispatcher.sendHandshake();
+            dispatcher.sendLoginStart();
+        };
+        dispatcher.sendPacket = this.tcp.sendPacket.bind(this.tcp);
+        dispatcher.tcpDisconnect = this.tcp.disconnect.bind(this.tcp);
+        versionCodec.consumePacket = dispatcher.handlePacket.bind(dispatcher);
+
+        // For querying data
+        this.blocks = new BlockManager(this.state);
+        this.entities = new EntitiesManager(this.state);
+        // For physics things
+        this.player = new Player(
+            this.state,
+            this.on,
+            this.entities,
+            this.blocks,
+        );
+
+        // For tick-tock tick-tock
+        this.tickLoop = new TickLoop(() => {
+            this.state.drainMutation();
+            this.state.drainEvent()
+                .forEach(event => this.emitEvent(event));
+            this.state.drainPacket()
+                .forEach((packet) => this.tcp.sendPacket(packet.id, packet.data));
+            this.player.tick();
+        });
     }
 
-    private forwardEvent(eventName: keyof ClientEvents & keyof TCPClientEvents) {
-        this.tcp.on(eventName, (...args) => this.emit(eventName, ...args));
+    private emitEvent(event: EmittedEvent) {
+        this.emit(event.event, ...event.args);
     }
-    private forwardEvents() {
-        this.forwardEvent("disconnect");
-        this.forwardEvent("disconnectRaw");
-        this.forwardEvent("loadChunk");
-        this.forwardEvent("unloadChunk");
-        this.forwardEvent("playerPosition");
-        this.forwardEvent("spawnEntity");
-        this.forwardEvent("updateEntity");
-        this.forwardEvent("removeEntity");
-        this.forwardEvent("message");
-        this.forwardEvent("systemMessage");
-        this.forwardEvent("systemMessageRaw");
-        this.forwardEvent("actionBar");
-        this.forwardEvent("actionBarRaw");
+
+    private async loadRegistries() {
+        if (Client.loadRegistry) return;
+        Client.loadRegistry = true;
+        await BlockRegistry.load(this.options.version);
+        await EntityRegistry.load(this.options.version);
+        await PacketRegistry.load(this.options.version);
     }
 
     // Start / stop
+
     /**
      * Create a connection to the server
      */
-    public connect() {
+    public async connect() {
+        await this.loadRegistries();
+
+        if (!this.uuid.length) {
+            if (this.options.auth) {
+                const authClient = new AuthClient(this.options.auth);
+                const { uuid } = await authClient.auth();
+                this.uuid = Buffer.from(uuid);
+            } else
+                this.uuid = computeUUID(this.options.playerName);
+        }
+
         this.tcp.connect();
 
-        this.tcp.once("ready", () => {
-            this.emit("ready", this as Client<true>);
+        this.once("ready", () => {
             this.player.pruneInitialVal();
             this.player.setInitialVal();
             this.tickLoop.start();
         });
-        this.tcp.once("disconnect", () => {
+        this.once("disconnect", () => {
             this.tickLoop.stop();
             this.player.pruneInitialVal();
         });