mineflayer 4.3.0 → 4.5.0

package/lib/plugins/creative.js

@@ -6,12 +6,12 @@ const { once } = require('events')
 module.exports = inject
 
 function inject (bot) {
-  const Item = require('prismarine-item')(bot.version)
+  const Item = require('prismarine-item')(bot.registry)
 
   // these features only work when you are in creative mode.
   bot.creative = {
     setInventorySlot,
-    flyTo: flyTo,
+    flyTo,
     startFlying,
     stopFlying,
     clearSlot: slotNum => setInventorySlot(slotNum, null),

package/lib/plugins/entities.js

@@ -25,10 +25,10 @@ const entityStatusEvents = {
 }
 
 function inject (bot) {
-  const { objects, mobs, entitiesArray } = bot.registry
-  const Entity = require('prismarine-entity')(bot.version) // TODO: update for prismarine-registry
+  const { mobs, entitiesArray } = bot.registry
+  const Entity = require('prismarine-entity')(bot.version)
   const Item = require('prismarine-item')(bot.version)
-  const ChatMessage = require('prismarine-chat')(bot.version) // TODO: update for prismarine-registry
+  const ChatMessage = require('prismarine-chat')(bot.registry)
 
   // 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
@@ -69,6 +69,8 @@ function inject (bot) {
   bot.uuidToUsername = {}
   bot.entities = {}
 
+  bot._playerFromUUID = (uuid) => Object.values(bot.players).find(player => player.uuid === uuid)
+
   bot.nearestEntity = (match = (entity) => { return true }) => {
     let best = null
     let bestDistance = Number.MAX_VALUE
@@ -192,18 +194,20 @@ function inject (bot) {
     }
   }
 
+  // spawn object/vehicle on versions < 1.19, on versions > 1.19 handles all non-player entities
   bot._client.on('spawn_entity', (packet) => {
-    // spawn object/vehicle
     const entity = fetchEntity(packet.entityId)
-    const entityData = objects[packet.type]
+    const entityData = bot.registry.entities[packet.type]
 
-    entity.type = 'object'
+    entity.type = entityData.type || 'object'
     setEntityData(entity, packet.type, entityData)
 
     if (bot.supportFeature('fixedPointPosition')) {
       entity.position.set(packet.x / 32, packet.y / 32, packet.z / 32)
     } else if (bot.supportFeature('doublePosition')) {
       entity.position.set(packet.x, packet.y, packet.z)
+    } else if (bot.supportFeature('consolidatedEntitySpawnPacket')) {
+      entity.headPitch = conv.fromNotchianPitchByte(packet.headPitch)
     }
 
     entity.uuid = packet.objectUUID
@@ -230,6 +234,7 @@ function inject (bot) {
     bot.emit('entitySpawn', entity)
   })
 
+  // This packet is removed since 1.19 and merged into spawn_entity
   bot._client.on('spawn_entity_living', (packet) => {
     // spawn mob
     const entity = fetchEntity(packet.entityId)
@@ -450,7 +455,13 @@ function inject (bot) {
             username: item.name,
             ping: item.ping,
             uuid: item.UUID,
-            displayName: new ChatMessage({ text: '', extra: [{ text: item.name }] })
+            displayName: new ChatMessage({ text: '', extra: [{ text: item.name }] }),
+            profileKeys: item.crypto
+              ? {
+                  publicKey: item.crypto.publicKey, // DER-encoded public key
+                  signature: item.crypto.signature // Signature
+                }
+              : null
           }
 
           bot.uuidToUsername[item.UUID] = item.name
@@ -460,6 +471,12 @@ function inject (bot) {
           // Just an Update
           player.gamemode = item.gamemode
           player.ping = item.ping
+          if (item.crypto) {
+            player.profileKeys = {
+              publicKey: item.crypto.publicKey,
+              signature: item.crypto.signature
+            }
+          }
         }
 
         if (item.displayName) {
@@ -569,7 +586,7 @@ function inject (bot) {
   function moveVehicle (left, forward) {
     bot._client.write('steer_vehicle', {
       sideways: left,
-      forward: forward,
+      forward,
       jump: 0x01
     })
   }

package/lib/plugins/game.js

@@ -36,7 +36,20 @@ function inject (bot, options) {
       throw new Error('Unsupported dimension type in login packet')
     }
 
-    if (bot.supportFeature('dimensionDataIsAvailable')) {
+    if (packet.dimensionCodec) {
+      bot.registry.loadDimensionCodec(packet.dimensionCodec)
+    }
+
+    if (bot.supportFeature('dimensionDataInCodec')) { // 1.19+
+      if (packet.worldType) { // login
+        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:', '')
+      }
+    } else if (bot.supportFeature('dimensionDataIsAvailable')) { // 1.18
       const dimensionData = nbt.simplify(packet.dimension)
       bot.game.minY = dimensionData.min_y
       bot.game.height = dimensionData.height
@@ -70,10 +83,6 @@ function inject (bot, options) {
 
     // varint length-prefixed string as data
     bot._client.writeChannel(brandChannel, options.brand)
-
-    if (packet.dimensionCodec) {
-      bot.registry.loadDimensionCodec(packet.dimensionCodec)
-    }
   })
 
   bot._client.on('respawn', (packet) => {

package/lib/plugins/generic_place.js

@@ -2,7 +2,7 @@ const assert = require('assert')
 module.exports = inject
 
 function inject (bot) {
-  const Item = require('prismarine-item')(bot.version)
+  const Item = require('prismarine-item')(bot.registry)
   /**
    *
    * @param {import('prismarine-block').Block} referenceBlock

package/lib/plugins/inventory.js

@@ -21,8 +21,8 @@ const ALWAYS_CONSUMABLES = [
 ]
 
 function inject (bot, { hideErrors }) {
-  const Item = require('prismarine-item')(bot.version)
-  const windows = require('prismarine-windows')(bot.version) // TODO: update for prismarine-registry
+  const Item = require('prismarine-item')(bot.registry)
+  const windows = require('prismarine-windows')(bot.version)
 
   let eatingTask = createDoneTask()
 
@@ -150,45 +150,48 @@ function inject (bot, { hideErrors }) {
     }
   }
 
-  async function activateBlock (block) {
+  async function activateBlock (block, direction, cursorPos) {
+    direction = direction ?? new Vec3(0, 1, 0)
+    const directionNum = vectorToDirection(direction) // The packet needs a number as the direction
+    cursorPos = cursorPos ?? new Vec3(0.5, 0.5, 0.5)
     // TODO: tell the server that we are not sneaking while doing this
     await bot.lookAt(block.position.offset(0.5, 0.5, 0.5), false)
     // place block message
     if (bot.supportFeature('blockPlaceHasHeldItem')) {
       bot._client.write('block_place', {
         location: block.position,
-        direction: 1,
+        direction: directionNum,
         heldItem: Item.toNotch(bot.heldItem),
-        cursorX: 8,
-        cursorY: 8,
-        cursorZ: 8
+        cursorX: cursorPos.scaled(16).x,
+        cursorY: cursorPos.scaled(16).y,
+        cursorZ: cursorPos.scaled(16).z
       })
     } else if (bot.supportFeature('blockPlaceHasHandAndIntCursor')) {
       bot._client.write('block_place', {
         location: block.position,
-        direction: 1,
+        direction: directionNum,
         hand: 0,
-        cursorX: 8,
-        cursorY: 8,
-        cursorZ: 8
+        cursorX: cursorPos.scaled(16).x,
+        cursorY: cursorPos.scaled(16).y,
+        cursorZ: cursorPos.scaled(16).z
       })
     } else if (bot.supportFeature('blockPlaceHasHandAndFloatCursor')) {
       bot._client.write('block_place', {
         location: block.position,
-        direction: 1,
+        direction: directionNum,
         hand: 0,
-        cursorX: 0.5,
-        cursorY: 0.5,
-        cursorZ: 0.5
+        cursorX: cursorPos.x,
+        cursorY: cursorPos.y,
+        cursorZ: cursorPos.z
       })
     } else if (bot.supportFeature('blockPlaceHasInsideBlock')) {
       bot._client.write('block_place', {
         location: block.position,
-        direction: 1,
+        direction: directionNum,
         hand: 0,
-        cursorX: 0.5,
-        cursorY: 0.5,
-        cursorZ: 0.5,
+        cursorX: cursorPos.x,
+        cursorY: cursorPos.y,
+        cursorZ: cursorPos.z,
         insideBlock: false
       })
     }
@@ -325,7 +328,7 @@ function inject (bot, { hideErrors }) {
     }
     window.deposit = async (itemType, metadata, count, nbt) => {
       const options = {
-        window: window,
+        window,
         itemType,
         metadata,
         count,
@@ -339,8 +342,8 @@ function inject (bot, { hideErrors }) {
     }
   }
 
-  async function openBlock (block) {
-    bot.activateBlock(block)
+  async function openBlock (block, direction, cursorPos) {
+    bot.activateBlock(block, direction, cursorPos)
     const [window] = await once(bot, 'windowOpen')
     extendWindow(window)
     return window
@@ -433,7 +436,7 @@ function inject (bot, { hideErrors }) {
     if (click === undefined || !windowClickQueue.some(clicks => clicks.id === actionId)) {
       // mimic vanilla client and send a rejection for faulty transaction packets
       bot._client.write('transaction', {
-        windowId: windowId,
+        windowId,
         action: actionId,
         accepted: true
         // bot.emit(`confirmTransaction${click.id}`, false)
@@ -513,7 +516,7 @@ function inject (bot, { hideErrors }) {
         slot,
         mouseButton,
         mode,
-        changedSlots: changedSlots,
+        changedSlots,
         cursorItem: Item.toNotch(window.selectedItem)
       })
     } else if (bot.supportFeature('actionIdUsed')) { // <= 1.16.5
@@ -531,7 +534,7 @@ function inject (bot, { hideErrors }) {
         slot,
         mouseButton,
         mode,
-        changedSlots: changedSlots,
+        changedSlots,
         cursorItem: Item.toNotch(window.selectedItem)
       })
     }
@@ -641,6 +644,28 @@ function inject (bot, { hideErrors }) {
     bot.emit(`setWindowItems:${window.id}`)
   })
 
+  /**
+   * Convert a vector direction to minecraft packet number direction
+   * @param {Vec3} v
+   * @returns {number}
+   */
+  function vectorToDirection (v) {
+    if (v.y < 0) {
+      return 0
+    } else if (v.y > 0) {
+      return 1
+    } else if (v.z < 0) {
+      return 2
+    } else if (v.z > 0) {
+      return 3
+    } else if (v.x < 0) {
+      return 4
+    } else if (v.x > 0) {
+      return 5
+    }
+    assert.ok(false, `invalid direction vector ${v}`)
+  }
+
   bot.activateBlock = activateBlock
   bot.activateEntity = activateEntity
   bot.activateEntityAt = activateEntityAt

package/lib/plugins/place_entity.js

@@ -3,7 +3,7 @@ const assert = require('assert')
 module.exports = inject
 
 function inject (bot) {
-  const Item = require('prismarine-item')(bot.version)
+  const Item = require('prismarine-item')(bot.registry)
 
   /**
    *

package/lib/plugins/ray_trace.js

@@ -1,4 +1,5 @@
 const { Vec3 } = require('vec3')
+const { RaycastIterator } = require('prismarine-world').iterators
 
 module.exports = (bot) => {
   function getViewDirection (pitch, yaw) {
@@ -24,6 +25,41 @@ module.exports = (bot) => {
     return bot.world.raycast(eyePosition, viewDirection, maxDistance, matcher)
   }
 
+  bot.entityAtCursor = (maxDistance = 3.5) => {
+    const block = bot.blockAtCursor(maxDistance)
+    maxDistance = block?.intersect.distanceTo(bot.entity.position) ?? maxDistance
+
+    const entities = Object.values(bot.entities)
+      .filter(entity => entity.type !== 'object' && entity.username !== bot.username && entity.position.distanceTo(bot.entity.position) <= maxDistance)
+
+    const dir = new Vec3(-Math.sin(bot.entity.yaw) * Math.cos(bot.entity.pitch), Math.sin(bot.entity.pitch), -Math.cos(bot.entity.yaw) * Math.cos(bot.entity.pitch))
+    const iterator = new RaycastIterator(bot.entity.position.offset(0, bot.entity.height, 0), dir.normalize(), maxDistance)
+
+    let targetEntity = null
+    let targetDist = maxDistance
+
+    for (let i = 0; i < entities.length; i++) {
+      const entity = entities[i]
+      const w = entity.width / 2
+
+      const shapes = [[-w, 0, -w, w, entity.height + (entity.type === 'player' ? 0.18 : 0), w]]
+      const intersect = iterator.intersect(shapes, entity.position)
+      if (intersect) {
+        const entityDir = entity.position.minus(bot.entity.position) // Can be combined into 1 line
+        const sign = Math.sign(entityDir.dot(dir))
+        if (sign !== -1) {
+          const dist = bot.entity.position.distanceTo(intersect.pos)
+          if (dist < targetDist) {
+            targetEntity = entity
+            targetDist = dist
+          }
+        }
+      }
+    }
+
+    return targetEntity
+  }
+
   bot.blockAtEntityCursor = (entity = bot.entity, maxDistance = 256, matcher = null) => {
     if (!entity.position || !entity.height || !entity.pitch || !entity.yaw) return null
     const { position, height, pitch, yaw } = entity

package/lib/plugins/settings.js

@@ -58,7 +58,7 @@ function inject (bot, options) {
       viewDistance: viewDistanceBits,
       chatFlags: chatBits,
       chatColors: bot.settings.colorsEnabled,
-      skinParts: skinParts,
+      skinParts,
       mainHand: handBits,
       enableTextFiltering: bot.settings.enableTextFiltering,
       enableServerListing: bot.settings.enableServerListing

package/lib/plugins/tablist.js

@@ -5,7 +5,7 @@ const escapeValueNewlines = str => {
 }
 
 function inject (bot) {
-  const ChatMessage = require('prismarine-chat')(bot.version) // TODO: update for prismarine-registry
+  const ChatMessage = require('prismarine-chat')(bot.registry)
 
   bot.tablist = {
     header: new ChatMessage(''),

package/lib/plugins/team.js

@@ -1,7 +1,7 @@
 module.exports = inject
 
 function inject (bot) {
-  const Team = require('../team')(bot.version)
+  const Team = require('../team')(bot.registry)
   const teams = {}
 
   function teamHandler (packet) {

package/lib/plugins/villager.js

@@ -5,7 +5,7 @@ module.exports = inject
 
 function inject (bot, { version }) {
   const { entitiesByName } = bot.registry
-  const Item = require('prismarine-item')(bot.version)
+  const Item = require('prismarine-item')(bot.registry)
 
   let selectTrade
   if (bot.supportFeature('useMCTrSel')) {
@@ -100,18 +100,20 @@ function inject (bot, { version }) {
       if (packet.windowId !== villager.id) return
       assert.ok(packet.trades)
       villager.trades = packet.trades.map(trade => {
-        Object.assign(trade, {
-          inputItem1: Item.fromNotch(trade.inputItem1 || { blockId: -1 }),
-          inputItem2: Item.fromNotch(trade.inputItem2 || { blockId: -1 }),
-          outputItem: Item.fromNotch(trade.outputItem || { blockId: -1 })
-        })
+        trade.inputs = [trade.inputItem1 = Item.fromNotch(trade.inputItem1 || { blockId: -1 })]
+        if (trade.inputItem2?.itemCount != null) {
+          trade.inputs.push(trade.inputItem2 = Item.fromNotch(trade.inputItem2 || { blockId: -1 }))
+        }
+
+        trade.hasItem2 = !!(trade.inputItem2 && trade.inputItem2.type && trade.inputItem2.count)
+        trade.outputs = [trade.outputItem = Item.fromNotch(trade.outputItem || { blockId: -1 })]
+
         if (trade.demand !== undefined && trade.specialPrice !== undefined) { // the price is affected by demand and reputation
           const demandDiff = Math.max(0, Math.floor(trade.inputItem1.count * trade.demand * trade.priceMultiplier))
           trade.realPrice = Math.min(Math.max((trade.inputItem1.count + trade.specialPrice + demandDiff), 1), trade.inputItem1.stackSize)
         } else {
           trade.realPrice = trade.inputItem1.count
         }
-        trade.hasItem2 = !!(trade.inputItem2 && trade.inputItem2.type && trade.inputItem2.count)
         return trade
       })
       if (!ready) {

package/lib/scoreboard.js

@@ -5,7 +5,7 @@ const sortItems = (a, b) => {
 }
 
 module.exports = (bot) => {
-  const ChatMessage = require('prismarine-chat')(bot.version) // TODO: update for prismarine-registry
+  const ChatMessage = require('prismarine-chat')(bot.registry)
 
   class ScoreBoard {
     constructor (packet) {

package/lib/team.js

@@ -3,8 +3,8 @@ let MessageBuilder
 
 module.exports = loader
 
-function loader (version) {
-  ChatMessage = require('prismarine-chat')(version) // TODO: update for prismarine-registry
+function loader (registry) {
+  ChatMessage = require('prismarine-chat')(registry)
   MessageBuilder = ChatMessage.MessageBuilder
   return Team
 }

package/lib/version.js

@@ -1,4 +1,4 @@
 module.exports = {
-  supportedVersions: ['1.8', '1.9', '1.10', '1.11', '1.12', '1.13', '1.14', '1.15', '1.16', '1.17', '1.18'],
-  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']
+  supportedVersions: ['1.8', '1.9', '1.10', '1.11', '1.12', '1.13', '1.14', '1.15', '1.16', '1.17', '1.18', '1.19'],
+  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']
 } // when updating testedVersions, make sure to update CI.yml

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mineflayer",
-  "version": "4.3.0",
+  "version": "4.5.0",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",
@@ -8,8 +8,8 @@
     "mocha_test": "mocha --reporter spec --exit",
     "test": "npm run mocha_test",
     "pretest": "npm run lint",
-    "lint": "standard && ts-standard *.d.ts && standard-markdown",
-    "fix": "standard --fix && ts-standard --fix *.d.ts && standard-markdown --fix",
+    "lint": "standard && standard-markdown",
+    "fix": "standard --fix && standard-markdown --fix",
     "prepublishOnly": "cp docs/README.md README.md"
   },
   "repository": {
@@ -21,33 +21,32 @@
   },
   "license": "MIT",
   "dependencies": {
-    "minecraft-data": "^3.0.0",
-    "minecraft-protocol": "^1.31.0",
+    "minecraft-data": "^3.15.2",
+    "minecraft-protocol": "^1.36.0",
     "prismarine-biome": "^1.1.1",
     "prismarine-block": "^1.13.1",
-    "prismarine-chat": "^1.3.3",
-    "prismarine-chunk": "^1.29.0",
-    "prismarine-entity": "^2.0.0",
-    "prismarine-item": "^1.11.5",
+    "prismarine-chat": "^1.7.1",
+    "prismarine-chunk": "^1.32.0",
+    "prismarine-entity": "^2.2.0",
+    "prismarine-item": "^1.12.1",
     "prismarine-nbt": "^2.0.0",
     "prismarine-physics": "^1.3.1",
-    "prismarine-recipe": "^1.1.0",
-    "prismarine-registry": "^1.0.0",
-    "prismarine-windows": "^2.4.2",
+    "prismarine-recipe": "^1.3.0",
+    "prismarine-registry": "^1.5.0",
+    "prismarine-windows": "^2.5.0",
     "prismarine-world": "^3.6.0",
     "protodef": "^1.14.0",
     "typed-emitter": "^1.0.0",
     "vec3": "^0.1.7"
   },
   "devDependencies": {
-    "@types/node": "^17.0.0",
+    "@types/node": "^18.0.6",
     "doctoc": "^2.0.1",
     "minecraft-wrap": "^1.3.0",
     "mineflayer": "file:.",
-    "mocha": "^9.1.2",
-    "standard": "^16.0.4",
+    "mocha": "^10.0.0",
+    "standard": "^17.0.0",
     "standard-markdown": "^7.1.0",
-    "ts-standard": "^11.0.0",
     "typescript": "^4.4.3"
   }
 }