1.21.60 support (#570)

* Add support for ItemRegistryPacket (for shield item ID)

* simplify

* lint

* internal test

* update start_game handling

* test: capture events rejections

---------

Co-authored-by: extremeheat <[email protected]>

Author: CreeperG16

README.md

@@ -11,7 +11,7 @@ Minecraft Bedrock Edition (aka MCPE) protocol library, supporting authentication
 
 ## Features
 
- - Supports Minecraft Bedrock version 1.16.201, 1.16.210, 1.16.220, 1.17.0, 1.17.10, 1.17.30, 1.17.40, 1.18.0, 1.18.11, 1.18.30, 1.19.1, 1.19.10, 1.19.20, 1.19.21, 1.19.30, 1.19.40, 1.19.41, 1.19.50, 1.19.60, 1.19.62, 1.19.63, 1.19.70, 1.19.80, 1.20.0, 1.20.10, 1.20.30, 1.20.40, 1.20.50, 1.20.61, 1.20.71, 1.20.80, 1.21.0, 1.21.2, 1.21.21, 1.21.30, 1.21.42, 1.21.50
+ - Supports Minecraft Bedrock version 1.16.201, 1.16.210, 1.16.220, 1.17.0, 1.17.10, 1.17.30, 1.17.40, 1.18.0, 1.18.11, 1.18.30, 1.19.1, 1.19.10, 1.19.20, 1.19.21, 1.19.30, 1.19.40, 1.19.41, 1.19.50, 1.19.60, 1.19.62, 1.19.63, 1.19.70, 1.19.80, 1.20.0, 1.20.10, 1.20.30, 1.20.40, 1.20.50, 1.20.61, 1.20.71, 1.20.80, 1.21.0, 1.21.2, 1.21.21, 1.21.30, 1.21.42, 1.21.50, 1.21.60
  - Parse and serialize packets as JavaScript objects
  - Automatically respond to keep-alive packets
  - [Proxy and mitm connections](docs/API.md#proxy-docs)

index.d.ts

@@ -3,7 +3,7 @@ import { Realm } from 'prismarine-realms'
 import { ServerDeviceCodeResponse } from 'prismarine-auth'
 
 declare module 'bedrock-protocol' {
-  type Version = '1.21.42' | '1.21.30' | '1.21.2' | '1.21.0' | '1.20.80' | '1.20.71' | '1.20.61' | '1.20.50' | '1.20.40' | '1.20.30' | '1.20.10' | '1.20.0' | '1.19.80' | '1.19.70' | '1.19.63' | '1.19.62' | '1.19.60' | '1.19.51' | '1.19.50' | '1.19.41' | '1.19.40' | '1.19.31' | '1.19.30' | '1.19.22' | '1.19.21' | '1.19.20' | '1.19.11' | '1.19.10' | '1.19.2' | '1.19.1' | '1.18.31' | '1.18.30' | '1.18.12' | '1.18.11' | '1.18.10' | '1.18.2' | '1.18.1' | '1.18.0' | '1.17.41' | '1.17.40' | '1.17.34' | '1.17.30' | '1.17.11' | '1.17.10' | '1.17.0' | '1.16.220' | '1.16.210' | '1.16.201'
+  type Version = '1.21.60' | '1.21.50' | '1.21.42' | '1.21.30' | '1.21.2' | '1.21.0' | '1.20.80' | '1.20.71' | '1.20.61' | '1.20.50' | '1.20.40' | '1.20.30' | '1.20.10' | '1.20.0' | '1.19.80' | '1.19.70' | '1.19.63' | '1.19.62' | '1.19.60' | '1.19.51' | '1.19.50' | '1.19.41' | '1.19.40' | '1.19.31' | '1.19.30' | '1.19.22' | '1.19.21' | '1.19.20' | '1.19.11' | '1.19.10' | '1.19.2' | '1.19.1' | '1.18.31' | '1.18.30' | '1.18.12' | '1.18.11' | '1.18.10' | '1.18.2' | '1.18.1' | '1.18.0' | '1.17.41' | '1.17.40' | '1.17.34' | '1.17.30' | '1.17.11' | '1.17.10' | '1.17.0' | '1.16.220' | '1.16.210' | '1.16.201'
 
   export interface Options {
     // The string version to start the client or server as

src/client.js

@@ -61,7 +61,8 @@ class Client extends Connection {
     try {
       const mcData = require('minecraft-data')('bedrock_' + this.options.version)
       this.features = {
-        compressorInHeader: mcData.supportFeature('compressorInPacketHeader')
+        compressorInHeader: mcData.supportFeature('compressorInPacketHeader'),
+        itemRegistryPacket: mcData.supportFeature('itemRegistryPacket')
       }
     } catch (e) {
       throw new Error(`Unsupported version: '${this.options.version}', no data available`)
@@ -241,7 +242,9 @@ class Client extends Connection {
         break
       case 'start_game':
         this.startGameData = pakData.params
-        this.startGameData.itemstates.forEach(state => {
+        // fallsthrough
+      case 'item_registry': // 1.21.60+ send itemstates in item_registry packet
+        pakData.params.itemstates?.forEach(state => {
           if (state.name === 'minecraft:shield') {
             this.serializer.proto.setVariable('ShieldItemID', state.runtime_id)
             this.deserializer.proto.setVariable('ShieldItemID', state.runtime_id)

src/connection.js

@@ -70,9 +70,17 @@ class Connection extends EventEmitter {
     }
   }
 
+  _processOutbound (name, params) {
+    if (name === 'item_registry') {
+      this.updateItemPalette(params.itemstates)
+    } else if (name === 'start_game' && params.itemstates) {
+      this.updateItemPalette(params.itemstates)
+    }
+  }
+
   write (name, params) {
     this.outLog?.(name, params)
-    if (name === 'start_game') this.updateItemPalette(params.itemstates)
+    this._processOutbound(name, params)
     const batch = new Framer(this)
     const packet = this.serializer.createPacketBuffer({ name, params })
     batch.addEncodedPacket(packet)
@@ -86,7 +94,7 @@ class Connection extends EventEmitter {
 
   queue (name, params) {
     this.outLog?.('Q <- ', name, params)
-    if (name === 'start_game') this.updateItemPalette(params.itemstates)
+    this._processOutbound(name, params)
     const packet = this.serializer.createPacketBuffer({ name, params })
     if (name === 'level_chunk') {
       // Skip queue, send ASAP

src/options.js

@@ -3,7 +3,7 @@ const mcData = require('minecraft-data')
 // Minimum supported version (< will be kicked)
 const MIN_VERSION = '1.16.201'
 // Currently supported verson. Note, clients with newer versions can still connect as long as data is in minecraft-data
-const CURRENT_VERSION = '1.21.50'
+const CURRENT_VERSION = '1.21.60'
 
 const Versions = Object.fromEntries(mcData.versions.bedrock.filter(e => e.releaseType === 'release').map(e => [e.minecraftVersion, e.version]))
 

test/internal.js

@@ -63,7 +63,11 @@ async function startTest (version = CURRENT_VERSION, ok) {
         // client.queue('inventory_transaction', get('packets/inventory_transaction.json'))
         client.queue('player_list', get('packets/player_list.json'))
         client.queue('start_game', get('packets/start_game.json'))
-        client.queue('item_component', { entries: [] })
+        if (client.versionLessThan('1.21.60')) {
+          client.queue('item_component', { entries: [] })
+        } else {
+          client.queue('item_registry', get('packets/item_registry.json'))
+        }
         client.queue('set_spawn_position', get('packets/set_spawn_position.json'))
         client.queue('set_time', { time: 5433771 })
         client.queue('set_difficulty', { difficulty: 1 })

test/internal.test.js

@@ -3,6 +3,7 @@
 const { timedTest } = require('./internal')
 const { testedVersions } = require('../src/options')
 const { sleep } = require('../src/datatypes/util')
+require('events').captureRejections = true
 
 describe('internal client/server test', function () {
   const vcount = testedVersions.length