mineflayer 3.10.0 → 3.12.0

package/lib/plugins/blocks.js

@@ -1,4 +1,4 @@
-const Vec3 = require('vec3').Vec3
+const { Vec3 } = require('vec3')
 const assert = require('assert')
 const Painting = require('../painting')
 const { onceWithCleanup, callbackify } = require('../promise_utils')
@@ -89,7 +89,12 @@ function inject (bot, { version, storageBuilder }) {
     }
     let column = bot.world.getColumn(args.x, args.z)
     if (!column) {
-      column = new Chunk()
+      // Allocates new chunk object while taking world's custom min/max height into account
+      if (bot.supportFeature('dimensionDataIsAvailable')) {
+        column = new Chunk({ minY: bot.game.dimensionData.min_y, worldHeight: bot.game.dimensionData.height })
+      } else {
+        column = new Chunk()
+      }
     }
 
     try {
@@ -294,11 +299,19 @@ function inject (bot, { version, storageBuilder }) {
   bot._client.on('update_light', (packet) => {
     let column = bot.world.getColumn(packet.chunkX, packet.chunkZ)
     if (!column) {
-      column = new Chunk()
+      if (bot.supportFeature('dimensionDataIsAvailable')) {
+        column = new Chunk({ minY: bot.game.dimensionData.min_y, worldHeight: bot.game.dimensionData.height })
+      } else {
+        column = new Chunk()
+      }
       bot.world.setColumn(packet.chunkX, packet.chunkZ, column)
     }
 
-    column.loadLight(packet.data, packet.skyLightMask, packet.blockLightMask, packet.emptySkyLightMask, packet.emptyBlockLightMask)
+    if (bot.supportFeature('dimensionDataIsAvailable')) {
+      column.loadParsedLight(packet.skyLight, packet.blockLight, packet.skyLightMask, packet.blockLightMask, packet.emptySkyLightMask, packet.emptyBlockLightMask)
+    } else {
+      column.loadLight(packet.data, packet.skyLightMask, packet.blockLightMask, packet.emptySkyLightMask, packet.emptyBlockLightMask)
+    }
   })
 
   bot._client.on('map_chunk', (packet) => {

package/lib/plugins/chat.js

@@ -4,6 +4,7 @@ module.exports = inject
 
 function inject (bot, options) {
   const CHAT_LENGTH_LIMIT = options.chatLengthLimit ?? (bot.supportFeature('lessCharsInChat') ? 100 : 256)
+  const defaultChatPatterns = options.defaultChatPatterns ?? true
 
   const ChatMessage = require('prismarine-chat')(bot.version)
   // chat.pattern.type will emit an event for bot.on() of the same type, eg chatType = whisper will trigger bot.on('whisper')
@@ -15,6 +16,7 @@ function inject (bot, options) {
   }
 
   bot.addChatPatternSet = (name, patterns, opts = {}) => {
+    if (!patterns.every(p => p instanceof RegExp)) throw new Error('Pattern parameter should be of type RegExp')
     const { repeat = true, parse = false } = opts
     _patterns[_length++] = {
       name,
@@ -29,6 +31,7 @@ function inject (bot, options) {
   }
 
   bot.addChatPattern = (name, pattern, opts = {}) => {
+    if (!(pattern instanceof RegExp)) throw new Error('Pattern parameter should be of type RegExp')
     const { repeat = true, deprecated = false, parse = false } = opts
     _patterns[_length++] = {
       name,
@@ -103,12 +106,7 @@ function inject (bot, options) {
   addDefaultPatterns()
 
   bot._client.on('chat', (packet) => {
-    let msg
-    try {
-      msg = new ChatMessage(JSON.parse(packet.message))
-    } catch (e) {
-      msg = new ChatMessage(packet.message)
-    }
+    const msg = ChatMessage.fromNotch(packet.message)
 
     const ChatPositions = {
       0: 'chat',
@@ -174,6 +172,7 @@ function inject (bot, options) {
   bot.tabComplete = callbackify(tabComplete)
 
   function addDefaultPatterns () {
+    if (!defaultChatPatterns) return
     const USERNAME_REGEX = '(?:\\(.+\\)|\\[.+\\]|.)*?(\\w+)'
     bot.addChatPattern('whisper', new RegExp(`^${USERNAME_REGEX} whispers(?: to you)?:? (.*)$`), { deprecated: true })
     bot.addChatPattern('whisper', new RegExp(`^\\[${USERNAME_REGEX} -> \\w+\\s?\\] (.*)$`), { deprecated: true })

package/lib/plugins/command_block.js

@@ -1,5 +1,5 @@
 const assert = require('assert')
-const ProtoDef = require('protodef').ProtoDef
+const { ProtoDef } = require('protodef')
 
 module.exports = inject
 

package/lib/plugins/craft.js

@@ -114,10 +114,10 @@ function inject (bot, { version }) {
 
       async function grabResult () {
         assert.strictEqual(window.selectedItem, null)
+        // Causes a double-emit on 1.12+ --nickelpro
         // put the recipe result in the output
         const item = new Item(recipe.result.id, recipe.result.count, recipe.result.metadata)
         window.updateSlot(0, item)
-        // move the result to inventory
         await bot.putAway(0)
         await updateOutShape()
       }
@@ -131,28 +131,20 @@ function inject (bot, { version }) {
           return
         }
         const slotsToClick = []
-        let x
-        let y
-        let row
-        let item
-        let theSlot
-        for (y = 0; y < recipe.outShape.length; ++y) {
-          row = recipe.outShape[y]
-          for (x = 0; x < row.length; ++x) {
-            theSlot = slot(x, y)
+        for (let y = 0; y < recipe.outShape.length; ++y) {
+          const row = recipe.outShape[y]
+          for (let x = 0; x < row.length; ++x) {
+            const _slot = slot(x, y)
+            let item = null
             if (row[x].id !== -1) {
               item = new Item(row[x].id, row[x].count, row[x].metadata || null)
-              slotsToClick.push(theSlot)
-            } else {
-              item = null
+              slotsToClick.push(_slot)
             }
-            window.updateSlot(theSlot, item)
+            window.updateSlot(_slot, item)
           }
         }
-        theSlot = slotsToClick.pop()
-        while (theSlot) {
-          await bot.putAway(theSlot)
-          theSlot = slotsToClick.pop()
+        for (const _slot of slotsToClick) {
+          await bot.putAway(_slot)
         }
         closeTheWindow()
       }

package/lib/plugins/creative.js

@@ -1,5 +1,5 @@
 const assert = require('assert')
-const Vec3 = require('vec3').Vec3
+const { Vec3 } = require('vec3')
 const { callbackify, sleep } = require('../promise_utils')
 const { once } = require('events')
 
@@ -23,7 +23,7 @@ function inject (bot, { version }) {
     }
   })
 
-  // WARN: This method should not be called twice on the same slot before first callback exceeds
+  // WARN: This method should not be called twice on the same slot before first callback succeeds
   async function setInventorySlot (slot, item) {
     assert(slot >= 0 && slot <= 44)
 

package/lib/plugins/digging.js

@@ -1,4 +1,3 @@
-const nbt = require('prismarine-nbt')
 const { performance } = require('perf_hooks')
 const { createDoneTask, createTask } = require('../promise_utils')
 const BlockFaces = require('prismarine-world').iterators.BlockFace
@@ -179,12 +178,22 @@ function inject (bot) {
   function digTime (block) {
     let type = null
     let enchantments = []
-    if (bot.heldItem) {
-      type = bot.heldItem.type
-      if (bot.heldItem.nbt) {
-        enchantments = nbt.simplify(bot.heldItem.nbt).Enchantments || nbt.simplify(bot.heldItem.nbt).ench
-      }
+
+    // Retrieve currently held item ID and active enchantments from heldItem
+    const currentlyHeldItem = bot.heldItem
+    if (currentlyHeldItem) {
+      type = currentlyHeldItem.type
+      enchantments = currentlyHeldItem.enchants
     }
+
+    // Append helmet enchantments (because Aqua Affinity actually affects dig speed)
+    const headEquipmentSlot = bot.getEquipmentDestSlot('head')
+    const headEquippedItem = bot.inventory.slots[headEquipmentSlot]
+    if (headEquippedItem) {
+      const helmetEnchantments = headEquippedItem.enchants
+      enchantments = enchantments.concat(helmetEnchantments)
+    }
+
     const creative = bot.game.gameMode === 'creative'
     return block.digTime(type, creative, bot.entity.isInWater, !bot.entity.onGround, enchantments, bot.entity.effects)
   }

package/lib/plugins/enchantment_table.js

@@ -48,8 +48,10 @@ function inject (bot) {
       }
 
       if (slots[0].level >= 0 && slots[1].level >= 0 && slots[2].level >= 0) {
-        if (!ready) enchantmentTable.emit('ready')
-        ready = true
+        if (!ready) {
+          ready = true
+          enchantmentTable.emit('ready')
+        }
       } else {
         ready = false
       }

package/lib/plugins/entities.js

@@ -1,4 +1,4 @@
-const Vec3 = require('vec3').Vec3
+const { Vec3 } = require('vec3')
 const Entity = require('prismarine-entity')
 const conv = require('../conversions')
 const NAMED_ENTITY_HEIGHT = 1.62
@@ -31,6 +31,11 @@ function inject (bot, { version }) {
   const entitiesArray = require('minecraft-data')(version).entitiesArray
   const Item = require('prismarine-item')(version)
   const ChatMessage = require('prismarine-chat')(version)
+  // ONLY 1.17 has this destroy_entity packet which is the same thing as entity_destroy packet except the entity is singular
+  // 1.17.1 reverted this change so this is just a simpler fix
+  bot._client.on('destroy_entity', (packet) => {
+    bot._client.emit('entity_destroy', { entityIds: [packet.entityId] })
+  })
 
   bot.findPlayer = bot.findPlayers = (filter) => {
     const filterFn = (entity) => {
@@ -478,15 +483,15 @@ function inject (bot, { version }) {
         } else if (packet.action === 3 && item.displayName) {
           player.displayName = new ChatMessage(JSON.parse(item.displayName))
         } else if (packet.action === 4) {
-          if (player.entity === bot.entity) return
+          if (player.entity === bot.entity) continue
 
           player.entity = null
           delete bot.players[player.username]
           delete bot.uuidToUsername[item.UUID]
           bot.emit('playerLeft', player)
-          return
+          continue
         } else {
-          return
+          continue
         }
 
         bot.emit('playerUpdated', player)
@@ -526,8 +531,8 @@ function inject (bot, { version }) {
   bot.useOn = useOn
   bot.moveVehicle = moveVehicle
 
-  function swingArm (arm = 'left', showHand = true) {
-    const hand = arm === 'left' ? 0 : 1
+  function swingArm (arm = 'right', showHand = true) {
+    const hand = arm === 'right' ? 0 : 1
     const packet = {}
     if (showHand) packet.hand = hand
     bot._client.write('arm_animation', packet)
@@ -539,11 +544,11 @@ function inject (bot, { version }) {
   }
 
   function attack (target, swing = true) {
-    useEntity(target, 1)
-
+    // arm animation comes before the use_entity packet
     if (swing) {
       swingArm()
     }
+    useEntity(target, 1)
   }
 
   function mount (target) {

package/lib/plugins/explosion.js

@@ -77,7 +77,7 @@ function inject (bot) {
     // The following modifiers are constant for the input targetEntity and doesnt depend
     // on the source position, so if the goal is to compare between positions they can be
     // ignored to save computations
-    if (!rawDamages) {
+    if (!rawDamages && targetEntity.attributes['generic.armor']) {
       const armor = getAttributeValue(targetEntity.attributes['generic.armor'])
       const armorToughness = getAttributeValue(targetEntity.attributes[armorThoughnessKey])
       damages = getDamageAfterAbsorb(damages, armor, armorToughness)
@@ -85,6 +85,8 @@ function inject (bot) {
       // TODO: protection enchantment and resistance effects
 
       if (targetEntity.type === 'player') damages *= difficultyValues[bot.game.difficulty] * 0.5
+    } else if (!rawDamages && !targetEntity.attributes['generic.armor']) {
+      return null
     }
     return Math.floor(damages)
   }

package/lib/plugins/fishing.js

@@ -27,13 +27,13 @@ function inject (bot) {
     if (!lastBobber || fishingTask.done) return
 
     const pos = lastBobber.position
-    if (packet.particleId === 4 && packet.particles === 6 && pos.distanceTo(new Vec3(packet.x, pos.y, packet.z)) <= 1.23) {
+    const parts = mcData.particlesByName
+    if (packet.particleId === (parts?.fishing ?? parts.bubble).id && packet.particles === 6 && pos.distanceTo(new Vec3(packet.x, pos.y, packet.z)) <= 1.23) {
       bot.activateItem()
       lastBobber = undefined
       fishingTask.finish()
     }
   })
-
   bot._client.on('entity_destroy', (packet) => {
     if (!lastBobber) return
     if (packet.entityIds.some(id => id === lastBobber.id)) {

package/lib/plugins/game.js

@@ -1,78 +1,82 @@
+const nbt = require('prismarine-nbt')
 module.exports = inject
 
+const difficultyNames = ['peaceful', 'easy', 'normal', 'hard']
+const gameModes = ['survival', 'creative', 'adventure']
+
 const dimensionNames = {
   '-1': 'minecraft:nether',
   0: 'minecraft:overworld',
   1: 'minecraft:end'
 }
 
-const difficultyNames = ['peaceful', 'easy', 'normal', 'hard']
-
-function inject (bot) {
-  bot.game = {}
-
-  bot._client.on('custom_payload', (packet) => {
-    if (packet.channel === 'minecraft:brand') {
-      bot.game.serverBrand = String.fromCharCode.apply(null, packet.data)
-      bot.emit('game')
-    }
-  })
+const parseGameMode = gameModeBits => gameModes[(gameModeBits & 0b11)] // lower two bits
 
-  bot._client.on('game_state_change', (packet) => {
-    if (packet?.reason === 4 && packet?.gameMode === 1) {
-      bot._client.write('client_command', { action: 0 })
+function inject (bot, options) {
+  function getBrandCustomChannelName () {
+    if (bot.supportFeature('customChannelMCPrefixed')) {
+      return 'MC|Brand'
+    } else if (bot.supportFeature('customChannelIdentifier')) {
+      return 'minecraft:brand'
     }
-  })
+    throw new Error('Unsupported brand channel name')
+  }
 
-  bot._client.on('login', (packet) => {
-    bot.game.levelType = (packet.levelType ? packet.levelType : (packet.isFlat ? 'flat' : 'default'))
+  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)
-    bot.game.hardcore = parseHardcore(packet.gameMode)
     if (bot.supportFeature('dimensionIsAnInt')) {
       bot.game.dimension = dimensionNames[packet.dimension]
     } else if (bot.supportFeature('dimensionIsAString')) {
       bot.game.dimension = packet.dimension
     } else if (bot.supportFeature('dimensionIsAWorld')) {
       bot.game.dimension = packet.worldName
+    } else {
+      throw new Error('Unsupported dimension type in login packet')
+    }
+
+    if (bot.supportFeature('dimensionDataIsAvailable')) {
+      bot.game.dimensionData = nbt.simplify(packet.dimension)
+    }
+    if (packet.difficulty) {
+      bot.game.difficulty = difficultyNames[packet.difficulty]
+    }
+  }
+
+  bot.game = {}
+
+  const brandChannel = getBrandCustomChannelName()
+  bot._client.registerChannel(brandChannel, ['string', []])
+
+  bot._client.on('login', (packet) => {
+    handleRespawnPacketData(packet)
+
+    bot.game.maxPlayers = packet.maxPlayers
+    if (packet.enableRespawnScreen) {
+      bot.game.enableRespawnScreen = packet.enableRespawnScreen
     }
     if (packet.viewDistance) {
       bot.game.serverViewDistance = packet.viewDistance
     }
-    bot.game.difficulty = packet.difficulty ? difficultyNames[packet.difficulty] : bot.game.difficulty
-    bot.game.maxPlayers = packet.maxPlayers
+
     bot.emit('login')
     bot.emit('game')
     bot._client.write('held_item_slot', { slotId: 0 })
-    let channel
-    if (bot.supportFeature('customChannelMCPrefixed')) {
-      channel = 'MC|Brand'
-    } else if (bot.supportFeature('customChannelNotPrefixed')) {
-      channel = 'brand'
-    }
-    bot._client.write('custom_payload', {
-      channel,
-      data: Buffer.from('\x07vanilla')
-    }) // varint length-prefixed string TODO: encode varint, see GH-253
 
-    // autoRespawn(bot);
+    // varint length-prefixed string as data
+    bot._client.writeChannel(brandChannel, options.brand)
   })
 
   bot._client.on('respawn', (packet) => {
-    bot.game.levelType = packet.levelType
-    if (bot.supportFeature('dimensionIsAnInt')) {
-      bot.game.dimension = dimensionNames[packet.dimension]
-    } else if (bot.supportFeature('dimensionIsAString')) {
-      bot.game.dimension = packet.dimension
-    } else if (bot.supportFeature('dimensionIsAWorld')) {
-      bot.game.dimension = packet.worldName
-    }
-    bot.game.difficulty = difficultyNames[packet.difficulty]
-    bot.game.gameMode = parseGameMode(packet.gamemode)
-    bot.game.hardcore = parseHardcore(packet.gamemode)
+    handleRespawnPacketData(packet)
     bot.emit('game')
   })
 
   bot._client.on('game_state_change', (packet) => {
+    if (packet?.reason === 4 && packet?.gameMode === 1) {
+      bot._client.write('client_command', { action: 0 })
+    }
     if (packet.reason === 3) {
       bot.game.gameMode = parseGameMode(packet.gameMode)
       bot.emit('game')
@@ -82,14 +86,15 @@ function inject (bot) {
   bot._client.on('difficulty', (packet) => {
     bot.game.difficulty = difficultyNames[packet.difficulty]
   })
-}
-
-const gameModes = ['survival', 'creative', 'adventure']
 
-function parseGameMode (gameModeBits) {
-  return gameModes[(gameModeBits & 0x03)]
-}
+  bot._client.on(brandChannel, (serverBrand) => {
+    bot.game.serverBrand = serverBrand
+  })
 
-function parseHardcore (gameModeBits) {
-  return !!(gameModeBits & 0x04)
+  // mimic the vanilla 1.17 client to prevent anticheat kicks
+  bot._client.on('ping', (data) => {
+    bot._client.write('pong', {
+      id: data.id
+    })
+  })
 }