1.20.6 (#3412)

* 1.20.5

* lint

* fix

* update registry

* update java

* add debug

* fix

* debug

* Update testCommon.js

* update ci

* add protodef AOT compile code

* Update protodefCompile.js

* Update testCommon.js

* pitem, fix `login` event

* debug

* Update testCommon.js

* Update package.json test

* Update package.json

* update test events

* Update testCommon.js

* update

* fix pitem source

* remove some debug logging

* update

* Fix trade test

* remove manual protodef install from ci

* remove unnecessary install in ci

* change back version.js to support latest version

* update deps

* remove compile protocol in ci

* bump to support 1.20.6

* in tests teleport to overworld to prevent nether test to break the environment

* fix respawn in internal tests

* use normal tp before 1.14

* lint

* fix held item test

* fix item drop internal test for 1.20.6

* cleanup

---------

Co-authored-by: Romain Beaumont <romain.rom1@gmail.com>

Author: extremeheat

.github/workflows/ci.yml

@@ -52,7 +52,7 @@ jobs:
       - name: Setup Java JDK
         uses: actions/setup-java@v1.4.3
         with:
-          java-version: 17
+          java-version: 21
           java-package: jre
       - name: Install Dependencies
         run: npm install

.gitignore

@@ -10,3 +10,4 @@ test/server_*
 .vscode
 .DS_Store
 launcher_accounts.json
+data

.gitpod.yml

@@ -1,2 +1,2 @@
 tasks:
-- command: npm install
+- command: npm install && sdk install java

docs/README.md

@@ -17,7 +17,7 @@ First time using Node.js? You may want to start with the [tutorial](tutorial.md)
 
 ## Features
 
- * Supports Minecraft 1.8 to 1.20.4 (1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19 and 1.20)
+ * Supports Minecraft 1.8 to 1.20.5 (1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19 and 1.20 upto 1.20.6)
  * Entity knowledge and tracking.
  * Block knowledge. You can query the world around you. Milliseconds to find any block.
  * Physics and movement - handle all bounding boxes

lib/loader.js

@@ -95,6 +95,7 @@ function createBot (options = {}) {
     }).map(key => options.plugins[key])
   bot.loadPlugins([...internalPlugins, ...externalPlugins])
 
+  options.validateChannelProtocol = false
   bot._client = bot._client ?? mc.createClient(options)
   bot._client.on('connect', () => {
     bot.emit('connect')

lib/particle.js

@@ -5,8 +5,8 @@ module.exports = loader
 function loader (registry) {
   class Particle {
     constructor (id, position, offset, count = 1, movementSpeed = 0, longDistanceRender = false) {
-      Object.assign(this, registry.particles[id])
       this.id = id
+      Object.assign(this, registry.particles[id] || registry.particlesByName[id])
       this.position = position
       this.offset = offset
       this.count = count
@@ -15,14 +15,26 @@ function loader (registry) {
     }
 
     static fromNetwork (packet) {
-      return new Particle(
-        packet.particleId,
-        new Vec3(packet.x, packet.y, packet.z),
-        new Vec3(packet.offsetX, packet.offsetY, packet.offsetZ),
-        packet.particles,
-        packet.particleData,
-        packet.longDistance
-      )
+      if (registry.supportFeature('updatedParticlesPacket')) {
+        // TODO: We add extra data that's inside packet.particle.data that varies by the particle's .type
+        return new Particle(
+          packet.particle.type,
+          new Vec3(packet.x, packet.y, packet.z),
+          new Vec3(packet.offsetX, packet.offsetY, packet.offsetZ),
+          packet.amount,
+          packet.velocityOffset,
+          packet.longDistance
+        )
+      } else {
+        return new Particle(
+          packet.particleId,
+          new Vec3(packet.x, packet.y, packet.z),
+          new Vec3(packet.offsetX, packet.offsetY, packet.offsetZ),
+          packet.particles,
+          packet.particleData,
+          packet.longDistance
+        )
+      }
     }
   }
 

lib/plugins/blocks.js

@@ -531,6 +531,9 @@ function inject (bot, { version, storageBuilder, hideErrors }) {
     if (bot.supportFeature('dimensionIsAnInt')) {
       dimension = packet.dimension
       worldName = dimensionToFolderName(dimension)
+    } else if (bot.supportFeature('spawnRespawnWorldDataField')) { // 1.20.5+
+      dimension = packet.worldState.dimension
+      worldName = packet.worldState.name
     } else {
       dimension = packet.dimension
       worldName = /^minecraft:.+/.test(packet.worldName) ? packet.worldName : `minecraft:${packet.worldName}`
@@ -542,6 +545,11 @@ function inject (bot, { version, storageBuilder, hideErrors }) {
     if (bot.supportFeature('dimensionIsAnInt')) { // <=1.15.2
       if (dimension === packet.dimension) return
       dimension = packet.dimension
+    } else if (bot.supportFeature('spawnRespawnWorldDataField')) { // 1.20.5+
+      if (dimension === packet.worldState.dimension) return
+      if (worldName === packet.worldState.name && packet.copyMetadata === true) return // don't unload chunks if in same world and metaData is true
+      dimension = packet.worldState.dimension
+      worldName = packet.worldState.name
     } else { // >= 1.15.2
       if (dimension === packet.dimension) return
       if (worldName === packet.worldName && packet.copyMetadata === true) return // don't unload chunks if in same world and metaData is true

lib/plugins/breath.js

@@ -1,17 +1,19 @@
 module.exports = inject
 
 function inject (bot) {
+  if (bot.supportFeature('mcDataHasEntityMetadata')) {
+    // this is handled inside entities.js. We don't yet have entity metadataKeys for all versions but once we do
+    // we can delete the numerical checks here and in entities.js https://github.com/extremeheat/mineflayer/blob/eb9982aa04973b0086aac68a2847005d77f01a3d/lib/plugins/entities.js#L469
+    return
+  }
   bot._client.on('entity_metadata', (packet) => {
-    if (!bot?.entity?.id === packet?.entityId) return
-    if (packet?.metadata[1]?.key === 1) {
-      if (!packet?.metadata[1]?.value) return
-      bot.oxygenLevel = Math.round(packet.metadata[1].value / 15)
-      bot.emit('breath')
-    }
-    if (packet?.metadata[0]?.key === 1) {
-      if (!packet?.metadata[0]?.value) return
-      bot.oxygenLevel = Math.round(packet.metadata[0].value / 15)
-      bot.emit('breath')
+    if (!bot.entity) return
+    if (bot.entity.id !== packet.entityId) return
+    for (const metadata of packet.metadata) {
+      if (metadata.key === 1) {
+        bot.oxygenLevel = Math.round(packet.metadata[1].value / 15)
+        bot.emit('breath')
+      }
     }
   })
 }

lib/plugins/creative.js

@@ -35,7 +35,10 @@ function inject (bot) {
       item: Item.toNotch(item)
     })
 
-    await onceWithCleanup(bot.inventory, `updateSlot:${slot}`, { checkCondition: (oldItem, newItem) => item === null ? newItem === null : newItem?.name === item.name && newItem?.count === item.count && newItem?.metadata === item.metadata })
+    await onceWithCleanup(bot.inventory, `updateSlot:${slot}`, {
+      timeout: 5000,
+      checkCondition: (oldItem, newItem) => item === null ? newItem === null : newItem?.name === item.name && newItem?.count === item.count && newItem?.metadata === item.metadata
+    })
     creativeSlotsUpdates[slot] = false
   }
 

lib/plugins/entities.js

@@ -470,6 +470,12 @@ function inject (bot) {
           bot.emit('entityUncrouch', entity)
         }
       }
+
+      // Breathing (formerly in breath.js)
+      if (metas.air_supply != null) {
+        bot.oxygenLevel = Math.round(metas.air_supply / 15)
+        bot.emit('breath')
+      }
     } else {
       const typeSlot = (bot.supportFeature('itemsAreAlsoBlocks') ? 5 : 6) + (bot.supportFeature('entityMetadataHasLong') ? 1 : 0)
       const slot = packet.metadata.find(e => e.type === typeSlot)