mineflayer 3.14.1 → 3.18.0

package/lib/features.json

@@ -7,7 +7,7 @@
   {
     "name": "spawner",
     "description": "spawner is called spawner",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "blockMetadata",
@@ -17,12 +17,12 @@
   {
     "name": "blockStateId",
     "description": "block metadata is encoded as state id",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "creativeSleepNearMobs",
     "description": "can sleep near mobs in creative",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "fixedPointPosition",
@@ -32,7 +32,7 @@
   {
     "name": "doublePosition",
     "description": "Entity positions are represented with double",
-    "versions": ["1.9", "1.17.1"]
+    "versions": ["1.9", "1.18.1"]
   },
   {
     "name": "fixedPointDelta",
@@ -42,7 +42,7 @@
   {
     "name": "fixedPointDelta128",
     "description": "Delta of position are represented with fixed point numbers times 128",
-    "versions": ["1.9", "1.17.1"]
+    "versions": ["1.9", "1.18.1"]
   },
   {
     "name": "customChannelMCPrefixed",
@@ -52,12 +52,12 @@
   {
     "name": "customChannelIdentifier",
     "description": "custom channel is an identifier starting in minecraft namespace",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "dimensionDataIsAvailable",
     "description": "dimensionData is available, providing an additional information about the current dimension",
-    "versions": ["1.17", "1.17.1"]
+    "versions": ["1.17", "1.18.1"]
   },
   {
     "name": "useItemWithBlockPlace",
@@ -67,7 +67,7 @@
   {
     "name": "useItemWithOwnPacket",
     "description": "use item is done with its own packet",
-    "versions": ["1.9", "1.17.1"]
+    "versions": ["1.9", "1.18.1"]
   },
   {
     "name": "blockPlaceHasHeldItem",
@@ -87,7 +87,7 @@
   {
     "name": "blockPlaceHasInsideBlock",
     "description": "block_place packet has inside block",
-    "versions": ["1.14", "1.17.1"]
+    "versions": ["1.14", "1.18.1"]
   },
   {
     "name": "teleportUsesPositionPacket",
@@ -102,7 +102,7 @@
   {
     "name": "teleportUsesOwnPacket",
     "description": "teleport is done using its own packet",
-    "versions": ["1.9", "1.17.1"]
+    "versions": ["1.9", "1.18.1"]
   },
   {
     "name": "oneBlockForSeveralVariations",
@@ -112,7 +112,7 @@
   {
     "name": "blockSchemeIsFlat",
     "description": "all variations of a packet have their own id",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "tabCompleteHasNoToolTip",
@@ -122,7 +122,7 @@
   {
     "name": "tabCompleteHasAToolTip",
     "description": "tab complete has a tool tip",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "effectAreMinecraftPrefixed",
@@ -132,7 +132,7 @@
   {
     "name": "effectAreNotPrefixed",
     "description": "effect are not prefixed",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "itemsAreAlsoBlocks",
@@ -142,12 +142,12 @@
   {
     "name": "itemsAreNotBlocks",
     "description": "items are not block",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "fishingBobberCorrectlyNamed",
     "description": "the fishing hook entity is named fishing_bobber",
-    "versions": ["1.14", "1.17.1"]
+    "versions": ["1.14", "1.18.1"]
   },
   {
     "name": "editBookIsPluginChannel",
@@ -157,7 +157,7 @@
   {
     "name": "hasEditBookPacket",
     "description": "book editing is handled through a packet",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "clientUpdateBookIdWhenSign",
@@ -197,12 +197,12 @@
   {
     "name": "dimensionIsAWorld",
     "description": "description is a world name (string)",
-    "versions": ["1.16.2", "1.17.1"]
+    "versions": ["1.16.2", "1.18.1"]
   },
   {
     "name": "dimensionDataIsAvailable",
     "description": "dimensionData is available, describing additional dimension information",
-    "versions": ["1.17", "1.17.1"]
+    "versions": ["1.17", "1.18.1"]
   },
   {
     "name": "doesntHaveChestType",
@@ -227,22 +227,22 @@
   {
     "name": "hasAttackCooldown",
     "description": "if there is a cooldown after attacks to deal full damage",
-    "versions": ["1.9", "1.17.1"]
+    "versions": ["1.9", "1.18.1"]
   },
   {
     "name": "usesLoginPacket",
     "description": "uses the login packet as defined in mcData",
-    "versions": ["1.16", "1.17.1"]
+    "versions": ["1.16", "1.18.1"]
   },
   {
     "name": "usesMultiblockSingleLong",
     "description": "in the multi_block_change packet is stored as a single number",
-    "versions": ["1.16.2", "1.17.1"]
+    "versions": ["1.16.2", "1.18.1"]
   },
   {
     "name": "usesMultiblock3DChunkCoords",
     "description": "in the multi_block_change packet, all 3 axis coords are defined",
-    "versions": ["1.16.2", "1.17.1"]
+    "versions": ["1.16.2", "1.18.1"]
   },
   {
     "name": "setBlockUsesMetadataNumber",
@@ -257,7 +257,7 @@
   {
     "name": "selectingTradeMovesItems",
     "description": "selecting a trade automatically puts the required items into trading slots",
-    "versions": ["1.14", "1.17.1"]
+    "versions": ["1.14", "1.18.1"]
   },
   {
     "name": "resourcePackUsesHash",
@@ -272,7 +272,7 @@
   {
     "name": "teamUsesChatComponents",
     "description": "teams use chatcomponents for formatting",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "teamUsesScoreboard",
@@ -287,7 +287,7 @@
   {
     "name": "enderCrystalNameNoCapsWithUnderscore",
     "description": "this is when the end_crystal's entity name is end_crystal",
-    "versions": ["1.14", "1.17.1"]
+    "versions": ["1.14", "1.18.1"]
   },
   {
     "name": "entityNameUpperCaseNoUnderscore",
@@ -307,7 +307,7 @@
   {
     "name": "stateIdUsed",
     "description": "starting in 1.17.1, actionId has been replaced with stateId",
-    "versions": ["1.17.1", "1.17.1"]
+    "versions": ["1.17.1", "1.18.1"]
   },
   {
     "name": "actionIdUsed",
@@ -317,11 +317,21 @@
   {
     "name": "setSlotAsTransaction",
     "description": "use setslot as transaction instead of just hoping it'll work",
-    "versions": ["1.17", "1.17.1"]
+    "versions": ["1.17", "1.18.1"]
   },
   {
     "name": "armAnimationBeforeUse",
     "description": "arm animation packet sent before use entity packet",
     "versions": ["1.8", "1.8.9"]
+  },
+  {
+    "name": "tallWorld",
+    "description": "world starts at -64 and ends at 384",
+    "versions": ["1.18", "1.18.1"]
+  },
+  {
+    "name": "sendStringifiedSignText",
+    "description": "sign text send when updating signs is send as stringified strings",
+    "versions": ["1.8", "1.8.9"]
   }
 ]

package/lib/loader.js

@@ -63,7 +63,7 @@ function createBot (options = {}) {
   options.username = options.username ?? 'Player'
   options.version = options.version ?? false
   options.plugins = options.plugins ?? {}
-  options.hideErrors = options.hideErrors ?? true
+  options.hideErrors = options.hideErrors ?? false
   options.logErrors = options.logErrors ?? true
   options.loadInternalPlugins = options.loadInternalPlugins ?? true
   options.client = options.client ?? null

package/lib/plugins/blocks.js

@@ -21,17 +21,12 @@ const dimensionNames = {
 }
 
 function inject (bot, { version, storageBuilder }) {
-  const nbt = require('prismarine-nbt')
   const Block = require('prismarine-block')(version)
   const Chunk = require('prismarine-chunk')(version)
-  const ChatMessage = require('prismarine-chat')(version)
   const World = require('prismarine-world')(version)
-  const signs = {}
   const paintingsByPos = {}
   const paintingsById = {}
 
-  const blockEntities = new Map()
-
   function addPainting (painting) {
     paintingsById[painting.id] = painting
     paintingsByPos[painting.position] = painting
@@ -42,41 +37,6 @@ function inject (bot, { version, storageBuilder }) {
     delete paintingsByPos[painting.position]
   }
 
-  function addBlockEntity (nbtData) {
-    const blockEntity = nbt.simplify(nbtData)
-    const pos = new Vec3(blockEntity.x, blockEntity.y, blockEntity.z).floored()
-    // Set raw nbt of blockEntity
-    blockEntity.raw = nbtData
-    // Handle signs
-    if (blockEntity.id === 'minecraft:sign' || blockEntity.id === 'Sign') {
-      const prepareJson = (i) => {
-        const data = blockEntity[`Text${i}`]
-
-        if (data === null || data === '') return ''
-
-        const json = JSON.parse(data)
-        if (json === null || !('text' in json)) return ''
-
-        json.text = json.text.replace(/^"|"$/g, '')
-        return json
-      }
-
-      blockEntity.Text1 = new ChatMessage(prepareJson(1))
-      blockEntity.Text2 = new ChatMessage(prepareJson(2))
-      blockEntity.Text3 = new ChatMessage(prepareJson(3))
-      blockEntity.Text4 = new ChatMessage(prepareJson(4))
-
-      signs[pos] = [
-        blockEntity.Text1.toString(),
-        blockEntity.Text2.toString(),
-        blockEntity.Text3.toString(),
-        blockEntity.Text4.toString()
-      ].join('\n')
-    }
-
-    blockEntities[pos] = blockEntity
-  }
-
   function delColumn (chunkX, chunkZ) {
     bot.world.unloadColumn(chunkX, chunkZ)
   }
@@ -90,11 +50,7 @@ function inject (bot, { version, storageBuilder }) {
     let column = bot.world.getColumn(args.x, args.z)
     if (!column) {
       // 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()
-      }
+      column = new Chunk({ minY: bot.game.minY, worldHeight: bot.game.height })
     }
 
     try {
@@ -102,6 +58,9 @@ function inject (bot, { version, storageBuilder }) {
       if (args.biomes !== undefined) {
         column.loadBiomes(args.biomes)
       }
+      if (args.skyLight !== undefined) {
+        column.loadParsedLight(args.skyLight, args.blockLight, args.skyLightMask, args.blockLightMask, args.emptySkyLightMask, args.emptyBlockLightMask)
+      }
       bot.world.setColumn(args.x, args.z, column)
     } catch (e) {
       bot.emit('error', e)
@@ -206,13 +165,17 @@ function inject (bot, { version, storageBuilder }) {
     let next = start
     while (next) {
       const column = bot.world.getColumn(next.x, next.z)
-      if (next.y >= 0 && next.y < 16 && column && !visitedSections.has(next.toString())) {
-        const section = column.sections[next.y]
+      const sectionY = next.y + Math.abs(bot.game.minY >> 4)
+      const totalSections = bot.game.height >> 4
+      if (sectionY >= 0 && sectionY < totalSections && column && !visitedSections.has(next.toString())) {
+        const section = column.sections[sectionY]
         if (useExtraInfo === true || isBlockInSection(section, matcher)) {
-          const cursor = new Vec3(0, 0, 0)
-          for (cursor.x = next.x * 16; cursor.x < next.x * 16 + 16; cursor.x++) {
-            for (cursor.y = next.y * 16; cursor.y < next.y * 16 + 16; cursor.y++) {
-              for (cursor.z = next.z * 16; cursor.z < next.z * 16 + 16; cursor.z++) {
+          const begin = new Vec3(next.x * 16, sectionY * 16 + bot.game.minY, next.z * 16)
+          const cursor = begin.clone()
+          const end = cursor.offset(16, 16, 16)
+          for (cursor.x = begin.x; cursor.x < end.x; cursor.x++) {
+            for (cursor.y = begin.y; cursor.y < end.y; cursor.y++) {
+              for (cursor.z = begin.z; cursor.z < end.z; cursor.z++) {
                 if (fullMatcher(cursor) && cursor.distanceTo(point) <= maxDistance) blocks.push(cursor.clone())
               }
             }
@@ -249,9 +212,7 @@ function inject (bot, { version, storageBuilder }) {
     if (!block) return null
 
     if (extraInfos) {
-      block.signText = signs[block.position]
       block.painting = paintingsByPos[block.position]
-      block.blockEntity = blockEntities[block.position]
     }
 
     return block
@@ -288,9 +249,6 @@ function inject (bot, { version, storageBuilder }) {
     }
     if (oldBlock.type !== newBlock.type) {
       const pos = point.floored()
-      delete blockEntities[pos]
-      delete signs[pos]
-
       const painting = paintingsByPos[pos]
       if (painting) deletePainting(painting)
     }
@@ -299,11 +257,7 @@ function inject (bot, { version, storageBuilder }) {
   bot._client.on('update_light', (packet) => {
     let column = bot.world.getColumn(packet.chunkX, packet.chunkZ)
     if (!column) {
-      if (bot.supportFeature('dimensionDataIsAvailable')) {
-        column = new Chunk({ minY: bot.game.dimensionData.min_y, worldHeight: bot.game.dimensionData.height })
-      } else {
-        column = new Chunk()
-      }
+      column = new Chunk({ minY: bot.game.minY, worldHeight: bot.game.height })
       bot.world.setColumn(packet.chunkX, packet.chunkZ, column)
     }
 
@@ -323,12 +277,25 @@ function inject (bot, { version, storageBuilder }) {
       biomes: packet.biomes,
       skyLightSent: bot.game.dimension === 'minecraft:overworld',
       groundUp: packet.groundUp,
-      data: packet.chunkData
+      data: packet.chunkData,
+      trustEdges: packet.trustEdges,
+      skyLightMask: packet.skyLightMask,
+      blockLightMask: packet.blockLightMask,
+      emptySkyLightMask: packet.emptySkyLightMask,
+      emptyBlockLightMask: packet.emptyBlockLightMask,
+      skyLight: packet.skyLight,
+      blockLight: packet.blockLight
     })
 
     if (typeof packet.blockEntities !== 'undefined') {
-      for (const nbtData of packet.blockEntities) {
-        addBlockEntity(nbtData)
+      const column = bot.world.getColumn(packet.x, packet.z)
+      for (const blockEntity of packet.blockEntities) {
+        if (blockEntity.x !== undefined) { // 1.17+
+          column.setBlockEntity(blockEntity, blockEntity.nbtData)
+        } else {
+          const pos = new Vec3(blockEntity.value.x.value & 0xf, blockEntity.value.y.value, blockEntity.value.z.value & 0xf)
+          column.setBlockEntity(pos, blockEntity)
+        }
       }
     }
   })
@@ -422,33 +389,34 @@ function inject (bot, { version, storageBuilder }) {
   })
 
   bot._client.on('update_sign', (packet) => {
-    const pos = new Vec3(packet.location.x, packet.location.y, packet.location.z)
-
-    const prepareString = (i) => {
-      let text = packet[`text${i}`]
-
-      if (text === 'null' || text === '') {
-        text = '""'
-      }
+    const pos = new Vec3(packet.location.x & 0xf, packet.location.y, packet.location.z & 0xf)
 
-      const json = JSON.parse(text)
-      if (json.text) {
-        json.text = json.text.replace(/^"|"$/g, '')
-      }
-
-      return new ChatMessage(json)
+    // TODO: warn if out of loaded world?
+    const column = bot.world.getColumn(packet.location.x >> 4, packet.location.z >> 4)
+    if (!column) {
+      return
     }
 
-    signs[pos] = [
-      prepareString(1),
-      prepareString(2),
-      prepareString(3),
-      prepareString(4)
-    ].join('\n')
+    const blockAt = column.getBlock(pos)
+
+    blockAt.signText = [packet.text1, packet.text2, packet.text3, packet.text4].map(text => {
+      if (text === 'null' || text === '') return ''
+      return JSON.parse(text)
+    })
+    column.setBlock(pos, blockAt)
   })
 
   bot._client.on('tile_entity_data', (packet) => {
-    addBlockEntity(packet.nbtData)
+    if (packet.location !== undefined) {
+      const column = bot.world.getColumn(packet.location.x >> 4, packet.location.z >> 4)
+      const pos = new Vec3(packet.location.x & 0xf, packet.location.y, packet.location.z & 0xf)
+      column.setBlockEntity(pos, packet.nbtData)
+    } else {
+      const tag = packet.nbtData
+      const column = bot.world.getColumn(tag.value.x.value >> 4, tag.value.z.value >> 4)
+      const pos = new Vec3(tag.value.x.value & 0xf, tag.value.y.value, tag.value.z.value & 0xf)
+      column.setBlockEntity(pos, tag)
+    }
   })
 
   bot.updateSign = (block, text) => {
@@ -464,12 +432,25 @@ function inject (bot, { version, storageBuilder }) {
       }
     }
 
+    let signData
+    if (bot.supportFeature('sendStringifiedSignText')) {
+      signData = {
+        text1: lines[0] ? JSON.stringify(lines[0]) : '""',
+        text2: lines[1] ? JSON.stringify(lines[1]) : '""',
+        text3: lines[2] ? JSON.stringify(lines[2]) : '""',
+        text4: lines[3] ? JSON.stringify(lines[3]) : '""'
+      }
+    } else {
+      signData = {
+        text1: lines[0] ?? '',
+        text2: lines[1] ?? '',
+        text3: lines[2] ?? '',
+        text4: lines[3] ?? ''
+      }
+    }
     bot._client.write('update_sign', {
       location: block.position,
-      text1: JSON.stringify(lines[0]),
-      text2: JSON.stringify(lines[1]),
-      text3: JSON.stringify(lines[2]),
-      text4: JSON.stringify(lines[3])
+      ...signData
     })
   }
 
@@ -567,7 +548,6 @@ function inject (bot, { version, storageBuilder }) {
   bot.canSeeBlock = canSeeBlock
   bot.blockAt = blockAt
   bot._updateBlockState = updateBlockState
-  bot._blockEntities = blockEntities
   bot.waitForChunksToLoad = callbackify(waitForChunksToLoad)
 }
 

package/lib/plugins/chat.js

@@ -1,4 +1,5 @@
 const { once } = require('events')
+const { printCallbackDepreciation } = require('../promise_utils')
 
 module.exports = inject
 
@@ -198,6 +199,16 @@ function callbackify (f) { // specifically for this function because cb isn't th
   return function (...args) {
     const cb = args[1]
     args.splice(1, 1)
-    return f(...args).then(r => { if (cb) { cb(undefined, r) } return r }, err => { if (cb) { cb(err) } else throw err })
+    return f(...args).then(r => {
+      if (cb) {
+        printCallbackDepreciation()
+        cb(undefined, r)
+      } return r
+    }, err => {
+      if (cb) {
+        printCallbackDepreciation()
+        cb(err)
+      } else throw err
+    })
   }
 }

package/lib/plugins/digging.js

@@ -1,5 +1,5 @@
 const { performance } = require('perf_hooks')
-const { createDoneTask, createTask } = require('../promise_utils')
+const { createDoneTask, createTask, printCallbackDepreciation } = require('../promise_utils')
 const BlockFaces = require('prismarine-world').iterators.BlockFace
 const { Vec3 } = require('vec3')
 
@@ -213,7 +213,17 @@ function callbackify (f) { // specifically for this function because cb could be
     else if (typeof args[1] === 'string') args[1] = args[1] === 'ignore' ? args[1] : false
     else args[1] = !!args[1] // coerce to boolean
 
-    return f(...args).then(r => { if (cb) { cb(undefined, r) } return r }, err => { if (cb) { cb(err) } else throw err })
+    return f(...args).then(r => {
+      if (cb) {
+        printCallbackDepreciation()
+        cb(undefined, r)
+      } return r
+    }, err => {
+      if (cb) {
+        printCallbackDepreciation()
+        cb(err)
+      } else throw err
+    })
   }
 }
 

package/lib/plugins/game.js

@@ -37,7 +37,12 @@ function inject (bot, options) {
     }
 
     if (bot.supportFeature('dimensionDataIsAvailable')) {
-      bot.game.dimensionData = nbt.simplify(packet.dimension)
+      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) {
       bot.game.difficulty = difficultyNames[packet.difficulty]

package/lib/promise_utils.js

@@ -1,10 +1,22 @@
+function printCallbackDepreciation () {
+  console.log('[depreciation notice] Callback are deprecated with mineflayer, use promise instead. They will be removed in version 4.0.0.')
+}
+
 function callbackify (f) {
   return function (...args) {
     const cb = args[f.length]
     return f(...args).then(r => {
-      if (cb) { cb(undefined, r) }
+      if (cb) {
+        printCallbackDepreciation()
+        cb(undefined, r)
+      }
       return r
-    }, err => { if (cb) { cb(err) } else throw err })
+    }, err => {
+      if (cb) {
+        printCallbackDepreciation()
+        cb(err)
+      } else throw err
+    })
   }
 }
 
@@ -97,5 +109,6 @@ module.exports = {
   createTask,
   createDoneTask,
   onceWithCleanup,
-  withTimeout
+  withTimeout,
+  printCallbackDepreciation
 }

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'],
-  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']
+  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']
 } // when updating testedVersions, make sure to update CI.yml

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mineflayer",
-  "version": "3.14.1",
+  "version": "3.18.0",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",
@@ -21,12 +21,12 @@
   },
   "license": "MIT",
   "dependencies": {
-    "minecraft-data": "^2.95.0",
+    "minecraft-data": "^2.109.0",
     "minecraft-protocol": "^1.26.5",
     "prismarine-biome": "^1.1.1",
-    "prismarine-block": "^1.10.3",
+    "prismarine-block": "^1.13.1",
     "prismarine-chat": "^1.3.3",
-    "prismarine-chunk": "^1.26.0",
+    "prismarine-chunk": "^1.29.0",
     "prismarine-entity": "^2.0.0",
     "prismarine-item": "^1.11.0",
     "prismarine-nbt": "^2.0.0",
@@ -35,7 +35,7 @@
     "prismarine-windows": "^2.4.2",
     "prismarine-world": "^3.6.0",
     "protodef": "^1.14.0",
-    "typed-emitter": "^1.3.1",
+    "typed-emitter": "^1.0.0",
     "vec3": "^0.1.7"
   },
   "devDependencies": {