mineflayer 3.13.0 → 3.15.0

package/examples/attack.js

@@ -0,0 +1,45 @@
+/*
+ *
+ * A bot that attacks the player that sends a message or the nearest entity (excluding players)
+ *
+ */
+const mineflayer = require('mineflayer')
+
+if (process.argv.length < 4 || process.argv.length > 6) {
+  console.log('Usage : node attack.js <host> <port> [<name>] [<password>]')
+  process.exit(1)
+}
+
+const bot = mineflayer.createBot({
+  host: process.argv[2],
+  port: parseInt(process.argv[3]),
+  username: process.argv[4] ? process.argv[4] : 'attack',
+  password: process.argv[5]
+})
+
+bot.on('spawn', () => {
+  bot.on('chat', (username, message) => {
+    if (message === 'attack me') attackPlayer(username)
+    else if (message === 'attack') attackEntity()
+  })
+})
+
+function attackPlayer (username) {
+  const player = bot.players[username]
+  if (!player || !player.entity) {
+    bot.chat('I can\'t see you')
+  } else {
+    bot.chat(`Attacking ${player.username}`)
+    bot.attack(player.entity)
+  }
+}
+
+function attackEntity () {
+  const entity = bot.nearestEntity()
+  if (!entity) {
+    bot.chat('No nearby entities')
+  } else {
+    bot.chat(`Attacking ${entity.name ?? entity.username}`)
+    bot.attack(entity)
+  }
+}

package/index.d.ts

@@ -201,7 +201,7 @@ export interface Bot extends TypedEmitter<BotEvents> {
   blockInSight: (maxSteps: number, vectorLength: number) => Block | null
 
   blockAtCursor: (maxDistance?: number, matcher?: Function) => Block | null
-  blockAtEntityCursor: (entity?: entity, maxDistance?: number, matcher?: Function) => Block | null
+  blockAtEntityCursor: (entity?: Entity, maxDistance?: number, matcher?: Function) => Block | null
 
   canSeeBlock: (block: Block) => boolean
 
@@ -343,6 +343,8 @@ export interface Bot extends TypedEmitter<BotEvents> {
     callback?: (err?: Error) => void
   ) => Promise<void>
 
+  openContainer: (chest: Block | Entity) => Promise<Chest | Furnace | Dispenser>
+
   openChest: (chest: Block | Entity) => Promise<Chest>
 
   openFurnace: (furnace: Block) => Promise<Furnace>
@@ -740,13 +742,18 @@ export class Villager extends (EventEmitter as new () => TypedEmitter<Conditiona
 }
 
 export interface VillagerTrade {
-  firstInput: Item
-  output: Item
-  hasSecondItem: boolean
-  secondaryInput: Item | null
-  disabled: boolean
-  tooluses: number
-  maxTradeuses: number
+  inputItem1: Item
+  outputItem: Item
+  inputItem2: Item | null
+  hasItem2: boolean
+  tradeDisabled: boolean
+  nbTradeUses: number
+  maximumNbTradeUses: number
+  xp?: number
+  specialPrice?: number
+  priceMultiplier?: number
+  demand?: number
+  realPrice?: number
 }
 
 export class ScoreBoard {

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,6 +317,16 @@
   {
     "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"]
   }
 ]

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

@@ -42,13 +42,15 @@ 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()
+  function addBlockEntity (nbtData, x, y, z, type) {
+    const blockEntity = nbtData === undefined ? {} : nbt.simplify(nbtData)
+    const pos = (x !== undefined ? new Vec3(x, y, z) : new Vec3(blockEntity.x, blockEntity.y, blockEntity.z)).floored()
     // Set raw nbt of blockEntity
     blockEntity.raw = nbtData
+    blockEntity.type = type
+    const signType = 7
     // Handle signs
-    if (blockEntity.id === 'minecraft:sign' || blockEntity.id === 'Sign') {
+    if (blockEntity.id === 'minecraft:sign' || blockEntity.id === 'Sign' || blockEntity.type === signType) {
       const prepareJson = (i) => {
         const data = blockEntity[`Text${i}`]
 
@@ -90,11 +92,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 +100,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 +207,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())
               }
             }
@@ -299,11 +304,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 +324,23 @@ 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)
+      for (const blockEntity of packet.blockEntities) {
+        if (blockEntity.x !== undefined) {
+          addBlockEntity(blockEntity.nbtData, blockEntity.x, blockEntity.y, blockEntity.z, blockEntity.type)
+        } else {
+          addBlockEntity(blockEntity)
+        }
       }
     }
   })
@@ -448,7 +460,11 @@ function inject (bot, { version, storageBuilder }) {
   })
 
   bot._client.on('tile_entity_data', (packet) => {
-    addBlockEntity(packet.nbtData)
+    if (packet.location !== undefined) {
+      addBlockEntity(packet.nbtData, packet.location.x, packet.location.y, packet.location.z, packet.action)
+    } else {
+      addBlockEntity(packet.nbtData)
+    }
   })
 
   bot.updateSign = (block, text) => {

package/lib/plugins/entities.js

@@ -1,5 +1,4 @@
 const { Vec3 } = require('vec3')
-const Entity = require('prismarine-entity')
 const conv = require('../conversions')
 const NAMED_ENTITY_HEIGHT = 1.62
 const NAMED_ENTITY_WIDTH = 0.6
@@ -26,6 +25,7 @@ const entityStatusEvents = {
 }
 
 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
@@ -548,11 +548,18 @@ function inject (bot, { version }) {
   }
 
   function attack (target, swing = true) {
-    // arm animation comes before the use_entity packet
-    if (swing) {
-      swingArm()
+    // arm animation comes before the use_entity packet on 1.8
+    if (bot.supportFeature('armAnimationBeforeUse')) {
+      if (swing) {
+        swingArm()
+      }
+      useEntity(target, 1)
+    } else {
+      useEntity(target, 1)
+      if (swing) {
+        swingArm()
+      }
     }
-    useEntity(target, 1)
   }
 
   function mount (target) {

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/plugins/physics.js

@@ -240,6 +240,7 @@ function inject (bot, { physicsEnabled }) {
 
     if (force) {
       lastSentYaw = yaw
+      lastSentPitch = pitch
       return
     }
 

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.13.0",
+  "version": "3.15.0",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",
@@ -21,13 +21,13 @@
   },
   "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-chat": "^1.3.3",
-    "prismarine-chunk": "^1.26.0",
-    "prismarine-entity": "^1.2.0",
+    "prismarine-chunk": "^1.28.1",
+    "prismarine-entity": "^2.0.0",
     "prismarine-item": "^1.11.0",
     "prismarine-nbt": "^2.0.0",
     "prismarine-physics": "^1.3.1",
@@ -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": "^2.0.0",
     "vec3": "^0.1.7"
   },
   "devDependencies": {