@vaitosoi/minejs 0.5.1 → 0.6.1

package/src/world/container.ts

@@ -0,0 +1,180 @@
+import { TextComponent } from "../base/typing";
+
+/**
+ * Represent the data of a slot
+ * 
+ * @see https://minecraft.wiki/w/Java_Edition_protocol/Slot_data#Format
+ */
+export interface Slot {
+    counts: number,
+    itemId: number | undefined,
+    addComponents: Record<string, any> | undefined,
+    removeComponents: number[] | undefined
+}
+
+/**
+ * Represent a container (such as inventory, chest, anvil, ...)
+ */
+export class Container {
+    /**
+     * State ID
+     * 
+     * You SHOULD NOT edit this field since this field is for syncing state from client and server
+     */
+    public stateId: number = 0;
+    /**
+     * Slots data
+     * 
+     * @see https://minecraft.wiki/w/Java_Edition_protocol/Inventory For more info how how slot are organized
+     */
+    public slots: Slot[] = [];
+    /**
+     * Data from Set Container Property packet
+     * 
+     * @see https://minecraft.wiki/w/Java_Edition_protocol/Packets#Set_Container_Property
+     * 
+     * | Field                                    | Meaning |
+     * |------------------------------------------|---------|
+     * | # **Furnace / Blast furnace / Smoker**   | ------- |
+     * | fuel_left                                | counting from fuel burn time down to 0 |
+     * | max_burn_time                            | fuel burn time or 0 (in-game ticks) |
+     * | progress_arrow                           | counting from 0 to maximum progress (in-game ticks) |
+     * | max_progress                             | always 200 on the vanilla server |
+     * | # **Enchantment table**                  | ------- |
+     * | level_requirement_for_top_enchantment    |  |
+     * | level_requirement_for_middle_enchantment | The enchantment's xp level requirement |
+     * | level_requirement_for_bottom_enchantment |  |
+     * | enchantment_seed                         | Used for drawing the enchantment names (in SGA) clientside. The same seed is used to calculate enchantments, but some of the data isn't sent to the client to prevent easily guessing the entire list (the seed value here is the regular seed bitwise and 0xFFFFFFF0). |
+     * | enchant_id_of_top_enchantment            |  |
+     * | enchant_id_of_middle_enchantment         | The enchantment ID (set to -1 to hide it), see below for values |
+     * | enchant_id_of_bottom_enchantment         |  |
+     * | enchant_level_of_top_enchantment         |  |
+     * | enchant_level_of_middle_enchantment      | The enchantment level (1 = I, 2 = II, 6 = VI, etc.), or -1 if no enchant |
+     * | enchant_level_of_bottom_enchantment      |  |
+     * | # **Beacon**                             | ------- |
+     * | power_level                              | 0-4, controls what effect buttons are enabled |
+     * | first_effect                             | Potion effect ID for the first effect, or -1 if no effect |
+     * | second_level                             | Potion effect ID for the second effect, or -1 if no effect |
+     * | # **Anvil**                              | ------- |
+     * | repair_cost                              | The repair's cost in XP levels |
+     * | # **Brewing stand**                      | ------- |
+     * | brew_time                                | 0 – 400, with 400 making the arrow empty, and 0 making the arrow full |
+     * | fuel_time                                | 0 - 20, with 0 making the arrow empty, and 20 making the arrow full |
+     * | # **Stonecutter**                        | ------- |
+     * | selected_recipe                          | The index of the selected recipe. -1 means none is selected |
+     * | # **Loom**                               | ------- |
+     * | selected_pattern                         | The index of the selected pattern. 0 means none is selected, 0 is also the internal ID of the "base" pattern |
+     * | # **Lectern**                            | ------- |
+     * | page_number                              | The current page number, starting from 0. |
+     * | # **Smithing table**                     | ------- |
+     * | has_recipe_error                         | True if greater than zero |
+     * | # **Crafter**                            | ------- |
+     * | slot_0_disabled                          |  |
+     * | slot_1_disabled                          |  |
+     * | slot_2_disabled                          |  |
+     * | slot_3_disabled                          |  |
+     * | slot_4_disabled                          | 0 If the slot is enabled, 1 if the slot is disabled |
+     * | slot_5_disabled                          |  |
+     * | slot_6_disabled                          |  |
+     * | slot_7_disabled                          |  |
+     * | slot_8_disabled                          |  |
+     * 
+     * @see https://minecraft.wiki/w/Java_Edition_data_values#Effects For effect ID
+     */
+    public properties: Record<string, number> = {};
+
+    constructor(
+        /**
+         * This is not used at the moment
+         */
+        public id: number,
+        /**
+         * @see https://minecraft.wiki/w/Java_Edition_protocol/Inventory#Types
+         */
+        public type: number,
+        public rawTitle: TextComponent
+    ) { }
+
+    /**
+     * @see https://minecraft.wiki/w/Java_Edition_protocol/Packets#Set_Container_Property
+     */
+    public setProperty(property: number, data: number) {
+        switch (this.type) {
+            case 14: // Furnace
+            case 10: // Blast furnace
+            case 22: // Smoker
+                switch (property) {
+                    case 0: this.properties["fuel_left"] = data; break;
+                    case 1: this.properties["max_burn_time"] = data; break;
+                    case 2: this.properties["progress_arrow"] = data; break;
+                    case 3: this.properties["max_progress"] = data; break;
+                }
+                break;
+            case 13: // Enchantment table
+                switch (property) {
+                    case 0: this.properties["level_requirement_for_top_enchantment"] = data; break;
+                    case 1: this.properties["level_requirement_for_middle_enchantment"] = data; break;
+                    case 2: this.properties["level_requirement_for_bottom_enchantment"] = data; break;
+                    case 3: this.properties["enchantment_seed"] = data; break;
+                    case 4: this.properties["enchant_id_of_top_enchantment"] = data; break;
+                    case 5: this.properties["enchant_id_of_middle_enchantment"] = data; break;
+                    case 6: this.properties["enchant_id_of_bottom_enchantment"] = data; break;
+                    case 7: this.properties["enchant_level_of_top_enchantment"] = data; break;
+                    case 8: this.properties["enchant_level_of_middle_enchantment"] = data; break;
+                    case 9: this.properties["enchant_level_of_bottom_enchantment"] = data; break;
+                }
+                break;
+            case 9: // Beacon
+                switch (property) {
+                    case 0: this.properties["power_level"] = data; break;
+                    case 1: this.properties["first_effect"] = data; break;
+                    case 2: this.properties["second_level"] = data; break;
+                }
+                break;
+            case 8: // Anvil
+                switch (property) {
+                    case 0: this.properties["repair_cost"] = data; break;
+                }
+                break;
+            case 11: // Brewing stand
+                switch (property) {
+                    case 0: this.properties["brew_time"] = data; break;
+                    case 1: this.properties["fuel_time"] = data; break;
+                }
+                break;
+            case 24: // Stonecutter
+                switch (property) {
+                    case 0: this.properties["selected_recipe"] = data; break;
+                }
+                break;
+            case 18: // Loom
+                switch (property) {
+                    case 0: this.properties["selected_pattern"] = data; break;
+                }
+                break;
+            case 17: // Lectern
+                switch (property) {
+                    case 0: this.properties["page_number"] = data; break;
+                }
+                break;
+            case 21: // Smithing table
+                switch (property) {
+                    case 0: this.properties["has_recipe_error"] = data; break;
+                }
+                break;
+            case 7: // Crafter
+                switch (property) {
+                    case 0: this.properties["slot_0_disabled"] = data; break;
+                    case 1: this.properties["slot_1_disabled"] = data; break;
+                    case 2: this.properties["slot_2_disabled"] = data; break;
+                    case 3: this.properties["slot_3_disabled"] = data; break;
+                    case 4: this.properties["slot_4_disabled"] = data; break;
+                    case 5: this.properties["slot_5_disabled"] = data; break;
+                    case 6: this.properties["slot_6_disabled"] = data; break;
+                    case 7: this.properties["slot_7_disabled"] = data; break;
+                    case 8: this.properties["slot_8_disabled"] = data; break;
+                }
+                break;
+        }
+    }
+}

package/src/world/entity.ts

@@ -1,6 +1,9 @@
 import { AABB } from "../physics/aabb";
 import { SharedState } from "./state";
 
+/**
+ * This class is for managing entities 
+ */
 export class EntitiesManager {
     /**
      * Split chunks into 16x16x16 sections, so each chunk sections will contain a set of entities

package/src/world/state.ts

@@ -1,5 +1,4 @@
 import { Cipheriv, Decipheriv } from "node:crypto";
-import { If } from "../base/typing";
 import { Angle, BaseVec3 } from "../physics/direction";
 import { AuthRelatedNotFound, ClientNotReady } from "../base/error";
 import { ClientEvents, ClientOption } from "../client/client";
@@ -7,6 +6,8 @@ import { AuthClient } from "../client/auth";
 import { MessageLink } from "../message/link";
 import { SignatureCache } from "../message/sigCache";
 import { CacheImplementation, LRUCache } from "../base/cache";
+import { Container, Slot } from "./container";
+import { ProtocolVersionMapping } from "../version/registry";
 
 export interface Server {
     knownPacks?: ServerKnownPack
@@ -125,7 +126,10 @@ export interface ClientPlayer {
     /** Current dimension */
     dimension: string,
 
-    effects: Record<number, Effect>
+    effects: Record<number, Effect>,
+
+    inventory: Container,
+    carryingItem: Slot | undefined,
 }
 
 export enum ClientStatus {
@@ -160,7 +164,7 @@ export type SendingPacket = {
 /**
  * For managing shared data between classes
  */
-export class SharedState<IsReady extends boolean = boolean> {
+export class SharedState {
     private mutationQueue: MutateState[] = [];
     private eventQueue: EmittedEvent[] = [];
     private packetQueue: SendingPacket[] = [];
@@ -183,12 +187,14 @@ export class SharedState<IsReady extends boolean = boolean> {
     public decipher: Decipheriv | undefined = undefined;
     public useEncryption: boolean = false;
     public sessionID: Buffer | undefined = undefined;
+    public sequence: number = 0;
 
     public server: Server | undefined = undefined;
     public registry: Record<string, ServerRegistryEntry[]> | undefined = undefined;
-    public world: If<IsReady, ServerWorld> = null as any;
-    public player: If<IsReady, ClientPlayer> = null as any;
+    public world: ServerWorld | null = null;
+    public player: ClientPlayer | null = null;
     public messageCount: number = 0;
+    public openingContainer: Container | undefined = undefined;
     
     public cache: CacheImplementation<Uint16Array> | undefined = undefined;
 
@@ -211,7 +217,7 @@ export class SharedState<IsReady extends boolean = boolean> {
         }
     }
 
-    public isReady(): this is SharedState<true> {
+    public isReady() {
         return this.status === ClientStatus.Ready;
     }
 
@@ -246,6 +252,8 @@ export class SharedState<IsReady extends boolean = boolean> {
         this.world = undefined as any;
         this.player = undefined as any;
         this.messageCount = 0;
+        this.openingContainer = undefined as any;
+        this.sequence = 0;
 
         if (this.clientOptions.shouldVerifyMessageSignature)
             this.messageSignatureCache = SignatureCache.default();
@@ -264,6 +272,10 @@ export class SharedState<IsReady extends boolean = boolean> {
         }
     }
 
+    public getProtocolId() {
+        return ProtocolVersionMapping[this.clientOptions.version]!;
+    }
+
     public getSignature() {
         if (this.publicKey && this.signature)
             return {
@@ -272,6 +284,9 @@ export class SharedState<IsReady extends boolean = boolean> {
             };
         throw new AuthRelatedNotFound("public key and signature");
     }
+    public nextSequence() {
+        return ++this.sequence;
+    }
 
     private async fetchSignature() {
         if (!this.authClient)

package/test/client/index.ts

@@ -1,13 +1,23 @@
-import { Input, Client } from "../../src/index";
+import { Input, Client, ClientEvents } from "../../src/index";
 
 const client = new Client({
     playerName: "bot",
     host: "localhost",
     port: 25565,
     version: "26.2",
-    // debug: {
-    //     packetLogger: true
-    // },
+    debug: {
+        packetLogger: true,
+        ignorePackets: [
+            "move_entity_pos", "move_entity_pos_rot", "move_entity_rot",
+            "set_entity_motion", "rotate_head", "set_time",
+            "add_entity", "remove_entities", "bundle_delimiter",
+            "entity_position_sync", "update_attributes",
+            "move_player_pos", "move_player_pos_rot", "move_player_rot",
+            "player_chat", "keep_alive", "entity_event", "tab_list",
+            "block_event"
+        ],
+        ignoreTCPPacketLogs: [0, 83, 54, 101, 1, 99, 53, 35, 131, 113, 102, 44, 56, 65, 34, 77, 122, 7, 46]
+    },
     loadRegistry: false,
     // auth: {
     //     client_id: "d86254d8-edf7-4640-90eb-643c99af188e",
@@ -17,23 +27,30 @@ const client = new Client({
     // },
     // shouldVerifyMessageOrder: true,
     // shouldVerifyMessageSignature: true
-    loadAndCacheChunk: true
+    loadAndCacheChunk: false
 });
+const forwardEventToConsole = <K extends keyof ClientEvents>(name: K) => client.on(name, ((...args: any[]) => console.dir({ name, args }, { depth: null })) as any);
 client.connect();
-client.on("disconnect", (...args) => console.dir({ name: "disconnect", args }, { depth: null }));
-client.on("disconnectRaw", (...args) => console.dir({ name: "disconnectRaw", args }, { depth: null }));
-// client.on("loadChunk", (...args) => console.dir({ name: "loadChunk", args }, { depth: null }));
-// client.on("unloadChunk", (...args) => console.dir({ name: "unloadChunk", args }, { depth: null }));
-// client.on("spawnEntity", (...args) => console.dir({ name: "spawnEntity", args }, { depth: null }));
-// client.on("updateEntity", (...args) => console.dir({ name: "updateEntity", args }, { depth: null }));
-// client.on("removeEntity", (...args) => console.dir({ name: "removeEntity", args }, { depth: null }));
-client.on("playerPosition", (...args) => console.dir({ name: "playerPosition", args }, { depth: null }));
-client.on("message", (...args) => console.dir({ name: "message", args }, { depth: null }));
-client.on("systemMessage", (...args) => console.dir({ name: "systemMessage", args }, { depth: null }));
-client.on("systemMessageRaw", (...args) => console.dir({ name: "systemMessageRaw", args }, { depth: null }));
-client.on("actionBar", (...args) => console.dir({ name: "actionBar", args }, { depth: null }));
-client.on("actionBarRaw", (...args) => console.dir({ name: "actionBarRaw", args }, { depth: null }));
-client.on("message", (message) => {
+forwardEventToConsole("disconnect");
+forwardEventToConsole("disconnectRaw");
+// forwardEventToConsole("loadChunk");
+// forwardEventToConsole("unloadChunk");
+// forwardEventToConsole("spawnEntity");
+// forwardEventToConsole("updateEntity");
+// forwardEventToConsole("removeEntity");
+// forwardEventToConsole("playerPosition");
+// forwardEventToConsole("message");
+forwardEventToConsole("systemMessage");
+forwardEventToConsole("systemMessageRaw");
+forwardEventToConsole("actionBar");
+forwardEventToConsole("actionBarRaw");
+forwardEventToConsole("openContainer");
+forwardEventToConsole("closeContainer");
+forwardEventToConsole("containerContent");
+forwardEventToConsole("containerProperty");
+forwardEventToConsole("tablist");
+
+client.on("message", async (message) => {
     if (!message.content.startsWith("_")) return;
     const args = message.content.slice(1).split(" ");
     switch (args[0]) {
@@ -58,9 +75,21 @@ client.on("message", (message) => {
         case "at": {
             const [, x, y, z] = args.map(val => parseInt(val)) as [any, number, number, number];
             console.time("get_block");
-            const state = client.at(x, y, z);
+            const state = client.getBlock(x, y, z);
             console.timeEnd("get_block");
-            console.log(state);
+            if (state) {
+                console.dir(state);
+                client.chat(state!.owner.type);
+            } else
+                client.chat("no block");
+            break;
+        }
+
+        case "open": {
+            const [, x, y, z] = args.map(val => Number(val)) as [any, number, number, number];
+            const success = client.openBlock(x, y, z);
+            if (success) client.chat("opening");
+            else client.chat("failed");
             break;
         }
 
@@ -76,5 +105,11 @@ client.on("message", (message) => {
         case "exit":
             client.disconnect();
             break;
+
+        case "pos": {
+            const { x, y, z } = client.getPosition();
+            client.chat(`XYZ: ${x} ${y} ${z}`);
+            break;
+        }
     }
 });