mineflayer 4.36.0 → 4.37.1

package/.github/workflows/ci.yml

@@ -32,15 +32,21 @@ jobs:
     - id: set-matrix
       run: |
         node -e "
-          const testedVersions = require('./lib/version').testedVersions;
-          console.log('matrix='+JSON.stringify({'include': testedVersions.map(mcVersion => ({mcVersion}))}))
+          const v = require('./lib/version').testedVersions;
+          const groups = [];
+          const SIZE = 4;
+          for (let i = 0; i < v.length; i += SIZE) {
+            groups.push({ versions: v.slice(i, i + SIZE).join(' ') });
+          }
+          console.log('matrix='+JSON.stringify({'include': groups}))
         " >> $GITHUB_OUTPUT
 
   MinecraftServer:
     needs: PrepareSupportedVersions
     runs-on: ubuntu-latest
+    name: MC ${{ matrix.versions }}
     strategy:
-      matrix: ${{fromJson(needs.PrepareSupportedVersions.outputs.matrix)}}
+      matrix: ${{ fromJson(needs.PrepareSupportedVersions.outputs.matrix) }}
       fail-fast: false
 
     steps:
@@ -58,4 +64,33 @@ jobs:
         run: npm install
 
       - name: Start Tests
-        run: npm run mocha_test -- --retries 2 -g ${{ matrix.mcVersion }}v
+        run: |
+          exit_code=0
+          pids=""
+          for v in ${{ matrix.versions }}; do
+            npm run mocha_test -- --retries 3 -g "${v}v" > "test-${v}.log" 2>&1 &
+            pids="$pids $!"
+          done
+          for pid in $pids; do
+            wait $pid || exit_code=$?
+          done
+          # Print passing versions first, then failing versions last
+          for v in ${{ matrix.versions }}; do
+            if ! grep -q "failing" "test-${v}.log"; then
+              echo ""
+              echo "=========================================="
+              echo "  Results for Minecraft ${v}"
+              echo "=========================================="
+              cat "test-${v}.log"
+            fi
+          done
+          for v in ${{ matrix.versions }}; do
+            if grep -q "failing" "test-${v}.log"; then
+              echo ""
+              echo "=========================================="
+              echo "  FAILED: Minecraft ${v}"
+              echo "=========================================="
+              cat "test-${v}.log"
+            fi
+          done
+          exit $exit_code

package/docs/history.md

@@ -1,4 +1,23 @@
-## 4.35.0
+## 4.37.0
+
+## 4.37.1
+* [Convert yaw/pitch in sync_entity_position handler (#3896)](https://github.com/PrismarineJS/mineflayer/commit/2b65c14c6d335758d1fe753ade99d736b610413b) (thanks @domdomegg)
+* [Backport velocity field changes from 1.21.9+ to older versions (#3839)](https://github.com/PrismarineJS/mineflayer/commit/61fbd3a38177bde100b4ee9e130ccbcdb73fc7ea) (thanks @SuperGamerTron)
+* [Update history.md](https://github.com/PrismarineJS/mineflayer/commit/fd00edd4a0211e8f131abf23b0951e04acceb3f5) (thanks @extremeheat)
+* [Fix activateItem always having the same rotation (#3840)](https://github.com/PrismarineJS/mineflayer/commit/47a41c666f1f6e6783867ebe81e7386bbae72c24) (thanks @SuperGamerTron)
+* [Fix crash in digging plugin death handler (#3553) (#3835)](https://github.com/PrismarineJS/mineflayer/commit/8af96fc0186ab770174744ea3e1f247c229a8cb3) (thanks @plainprince)
+* [Fix crash issue when trying to parse bad skin JSON (#3712)](https://github.com/PrismarineJS/mineflayer/commit/dcbc5b2d605e38379724ca36467a911dc9cc562f) (thanks @TheSharkyOfficial)
+* [Patches isInWater for digSpeed (#3542)](https://github.com/PrismarineJS/mineflayer/commit/a516d1cdf21ce2676195c595a64798c6ad29c195) (thanks @Pix3lPirat3)
+* [fix firing heldItemChanged, add type (#3625)](https://github.com/PrismarineJS/mineflayer/commit/c5e0200686c269617f2a92c8db50fdceb899ba8a) (thanks @zardoy)
+* [Fix dimension type lookup for 1.19-1.20.4 on proxy/modded servers (#3822)](https://github.com/PrismarineJS/mineflayer/commit/6d5d3ae576030bbe388f4d36dbc5d4eee99458bf) (thanks @plainprince)
+* [Use minecraft-protocol ^1.66.0 with sync zlib fix (#3878)](https://github.com/PrismarineJS/mineflayer/commit/dc5c91a25a1f0d374017a2d1551b37396be7f658) (thanks @rom1504)
+
+* [CI: print failed version logs last for easy debugging (#3876)](https://github.com/PrismarineJS/mineflayer/commit/56efbcde16343576533eaa7a08e85b785ae847cd) (thanks @rom1504)
+* [Fix nether test reliability and add set_player_inventory handler (#3874)](https://github.com/PrismarineJS/mineflayer/commit/fd03f0a83e00229344b0624ce5ace9e0303599f3) (thanks @rom1504)
+* [Improve test reliability: reconnect, retry, server console, packet fix (#3873)](https://github.com/PrismarineJS/mineflayer/commit/23f60d2132d49c08d936073d215466a825045933) (thanks @rom1504)
+* [Improve test reliability: server console gamemode, retries, NaN guard (#3871)](https://github.com/PrismarineJS/mineflayer/commit/7af5e2ccf2f7ed1240ea792cb425a20e669618c2) (thanks @rom1504)
+* [CI: run 4 MC versions per job to halve runner pressure (#3870)](https://github.com/PrismarineJS/mineflayer/commit/85a164d86e2b8bac996946ef6fb46d800861c82f) (thanks @rom1504)
+* [Speed up tests: remove sleep(1000) in resetState (#3869)](https://github.com/PrismarineJS/mineflayer/commit/81ecd72bafafc711ee2bc32b19d64f2bd897c4fb) (thanks @rom1504)
 
 ## 4.36.0
 * [Update CI to Node 24 (#3861)](https://github.com/PrismarineJS/mineflayer/commit/3b05f83d536adb31103c811f7093361ff35449a1) (thanks @rom1504)
@@ -6,6 +25,7 @@
 * [Switch to trusted publishing via OIDC (#3856)](https://github.com/PrismarineJS/mineflayer/commit/3173eeded3982b144bc40d7b0fdfb083ee7eb118) (thanks @rom1504)
 * [Bump @types/node to 25.2.1 + fix flaky time & nether tests (#3828)](https://github.com/PrismarineJS/mineflayer/commit/89686596c8de1091bf45104ba3230a5e87707a20) (thanks @plainprince)
 
+## 4.35.0
 * [🎈 1.21.11 (#3781)](https://github.com/PrismarineJS/mineflayer/commit/597745c7c061943620fcacba7254bccee05b7a3e) (thanks @rom1504bot)
 * [Fix chat pattern and event listener in tutorial (#3783)](https://github.com/PrismarineJS/mineflayer/commit/48586138f560991de60bea639c71fa82954cf50f) (thanks @brentspine)
 * [Update history.md](https://github.com/PrismarineJS/mineflayer/commit/c9f766513d5bb5a93c5b86c07827128716c0afdb) (thanks @extremeheat)

package/index.d.ts

@@ -162,6 +162,7 @@ export interface BotEvents {
   bossBarDeleted: (bossBar: BossBar) => Promise<void> | void
   bossBarUpdated: (bossBar: BossBar) => Promise<void> | void
   resourcePack: (url: string, hash?: string, uuid?: string) => Promise<void> | void
+  heldItemChanged: (newItem: Item | null) => Promise<void> | void
   particle: (particle: Particle) => Promise<void> | void
 }
 
@@ -386,8 +387,8 @@ export interface Bot extends TypedEmitter<BotEvents> {
     times?: number
   ) => Promise<void>
 
-  
-  
+
+
   setCommandBlock: (pos: Vec3, command: string, options: CommandBlockOptions) => void
 
   clickWindow: (

package/lib/plugins/digging.js

@@ -210,9 +210,11 @@ function inject (bot) {
   }
 
   bot.on('death', () => {
-    bot.removeAllListeners('diggingAborted')
-    bot.removeAllListeners('diggingCompleted')
-    bot.stopDigging()
+    try {
+      bot.removeAllListeners('diggingAborted')
+      bot.removeAllListeners('diggingCompleted')
+      bot.stopDigging()
+    } catch (_) {}
   })
 
   function canDigBlock (block) {
@@ -246,13 +248,14 @@ function inject (bot) {
     return block.digTime(
       type,
       creative,
-      bot.entity.isInWater,
+      ['water', 'flowing_water'].includes(bot._getBlockAtEyeLevel()?.name),
       !bot.entity.onGround,
       enchantments,
       bot.entity.effects
     )
   }
 
+  bot._getBlockAtEyeLevel = () => bot.entity.position && bot.blockAt(bot.entity.position.offset(0, bot.entity.eyeHeight, 0))
   bot.dig = dig
   bot.stopDigging = noop
   bot.canDigBlock = canDigBlock

package/lib/plugins/entities.js

@@ -1,5 +1,6 @@
 const { Vec3 } = require('vec3')
 const conv = require('../conversions')
+const mojangson = require('mojangson')
 // These values are only accurate for versions 1.14 and above (crouch hitbox changes)
 // Todo: hitbox sizes for sleeping, swimming/crawling, and flying with elytra
 const PLAYER_HEIGHT = 1.8
@@ -270,13 +271,7 @@ function inject (bot) {
     entity.yaw = conv.fromNotchianYawByte(packet.yaw)
     entity.pitch = conv.fromNotchianPitchByte(packet.pitch)
     entity.headPitch = conv.fromNotchianPitchByte(packet.headPitch)
-
-    let notchVel
-    if (bot.supportFeature('entityVelocityIsLpVec3')) {
-      notchVel = new Vec3(packet.velocity.x, packet.velocity.y, packet.velocity.z)
-    } else {
-      notchVel = new Vec3(packet.velocityX, packet.velocityY, packet.velocityZ)
-    }
+    const notchVel = new Vec3(packet.velocity.x, packet.velocity.y, packet.velocity.z)
     entity.velocity.update(conv.fromNotchVelocity(notchVel))
     entity.metadata = parseMetadata(packet.metadata, entity.metadata)
 
@@ -286,12 +281,7 @@ function inject (bot) {
   bot._client.on('entity_velocity', (packet) => {
     // entity velocity
     const entity = fetchEntity(packet.entityId)
-    let notchVel
-    if (bot.supportFeature('entityVelocityIsLpVec3')) {
-      notchVel = new Vec3(packet.velocity.x, packet.velocity.y, packet.velocity.z)
-    } else {
-      notchVel = new Vec3(packet.velocityX, packet.velocityY, packet.velocityZ)
-    }
+    const notchVel = new Vec3(packet.velocity.x, packet.velocity.y, packet.velocity.z)
     entity.velocity.update(conv.fromNotchVelocity(notchVel))
   })
 
@@ -359,8 +349,8 @@ function inject (bot) {
     const entity = fetchEntity(packet.entityId)
     entity.position.set(packet.x, packet.y, packet.z)
     entity.velocity.set(packet.dx, packet.dy, packet.dz)
-    entity.yaw = packet.yaw
-    entity.pitch = packet.pitch
+    entity.yaw = conv.fromNotchianYaw(packet.yaw)
+    entity.pitch = conv.fromNotchianPitch(packet.pitch)
     bot.emit('entityMoved', entity)
   })
 
@@ -953,7 +943,12 @@ function extractSkinInformation (properties) {
     return undefined
   }
 
-  const skinTexture = JSON.parse(Buffer.from(props.textures.value, 'base64').toString('utf8'))
+  let skinTexture
+  try { // Handles mojangson-style player data
+    skinTexture = JSON.parse(Buffer.from(props.textures.value, 'base64'))
+  } catch (e) {
+    skinTexture = mojangson.simplify(mojangson.parse(Buffer.from(props.textures.value, 'base64').toString('utf-8')))
+  }
 
   const skinTextureUrl = skinTexture?.textures?.SKIN?.url ?? undefined
   const skinTextureModel = skinTexture?.textures?.SKIN?.metadata?.model ?? undefined

package/lib/plugins/game.js

@@ -47,7 +47,18 @@ function inject (bot, options) {
     } else if (bot.supportFeature('dimensionIsAString')) {
       bot.game.dimension = packet.dimension.replace('minecraft:', '')
     } else if (bot.supportFeature('dimensionIsAWorld')) {
-      bot.game.dimension = packet.worldName.replace('minecraft:', '')
+      if (bot.supportFeature('dimensionDataInCodec')) {
+        // For 1.19+, we need the dimension TYPE name (not the world/level name) so
+        // the codec lookup succeeds. In login packets the type is "worldType"; in
+        // respawn packets it is "dimension". worldName is the level name which may
+        // differ from the type on proxy/modded servers.
+        const dimType = packet.worldType ?? packet.dimension
+        bot.game.dimension = typeof dimType === 'string'
+          ? dimType.replace('minecraft:', '')
+          : packet.worldName.replace('minecraft:', '')
+      } else {
+        bot.game.dimension = packet.worldName.replace('minecraft:', '')
+      }
     } else {
       throw new Error('Unsupported dimension type in login packet')
     }
@@ -60,11 +71,6 @@ function inject (bot, options) {
     bot.game.height = 256
 
     if (bot.supportFeature('dimensionDataInCodec')) { // 1.19+
-      // pre 1.20.5 before we consolidated login and respawn's SpawnInfo structure into one type,
-      // "dimension" was called "worldType" in login_packet's payload but not respawn.
-      if (packet.worldType && !bot.game.dimension) {
-        bot.game.dimension = packet.worldType.replace('minecraft:', '')
-      }
       const dimData = bot.registry.dimensionsByName[bot.game.dimension]
       if (dimData) {
         bot.game.minY = dimData.minY

package/lib/plugins/inventory.js

@@ -1,6 +1,7 @@
 const assert = require('assert')
 const { Vec3 } = require('vec3')
 const { once, sleep, createDoneTask, createTask, withTimeout } = require('../promise_utils')
+const { toNotchianYaw, toNotchianPitch } = require('../conversions')
 
 module.exports = inject
 
@@ -128,7 +129,10 @@ function inject (bot, { hideErrors }) {
       bot._client.write('use_item', {
         hand: offHand ? 1 : 0,
         sequence,
-        rotation: { x: 0, y: 0 }
+        rotation: {
+          x: toNotchianYaw(bot.entity.yaw),
+          y: toNotchianPitch(bot.entity.pitch)
+        }
       })
     }
   }
@@ -547,7 +551,7 @@ function inject (bot, { hideErrors }) {
     }
     const window = bot.currentWindow || bot.inventory
 
-    assert.ok(mode >= 0 && mode <= 4)
+    assert.ok(mode >= 0 && mode <= 6)
     const actionId = createActionNumber()
 
     const click = {
@@ -728,6 +732,17 @@ function inject (bot, { hideErrors }) {
     const newItem = Item.fromNotch(packet.item)
     bot._setSlot(packet.slot, newItem, window)
   })
+  // 1.21.9+ uses set_player_inventory for server-initiated inventory changes
+  // (e.g. console /give) instead of set_slot
+  bot._client.on('set_player_inventory', (packet) => {
+    const newItem = Item.fromNotch(packet.contents)
+    bot._setSlot(packet.slotId, newItem)
+  })
+  bot.inventory.on('updateSlot', (index) => {
+    if (index === bot.quickBarSlot + bot.inventory.hotbarStart) {
+      bot.emit('heldItemChanged', bot.heldItem)
+    }
+  })
   bot._client.on('window_items', (packet) => {
     const window = packet.windowId === 0 ? bot.inventory : bot.currentWindow
     if (!window || window.id !== packet.windowId) {

package/lib/plugins/physics.js

@@ -76,6 +76,7 @@ function inject (bot, { physicsEnabled, maxCatchupTicks }) {
   }
 
   function tickPhysics (now) {
+    if (!bot.entity?.position || !Number.isFinite(bot.entity.position.x)) return // entity not ready
     if (bot.blockAt(bot.entity.position) == null) return // check if chunk is unloaded
     if (bot.physicsEnabled && shouldUsePhysics) {
       physics.simulatePlayer(new PlayerState(bot, controlState), world).apply(bot)
@@ -99,6 +100,7 @@ function inject (bot, { physicsEnabled, maxCatchupTicks }) {
 
   function sendPacketPosition (position, onGround) {
     // sends data, no logic
+    if (!Number.isFinite(position.x) || !Number.isFinite(position.y) || !Number.isFinite(position.z)) return
     const oldPos = new Vec3(lastSent.x, lastSent.y, lastSent.z)
     lastSent.x = position.x
     lastSent.y = position.y
@@ -122,6 +124,7 @@ function inject (bot, { physicsEnabled, maxCatchupTicks }) {
 
   function sendPacketPositionAndLook (position, yaw, pitch, onGround) {
     // sends data, no logic
+    if (!Number.isFinite(position.x) || !Number.isFinite(position.y) || !Number.isFinite(position.z)) return
     const oldPos = new Vec3(lastSent.x, lastSent.y, lastSent.z)
     lastSent.x = position.x
     lastSent.y = position.y
@@ -153,6 +156,8 @@ function inject (bot, { physicsEnabled, maxCatchupTicks }) {
   function updatePosition (now) {
     // Only send updates for 20 ticks after death
     if (isEntityRemoved()) return
+    // Don't send position with invalid coordinates (NaN after death)
+    if (!Number.isFinite(bot.entity.position.x)) return
 
     // Increment the yaw in baby steps so that notchian clients (not the server) can keep up.
     const dYaw = deltaYaw(bot.entity.yaw, lastSentYaw)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mineflayer",
-  "version": "4.36.0",
+  "version": "4.37.1",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",
@@ -22,7 +22,8 @@
   "license": "MIT",
   "dependencies": {
     "minecraft-data": "^3.108.0",
-    "minecraft-protocol": "^1.64.0",
+    "minecraft-protocol": "^1.66.0",
+    "mojangson": "^2.0.4",
     "prismarine-biome": "^1.1.1",
     "prismarine-block": "^1.22.0",
     "prismarine-chat": "^1.7.1",