mineflayer 4.0.0 → 4.3.0

package/lib/plugins/creative.js

@@ -1,32 +1,30 @@
 const assert = require('assert')
 const { Vec3 } = require('vec3')
-const { sleep } = require('../promise_utils')
+const { sleep, onceWithCleanup } = require('../promise_utils')
 const { once } = require('events')
 
 module.exports = inject
 
-function inject (bot, { version }) {
-  const Item = require('prismarine-item')(version)
+function inject (bot) {
+  const Item = require('prismarine-item')(bot.version)
 
   // these features only work when you are in creative mode.
   bot.creative = {
-    setInventorySlot: setInventorySlot,
+    setInventorySlot,
     flyTo: flyTo,
     startFlying,
-    stopFlying
+    stopFlying,
+    clearSlot: slotNum => setInventorySlot(slotNum, null),
+    clearInventory
   }
 
   const creativeSlotsUpdates = []
-  bot._client.on('set_slot', ({ windowId, slot, item }) => {
-    if (windowId === 0 && creativeSlotsUpdates[slot]) {
-      bot.emit(`set_creative_slot_${slot}`)
-    }
-  })
 
   // WARN: This method should not be called twice on the same slot before first promise succeeds
   async function setInventorySlot (slot, item) {
     assert(slot >= 0 && slot <= 44)
 
+    if (Item.equal(bot.inventory.slots[slot], item, true)) return
     if (creativeSlotsUpdates[slot]) {
       throw new Error(`Setting slot ${slot} cancelled due to calling bot.creative.setInventorySlot(${slot}, ...) again`)
     }
@@ -37,10 +35,14 @@ function inject (bot, { version }) {
       item: Item.toNotch(item)
     })
 
-    await once(bot, `set_creative_slot_${slot}`)
+    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 })
     creativeSlotsUpdates[slot] = false
   }
 
+  async function clearInventory () {
+    return Promise.all(bot.inventory.slots.filter(item => item).map(item => setInventorySlot(item.slot, null)))
+  }
+
   let normalGravity = null
   const flyingSpeedPerUpdate = 0.5
 

package/lib/plugins/entities.js

@@ -24,13 +24,12 @@ const entityStatusEvents = {
   10: 'entityEatingGrass'
 }
 
-function inject (bot, { version }) {
-  const Entity = require('prismarine-entity')(version)
-  const objects = require('minecraft-data')(version).objects
-  const mobs = require('minecraft-data')(version).mobs
-  const entitiesArray = require('minecraft-data')(version).entitiesArray
-  const Item = require('prismarine-item')(version)
-  const ChatMessage = require('prismarine-chat')(version)
+function inject (bot) {
+  const { objects, mobs, entitiesArray } = bot.registry
+  const Entity = require('prismarine-entity')(bot.version) // TODO: update for prismarine-registry
+  const Item = require('prismarine-item')(bot.version)
+  const ChatMessage = require('prismarine-chat')(bot.version) // TODO: update for prismarine-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
   bot._client.on('destroy_entity', (packet) => {

package/lib/plugins/fishing.js

@@ -4,14 +4,12 @@ const { createDoneTask, createTask } = require('../promise_utils')
 module.exports = inject
 
 function inject (bot) {
-  const mcData = require('minecraft-data')(bot.version)
-
   let bobberId = 90
   // Before 1.14 the bobber entity keep changing name at each version (but the id stays 90)
   // 1.14 changes the id, but hopefully we can stick with the name: fishing_bobber
   // the alternative would be to rename it in all version of mcData
   if (bot.supportFeature('fishingBobberCorrectlyNamed')) {
-    bobberId = mcData.entitiesByName.fishing_bobber.id
+    bobberId = bot.registry.entitiesByName.fishing_bobber.id
   }
 
   let fishingTask = createDoneTask()
@@ -27,7 +25,7 @@ function inject (bot) {
     if (!lastBobber || fishingTask.done) return
 
     const pos = lastBobber.position
-    const parts = mcData.particlesByName
+    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) {
       bot.activateItem()
       lastBobber = undefined

package/lib/plugins/game.js

@@ -67,10 +67,13 @@ function inject (bot, options) {
 
     bot.emit('login')
     bot.emit('game')
-    bot._client.write('held_item_slot', { slotId: 0 })
 
     // 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

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

package/lib/plugins/inventory.js

@@ -20,10 +20,9 @@ const ALWAYS_CONSUMABLES = [
   'golden_apple'
 ]
 
-function inject (bot, { version, hideErrors }) {
-  const Item = require('prismarine-item')(version)
-  const windows = require('prismarine-windows')(version)
-  const mcData = require('minecraft-data')(version)
+function inject (bot, { hideErrors }) {
+  const Item = require('prismarine-item')(bot.version)
+  const windows = require('prismarine-windows')(bot.version) // TODO: update for prismarine-registry
 
   let eatingTask = createDoneTask()
 
@@ -251,7 +250,7 @@ function inject (bot, { version, hideErrors }) {
         (nbt != null && window.selectedItem.nbt !== nbt)) {
         // we are not holding the item we need. click it.
         const sourceItem = window.findItemRange(sourceStart, sourceEnd, itemType, metadata, false, nbt)
-        const mcDataEntry = mcData.itemsArray.find(x => x.id === itemType)
+        const mcDataEntry = bot.registry.itemsArray.find(x => x.id === itemType)
         assert(mcDataEntry, 'Invalid itemType')
         if (!sourceItem) throw new Error(`Can't find ${mcDataEntry.name} in slots [${sourceStart} - ${sourceEnd}], (item id: ${itemType})`)
         if (firstSourceSlot === null) firstSourceSlot = sourceItem.slot
@@ -303,19 +302,20 @@ function inject (bot, { version, hideErrors }) {
 
   function extendWindow (window) {
     window.close = () => {
-      window.emit('close')
       closeWindow(window)
+      window.emit('close')
     }
-    window.withdraw = async (itemType, metadata, count) => {
+
+    window.withdraw = async (itemType, metadata, count, nbt) => {
       if (bot.inventory.emptySlotCount() === 0) {
         throw new Error('Unable to withdraw, Bot inventory is full.')
       }
-
       const options = {
         window,
         itemType,
         metadata,
         count,
+        nbt,
         sourceStart: 0,
         sourceEnd: window.inventoryStart,
         destStart: window.inventoryStart,
@@ -323,12 +323,13 @@ function inject (bot, { version, hideErrors }) {
       }
       await transfer(options)
     }
-    window.deposit = async (itemType, metadata, count) => {
+    window.deposit = async (itemType, metadata, count, nbt) => {
       const options = {
         window: window,
         itemType,
         metadata,
         count,
+        nbt,
         sourceStart: window.inventoryStart,
         sourceEnd: window.inventoryEnd,
         destStart: 0,
@@ -380,7 +381,7 @@ function inject (bot, { version, hideErrors }) {
       if (item) {
         item.slot = slot
       }
-      bot.inventory.slots[slot] = item
+      if (!Item.equal(bot.inventory.slots[slot], item, true)) bot.inventory.updateSlot(slot, item)
     }
   }
 
@@ -437,9 +438,6 @@ function inject (bot, { version, hideErrors }) {
         accepted: true
         // bot.emit(`confirmTransaction${click.id}`, false)
       })
-      if (!hideErrors) {
-        console.log(`WARNING : unknown transaction confirmation for window ${windowId}, action ${actionId} and accepted ${accepted}`)
-      }
       return
     }
     // shift it later if packets are sent out of order

package/lib/plugins/physics.js

@@ -15,10 +15,10 @@ const PHYSICS_INTERVAL_MS = 50
 const PHYSICS_TIMESTEP = PHYSICS_INTERVAL_MS / 1000
 
 function inject (bot, { physicsEnabled }) {
-  const mcData = require('minecraft-data')(bot.version)
-
   const world = { getBlock: (pos) => { return bot.blockAt(pos, false) } }
-  const physics = Physics(mcData, world)
+  const physics = Physics(bot.registry, world)
+
+  const positionUpdateSentEveryTick = bot.supportFeature('positionUpdateSentEveryTick')
 
   bot.jumpQueued = false
   bot.jumpTicks = 0 // autojump cooldown
@@ -150,7 +150,7 @@ function inject (bot, { physicsEnabled }) {
       // Send a position packet every second, even if no update was made
       sendPacketPosition(position, onGround)
       lastSent.time = performance.now()
-    } else if (bot.supportFeature('positionUpdateSentEveryTick') && bot.isAlive) {
+    } else if (positionUpdateSentEveryTick && bot.isAlive) {
       // For versions < 1.12, one player packet should be sent every tick
       // for the server to update health correctly
       bot._client.write('flying', { onGround: bot.entity.onGround })

package/lib/plugins/place_entity.js

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

package/lib/plugins/settings.js

@@ -23,13 +23,27 @@ const viewDistanceToBits = {
 function inject (bot, options) {
   function setSettings (settings) {
     extend(bot.settings, settings)
+
+    // chat
     const chatBits = chatToBits[bot.settings.chat]
     assert.ok(chatBits != null, `invalid chat setting: ${bot.settings.chat}`)
-    const viewDistanceBits = viewDistanceToBits[bot.settings.viewDistance]
+
+    // view distance
+    let viewDistanceBits = null
+    if (typeof bot.settings.viewDistance === 'string') {
+      viewDistanceBits = viewDistanceToBits[bot.settings.viewDistance]
+    } else if (typeof bot.settings.viewDistance === 'number' && bot.settings.viewDistance > 0) { // Make sure view distance is a valid # || should be 2 or more
+      viewDistanceBits = bot.settings.viewDistance
+    }
     assert.ok(viewDistanceBits != null, `invalid view distance setting: ${bot.settings.viewDistance}`)
+
+    // hand
     const handBits = handToBits[bot.settings.mainHand]
     assert.ok(handBits != null, `invalid main hand: ${bot.settings.mainHand}`)
-    bot.settings.showCape = !!bot.settings.showCape
+
+    // skin
+    // cape is inverted, not used at all (legacy?)
+    // bot.settings.showCape = !!bot.settings.showCape
     const skinParts = bot.settings.skinParts.showCape << 0 |
           bot.settings.skinParts.showJacket << 1 |
           bot.settings.skinParts.showLeftSleeve << 2 |
@@ -37,13 +51,17 @@ function inject (bot, options) {
           bot.settings.skinParts.showLeftPants << 4 |
           bot.settings.skinParts.showRightPants << 5 |
           bot.settings.skinParts.showHat << 6
+
+    // write the packet
     bot._client.write('settings', {
       locale: bot.settings.locale || 'en_US',
       viewDistance: viewDistanceBits,
       chatFlags: chatBits,
       chatColors: bot.settings.colorsEnabled,
       skinParts: skinParts,
-      mainHand: handBits
+      mainHand: handBits,
+      enableTextFiltering: bot.settings.enableTextFiltering,
+      enableServerListing: bot.settings.enableServerListing
     })
   }
 
@@ -67,10 +85,12 @@ function inject (bot, options) {
           showHat: true
         }
       : options.skinParts,
-    mainHand: options.mainHand || 'right'
+    mainHand: options.mainHand || 'right',
+    enableTextFiltering: options.enableTextFiltering || false,
+    enableServerListing: options.enableServerListing || true
   }
 
-  bot._client.once('login', () => {
+  bot._client.on('login', () => {
     setSettings({})
   })
 

package/lib/plugins/tablist.js

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

package/lib/plugins/team.js

@@ -29,8 +29,11 @@ function inject (bot) {
     }
     if (team !== undefined) {
       if (mode === 1) {
-        bot.emit('teamRemoved', teams[teamName])
+        team.members.forEach(member => {
+          delete bot.teamMap[member]
+        })
         delete teams[teamName]
+        bot.emit('teamRemoved', teams[teamName])
       }
       if (mode === 2) {
         team.update(

package/lib/plugins/villager.js

@@ -4,8 +4,8 @@ const { once } = require('events')
 module.exports = inject
 
 function inject (bot, { version }) {
-  const mcData = require('minecraft-data')(version)
-  const Item = require('prismarine-item')(version)
+  const { entitiesByName } = bot.registry
+  const Item = require('prismarine-item')(bot.version)
 
   let selectTrade
   if (bot.supportFeature('useMCTrSel')) {
@@ -70,7 +70,7 @@ function inject (bot, { version }) {
   }
 
   async function openVillager (villagerEntity) {
-    const villagerType = mcData.entitiesByName.villager ? mcData.entitiesByName.villager.id : mcData.entitiesByName.Villager.id
+    const villagerType = entitiesByName.villager ? entitiesByName.villager.id : entitiesByName.Villager.id
     assert.strictEqual(villagerEntity.entityType, villagerType)
     let ready = false
 

package/lib/scoreboard.js

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

package/lib/team.js

@@ -3,8 +3,8 @@ let MessageBuilder
 
 module.exports = loader
 
-function loader (mcVersion) {
-  ChatMessage = require('prismarine-chat')(mcVersion)
+function loader (version) {
+  ChatMessage = require('prismarine-chat')(version) // TODO: update for prismarine-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.1']
+  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']
 } // when updating testedVersions, make sure to update CI.yml

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mineflayer",
-  "version": "4.0.0",
+  "version": "4.3.0",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",
@@ -21,17 +21,18 @@
   },
   "license": "MIT",
   "dependencies": {
-    "minecraft-data": "^2.109.0",
-    "minecraft-protocol": "^1.26.5",
+    "minecraft-data": "^3.0.0",
+    "minecraft-protocol": "^1.31.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.0",
+    "prismarine-item": "^1.11.5",
     "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-world": "^3.6.0",
     "protodef": "^1.14.0",