Merge remote-tracking branch 'upstream/master' into master-origin

.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

docs/history.md

@@ -1,3 +1,23 @@
+## 4.22.0
+* [Remove debug logging (#3478)](https://github.com/PrismarineJS/mineflayer/commit/eb29d350ede0590fce17e04bf21071807a87e3a1) (thanks @extremeheat)
+
+## 4.21.0
+* [1.20.6 (#3412)](https://github.com/PrismarineJS/mineflayer/commit/44fad41c18be5024564e24e1cdee624d35d4d387) (thanks @extremeheat)
+* [Update README.md (#3420)](https://github.com/PrismarineJS/mineflayer/commit/1c2a5c0fa78f74a63fabd7edde85c4a74db32dee) (thanks @SilkePilon)
+* [types: add pitchSpeed as an option in typings (#3446)](https://github.com/PrismarineJS/mineflayer/commit/05b48ad0dad4cf64a1c11660bac256d7b4015841) (thanks @GenerelSchwerz)
+* [Fixed a bug with not closing the window when changing the subserver (#3424)](https://github.com/PrismarineJS/mineflayer/commit/d00c386cfe51cefc361c0ff4d30b100aee9f114a) (thanks @DenisKvak1)
+* [Bump @types/node from 20.14.14 to 22.1.0 (#3431)](https://github.com/PrismarineJS/mineflayer/commit/1d461616b514969fdece38e49bfbec747ab8d76a) (thanks @dependabot[bot])
+* [Fix updateSlot event type (#3425)](https://github.com/PrismarineJS/mineflayer/commit/5d39db26a6ab17baac38b68af8ccd3eeb4af3def) (thanks @DenisKvak1)
+* [Player hitbox fixes (#3382)](https://github.com/PrismarineJS/mineflayer/commit/78b4eccb4572a821b11c3124b7a593f3b91f1180) (thanks @AreaDenial)
+* [Typo fixes (#3418)](https://github.com/PrismarineJS/mineflayer/commit/ef042a242ca9f5fc5820fe4dc2e1d997ef1db202) (thanks @kgurchiek)
+* [Added support for 1.18+ edit book packet #3204 (#3373)](https://github.com/PrismarineJS/mineflayer/commit/eb9982aa04973b0086aac68a2847005d77f01a3d) (thanks @unlimitedcoder2)
+* [Fix typos (#3381)](https://github.com/PrismarineJS/mineflayer/commit/d581ea7cee4d5b7df9606f671656bb0be0fdbf91) (thanks @data-miner00)
+* [Fix typescript types syntax for setCommandBlock (#3366)](https://github.com/PrismarineJS/mineflayer/commit/315cdfc4b1fc2760e4a8a36feb718626a66d5056) (thanks @undefined)
+* [Remove invalid sign check (#3328)](https://github.com/PrismarineJS/mineflayer/commit/ec76468c8ac4c6232bad3c2b66d4160f95f58396) (thanks @zardoy)
+* [refactor: simplifying the code of blockAtCursor (#3337)](https://github.com/PrismarineJS/mineflayer/commit/dc70f932ac9aaab6e6cdb15057b409b15c3232dd) (thanks @SnowRunescape)
+* [Updated setCommandBlock's 3rd argument (#3356)](https://github.com/PrismarineJS/mineflayer/commit/04ad6db404f0da779004b3ddd0e049bf2c6be0a3) (thanks @FlooferLand)
+* [Added the serverBrand property to index.d.ts (#3355)](https://github.com/PrismarineJS/mineflayer/commit/0bb2707d2f6d0d64a467d4e0d6ddc52adf526127) (thanks @Khaogamermain01)
+
 ## 4.20.1
 * [Add bossBarCreated event in index.d.ts (#3340)](https://github.com/PrismarineJS/mineflayer/commit/8299288526cd7ff24bcd87511814221f8ad62507) (thanks @gguio)
 * [Update scoreboard.js (#3318)](https://github.com/PrismarineJS/mineflayer/commit/195b3cbd70a110080af9b77a4659991c5d9e484a) (thanks @vicdum)

examples/echo.js

@@ -9,18 +9,22 @@
 const mineflayer = require('mineflayer')
 
 if (process.argv.length < 4 || process.argv.length > 6) {
-  console.log('Usage : node echo.js <host> <port> [<name>] [<password>]')
+  console.log('Usage : node echo.js <host> <port> [<name>] [online?]')
   process.exit(1)
 }
 
 const bot = mineflayer.createBot({
   host: process.argv[2],
   port: parseInt(process.argv[3]),
   username: process.argv[4] ? process.argv[4] : 'echo',
-  password: process.argv[5]
+  auth: process.argv[5] ? 'microsoft' : 'offline'
 })
 
 bot.on('chat', (username, message) => {
   if (username === bot.username) return
   bot.chat(message)
 })
+
+bot.on('kicked', (reason) => {
+  console.log('I was kicked from the server: ' + reason)
+})

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

@@ -532,6 +532,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}`
@@ -543,6 +546,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

@@ -486,6 +486,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)

lib/plugins/fishing.js

@@ -25,8 +25,13 @@ function inject (bot) {
     if (!lastBobber || fishingTask.done) return
 
     const pos = lastBobber.position
-    const parts = bot.registry.particlesByName
-    if (packet.particleId === (parts?.fishing ?? parts.bubble).id && packet.particles === 6 && pos.distanceTo(new Vec3(packet.x, pos.y, packet.z)) <= 1.23) {
+
+    const bobberCondition = bot.registry.supportFeature('updatedParticlesPacket')
+      ? ((packet.particle.type === 'fishing' || packet.particle.type === 'bubble') && packet.amount === 6 && pos.distanceTo(new Vec3(packet.x, pos.y, packet.z)) <= 1.23)
+      // This "(particles.fishing ?? particles.bubble).id" condition doesn't make sense (these are both valid types)
+      : (packet.particleId === (bot.registry.particlesByName.fishing ?? bot.registry.particlesByName.bubble).id && packet.particles === 6 && pos.distanceTo(new Vec3(packet.x, pos.y, packet.z)) <= 1.23)
+
+    if (bobberCondition) {
       bot.activateItem()
       lastBobber = undefined
       fishingTask.finish()

lib/plugins/game.js

@@ -25,8 +25,14 @@ function inject (bot, options) {
   function handleRespawnPacketData (packet) {
     bot.game.levelType = packet.levelType ?? (packet.isFlat ? 'flat' : 'default')
     bot.game.hardcore = packet.isHardcore ?? Boolean(packet.gameMode & 0b100)
-    bot.game.gameMode = parseGameMode(packet.gameMode)
-    if (bot.supportFeature('dimensionIsAnInt')) {
+    bot.game.gameMode = packet.gamemode || parseGameMode(packet.gameMode)
+    if (bot.supportFeature('segmentedRegistryCodecData')) { // 1.20.5
+      if (typeof packet.dimension === 'number') {
+        bot.game.dimension = bot.registry.dimensionsArray[packet.dimension]?.name?.replace('minecraft:', '')
+      } else if (typeof packet.dimension === 'string') { // iirc, in 1.21 it's back to a string
+        bot.game.dimension = packet.dimension.replace('minecraft:', '')
+      }
+    } else if (bot.supportFeature('dimensionIsAnInt')) {
       bot.game.dimension = dimensionNames[packet.dimension]
     } else if (bot.supportFeature('dimensionIsAString')) {
       bot.game.dimension = packet.dimension.replace('minecraft:', '')
@@ -40,25 +46,24 @@ function inject (bot, options) {
       bot.registry.loadDimensionCodec(packet.dimensionCodec)
     }
 
+    bot.game.minY = 0
+    bot.game.height = 256
+
     if (bot.supportFeature('dimensionDataInCodec')) { // 1.19+
-      if (packet.worldType) { // login
+      // 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 { minY, height } = bot.registry.dimensionsByName[bot.game.dimension]
-        bot.game.minY = minY
-        bot.game.height = height
-      } else if (packet.dimension) { // respawn
-        bot.game.dimension = packet.dimension.replace('minecraft:', '')
-        const { minY, height } = bot.registry.dimensionsByName[bot.game.dimension]
-        bot.game.minY = minY
-        bot.game.height = height
+      }
+      const dimData = bot.registry.dimensionsByName[bot.game.dimension]
+      if (dimData) {
+        bot.game.minY = dimData.minY
+        bot.game.height = dimData.height
       }
     } else if (bot.supportFeature('dimensionDataIsAvailable')) { // 1.16.2+
       const dimensionData = nbt.simplify(packet.dimension)
       bot.game.minY = dimensionData.min_y
       bot.game.height = dimensionData.height
-    } else {
-      bot.game.minY = 0
-      bot.game.height = 256
     }
 
     if (packet.difficulty) {
@@ -73,11 +78,11 @@ function inject (bot, options) {
 
   // 1.20.2
   bot._client.on('registry_data', (packet) => {
-    bot.registry.loadDimensionCodec(packet.codec)
+    bot.registry.loadDimensionCodec(packet.codec || packet)
   })
 
   bot._client.on('login', (packet) => {
-    handleRespawnPacketData(packet)
+    handleRespawnPacketData(packet.worldState || packet)
 
     bot.game.maxPlayers = packet.maxPlayers
     if (packet.enableRespawnScreen) {
@@ -95,7 +100,8 @@ function inject (bot, options) {
   })
 
   bot._client.on('respawn', (packet) => {
-    handleRespawnPacketData(packet)
+    // in 1.20.5+ protocol we move the shared spawn data into one SpawnInfo type under .worldState
+    handleRespawnPacketData(packet.worldState || packet)
     bot.emit('game')
   })
 

lib/version.js

@@ -1,4 +1,4 @@
-const testedVersions = ['1.8.8', '1.9.4', '1.10.2', '1.11.2', '1.12.2', '1.13.2', '1.14.4', '1.15.2', '1.16.5', '1.17.1', '1.18.2', '1.19', '1.19.2', '1.19.3', '1.19.4', '1.20.1', '1.20.2', '1.20.4']
+const testedVersions = ['1.8.8', '1.9.4', '1.10.2', '1.11.2', '1.12.2', '1.13.2', '1.14.4', '1.15.2', '1.16.5', '1.17.1', '1.18.2', '1.19', '1.19.2', '1.19.3', '1.19.4', '1.20.1', '1.20.2', '1.20.4', '1.20.6']
 module.exports = {
 
   testedVersions,

package.json

@@ -1,11 +1,11 @@
 {
   "name": "mineflayer",
-  "version": "4.20.1",
+  "version": "4.22.0",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",
   "scripts": {
-    "mocha_test": "mocha --reporter spec --exit",
+    "mocha_test": "mocha --reporter spec --exit --bail",
     "test": "npm run mocha_test",
     "pretest": "npm run lint",
     "lint": "standard && standard-markdown",
@@ -21,21 +21,21 @@
   },
   "license": "MIT",
   "dependencies": {
-    "minecraft-data": "^3.56.0",
-    "minecraft-protocol": "^1.47.0",
+    "minecraft-data": "^3.76.0",
+    "minecraft-protocol": "^1.49.0",
     "prismarine-biome": "^1.1.1",
     "prismarine-block": "^1.17.0",
     "prismarine-chat": "^1.7.1",
     "prismarine-chunk": "^1.34.0",
     "prismarine-entity": "^2.3.0",
-    "prismarine-item": "^1.14.0",
+    "prismarine-item": "^1.15.0",
     "prismarine-nbt": "^2.0.0",
     "prismarine-physics": "^1.8.0",
     "prismarine-recipe": "^1.3.0",
-    "prismarine-registry": "^1.5.0",
+    "prismarine-registry": "^1.8.0",
     "prismarine-windows": "^2.9.0",
     "prismarine-world": "^3.6.0",
-    "protodef": "^1.14.0",
+    "protodef": "1.17.0",
     "typed-emitter": "^1.0.0",
     "vec3": "^0.1.7"
   },
@@ -45,6 +45,7 @@
     "minecraft-wrap": "^1.3.0",
     "mineflayer": "file:.",
     "mocha": "^10.0.0",
+    "protodef-yaml": "^1.5.3",
     "standard": "^17.0.0",
     "standard-markdown": "^7.1.0",
     "typescript": "^5.4.5"

test/externalTest.js

@@ -132,7 +132,7 @@ for (const supportedVersion of mineflayer.testedVersions) {
         const runTest = (testName, testFunction) => {
           return function (done) {
             this.timeout(TEST_TIMEOUT_MS)
-            bot.test.sayEverywhere(`starting ${testName}`)
+            bot.test.sayEverywhere(`### Starting ${testName}`)
             testFunction(bot, done).then(res => done()).catch(e => done(e))
           }
         }

test/externalTests/heldItem.js

@@ -5,6 +5,7 @@ module.exports = () => async (bot) => {
 
   await bot.test.becomeCreative()
   await bot.test.clearInventory()
+  await bot.test.wait(100)
   assert.equal(bot.heldItem, null)
 
   const stoneId = bot.registry.itemsByName.stone.id

test/externalTests/nether.js

@@ -14,12 +14,14 @@ module.exports = () => async (bot) => {
 
   const p = new Promise((resolve, reject) => {
     bot._client.on('open_sign_entity', (packet) => {
+      console.log('Open sign', packet)
       const sign = bot.blockAt(new Vec3(packet.location))
       bot.updateSign(sign, '1\n2\n3\n')
 
       setTimeout(() => {
         // Get updated sign
         const sign = bot.blockAt(bot.entity.position)
+        console.log('Updated sign', sign)
 
         assert.strictEqual(sign.signText.trimEnd(), '1\n2\n3')
 
@@ -48,5 +50,5 @@ module.exports = () => async (bot) => {
   await bot.lookAt(lowerBlock.position, true)
   await bot.test.setInventorySlot(36, new Item(signItem.id, 1, 0))
   await bot.placeBlock(lowerBlock, new Vec3(0, 1, 0))
-  return p
+  await p
 }