mineflayer 4.10.0 → 4.11.0

package/.github/workflows/commands.yml

@@ -0,0 +1,22 @@
+name: Repo Commands
+
+on:
+  issue_comment:        # Handle comment commands
+    types: [created]
+  pull_request:         # Handle renamed PRs
+    types: [edited]
+
+jobs:
+  comment-trigger:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v3
+    - name: Run command handlers
+      uses: PrismarineJS/prismarine-repo-actions@master
+      with:
+        # NOTE: You must specify a Personal Access Token (PAT) with repo access here. While you can use the default GITHUB_TOKEN, actions taken with it will not trigger other actions, so if you have a CI workflow, commits created by this action will not trigger it.
+        token: ${{ secrets.PAT_PASSWORD }}
+        # See `Options` section below for more info on these options
+        install-command: npm install
+        /fixlint.fix-command: npm run fix

package/README.md

@@ -17,7 +17,7 @@ First time using Node.js? You may want to start with the [tutorial](tutorial.md)
 
 ## Features
 
- * Supports Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18 and 1.19.
+ * Supports Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19 and 1.20.
  * Entity knowledge and tracking.
  * Block knowledge. You can query the world around you. Milliseconds to find any block.
  * Physics and movement - handle all bounding boxes

package/docs/README.md

@@ -17,7 +17,7 @@ First time using Node.js? You may want to start with the [tutorial](tutorial.md)
 
 ## Features
 
- * Supports Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18 and 1.19.
+ * Supports Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19 and 1.20.
  * Entity knowledge and tracking.
  * Block knowledge. You can query the world around you. Milliseconds to find any block.
  * Physics and movement - handle all bounding boxes

package/docs/api.md

@@ -187,6 +187,7 @@
       - ["entityTamed" (entity)](#entitytamed-entity)
       - ["entityShakingOffWater" (entity)](#entityshakingoffwater-entity)
       - ["entityEatingGrass" (entity)](#entityeatinggrass-entity)
+      - ["entityHandSwap" (entity)](#entityhandswap-entity)
       - ["entityWake" (entity)](#entitywake-entity)
       - ["entityEat" (entity)](#entityeat-entity)
       - ["entityCriticalEffect" (entity)](#entitycriticaleffect-entity)
@@ -1290,6 +1291,7 @@ Fires when an attribute of an entity changes.
 #### "entityTamed" (entity)
 #### "entityShakingOffWater" (entity)
 #### "entityEatingGrass" (entity)
+#### "entityHandSwap" (entity)
 #### "entityWake" (entity)
 #### "entityEat" (entity)
 #### "entityCriticalEffect" (entity)

package/docs/es/README_ES.md

@@ -17,7 +17,7 @@ Crea bots para Minecraft con una API de JavaScript potente, estable y de alto ni
 
 ## Características
 
- * Soporta Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18 y 1.19.
+ * Soporta Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19 y 1.20.
  * Rastreo e información de entidades.
  * Información sobre bloques. Puedes solicitar información de todo lo que te rodea. Encuentra bloques en milisegundos
  * Físicas y movimientos básicos - maneja todos los cuadros de colisión

package/docs/fr/README_FR.md

@@ -18,7 +18,7 @@ Si c'est la première fois que vous utilisez Node.js, il vaut mieux commencer av
 
 ## Caractéristiques:
 
- * Compatible avec Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15 et 1.16.
+ * Compatible avec Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19 et 1.20.
  * Reconnaissante et pistage des entités.
  * Identification des blocs. Vous pouvez passer en revue le monde autour de vous. Quelques millisecondes suffisent pour trouver n'importe quel bloc.
  * Information sur la physique et mouvements, données sur la taille des blocs...

package/docs/history.md

@@ -1,3 +1,21 @@
+## 4.11.0
+* [Import changedSlots computation from prismarine-windows (#3134)](https://github.com/PrismarineJS/mineflayer/commit/e5b5eeecf1133c1c80c0ef48d6e72fed77d84834) (thanks @kaduvert)
+* [Make the place block success check ignore block updates received with no block type changes (#3090)](https://github.com/PrismarineJS/mineflayer/commit/bbdd93afe2e31d1f1e899176e7edf8e73af5d5d3) (thanks @PondWader)
+* [Use node-minecraft-protocol for chat (#3110)](https://github.com/PrismarineJS/mineflayer/commit/385fba65ed6ebe632c870c7cf234666cacf5a766) (thanks @lkwilson)
+* [Extended useChests.js tests (#3132)](https://github.com/PrismarineJS/mineflayer/commit/131a7ea63c9c6b2cce41ebb29a26c898f859471d) (thanks @kaduvert)
+* [Allow more click modes (#3133)](https://github.com/PrismarineJS/mineflayer/commit/a315653bb94274113c9d6078d4c2ab840af0f62a) (thanks @kaduvert)
+* [Add nether test (#2932)](https://github.com/PrismarineJS/mineflayer/commit/6b1d6ea15c72edc5b761b78765a53d2ab7d0d274) (thanks @frej4189)
+* [Explicitly depend on pitem 1.14.0 with fix](https://github.com/PrismarineJS/mineflayer/commit/acc6ec9b5e61d566facb76e9c3ff512cc9a5137f) (thanks @rom1504)
+* [Make sure we pass a string to a storagebuilder (#2645)](https://github.com/PrismarineJS/mineflayer/commit/fc95843dac69bc1101dd5ec898a2aaf4dcfbf520) (thanks @u9g)
+* [extra types for enchantments (#3123)](https://github.com/PrismarineJS/mineflayer/commit/b336d2259d1ce0935bf8e10a4edb3c0a9030fb10) (thanks @zisis912)
+* [Add 1.20 to supported versions in readme (#3111)](https://github.com/PrismarineJS/mineflayer/commit/d764706f53dbe7ba16cf49645d66d192a309cc5c) (thanks @litfa)
+* [Handle hand swap entity status (#3097)](https://github.com/PrismarineJS/mineflayer/commit/a80d69a8f1a637ab1a0720ec776fc4f05c38afed) (thanks @PondWader)
+* [Add command gh workflow allowing to use release command in comments (#3116)](https://github.com/PrismarineJS/mineflayer/commit/5a55744ee0dc670f984229ec2629239bdc3e5705) (thanks @rom1504)
+
+## 4.10.1
+
+* Fix attempting to access unloaded chunks (@frej4189)
+
 ## 4.10.0
 
 * Fix handling for entities with unknown metadata (@extremeheat)

package/docs/ru/README_RU.md

@@ -18,7 +18,7 @@
 
 ## Возможности
 
- * Поддержка 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17 и 1.18
+ * Поддержка 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19 и 1.20
  * Поддержка энтити и их отслеживание
  * Вы можете полностью взаимодействовать с миром. Миллисекунды на поиск любого блока
  * Физика и управление

package/docs/tr/README_TR.md

@@ -18,7 +18,7 @@ JavaScript ile güçlü, stabil ve üst seviye Minecraft botları oluşturabilec
 
 ## Özellikler
 
- * Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15 ve 1.16 sürümlerini destekler.
+ * Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19 ve 1.20 sürümlerini destekler.
  * Varlık bilgisi ve takibi.
  * Blok bilgisi. Etrafını inceleyebilirsin. Bir bloğu bulmak milisaniyeler sürer.
  * Fizik ve hareket - bütün hayali kutucukları ele alabilirsin

package/docs/zh/README_ZH_CN.md

@@ -19,7 +19,7 @@
 
 ## 特点
 
- * 支持版本：Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15 1.16 1.17,1.18 
+ * 支持版本：Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19 和 1.20 
  * 实体感知与追踪
  * 方块感知，你可以在几毫秒内查找到bot周围的任何方块
  * 物理和运动引擎 - 支持所有的碰撞箱

package/index.d.ts

@@ -82,6 +82,7 @@ export interface BotEvents {
   entityTamed: (entity: Entity) => Promise<void> | void
   entityShakingOffWater: (entity: Entity) => Promise<void> | void
   entityEatingGrass: (entity: Entity) => Promise<void> | void
+  entityHandSwap: (entity: Entity) => Promise<void> | void
   entityWake: (entity: Entity) => Promise<void> | void
   entityEat: (entity: Entity) => Promise<void> | void
   entityCriticalEffect: (entity: Entity) => Promise<void> | void
@@ -729,6 +730,7 @@ export class Anvil {
 
 export interface Enchantment {
   level: number
+  expected: { enchant: number, level: number }
 }
 
 export class Villager extends Window<ConditionalStorageEvents> {

package/lib/plugins/blocks.js

@@ -413,11 +413,13 @@ function inject (bot, { version, storageBuilder, hideErrors }) {
   bot._client.on('tile_entity_data', (packet) => {
     if (packet.location !== undefined) {
       const column = bot.world.getColumn(packet.location.x >> 4, packet.location.z >> 4)
+      if (!column) return
       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)
+      if (!column) return
       const pos = new Vec3(tag.value.x.value & 0xf, tag.value.y.value, tag.value.z.value & 0xf)
       column.setBlockEntity(pos, tag)
     }
@@ -468,9 +470,11 @@ function inject (bot, { version, storageBuilder, hideErrors }) {
     if (bot.supportFeature('dimensionIsAnInt')) {
       return dimensionNames[dimension]
     } else if (bot.supportFeature('dimensionIsAString') || bot.supportFeature('dimensionIsAWorld')) {
-      return dimension
+      return worldName
     }
   }
+  // only exposed for testing
+  bot._getDimensionName = () => worldName
 
   async function switchWorld () {
     if (bot.world) {
@@ -501,9 +505,10 @@ function inject (bot, { version, storageBuilder, hideErrors }) {
   bot._client.on('login', (packet) => {
     if (bot.supportFeature('dimensionIsAnInt')) {
       dimension = packet.dimension
+      worldName = dimensionToFolderName(dimension)
     } else {
       dimension = packet.dimension
-      worldName = packet.worldName
+      worldName = /^minecraft:.+/.test(packet.worldName) ? packet.worldName : `minecraft:${packet.worldName}`
     }
     switchWorld()
   })

package/lib/plugins/chat.js

@@ -147,24 +147,10 @@ function inject (bot, options) {
       throw new Error('Incorrect type! Should be a string or number.')
     }
 
-    if (bot.supportFeature('signedChat')) {
-      if (message.startsWith('/')) {
-        // We send commands as Chat Command packet in 1.19+
-        const command = message.slice(1)
-        const timestamp = BigInt(Date.now())
-        bot._client.write('chat_command', {
-          command,
-          timestamp,
-          salt: 0n,
-          argumentSignatures: [],
-          signedPreview: false,
-          messageCount: 0,
-          acknowledged: Buffer.alloc(3),
-          // 1.19.2 Chat Command packet also includes an array of last seen messages
-          previousMessages: []
-        })
-        return
-      }
+    if (!header && message.startsWith('/')) {
+      // Do not try and split a command without a header
+      bot._client.chat(message)
+      return
     }
 
     const lengthLimit = CHAT_LENGTH_LIMIT - header.length

package/lib/plugins/entities.js

@@ -21,7 +21,8 @@ const entityStatusEvents = {
   6: 'entityTaming',
   7: 'entityTamed',
   8: 'entityShakingOffWater',
-  10: 'entityEatingGrass'
+  10: 'entityEatingGrass',
+  55: 'entityHandSwap'
 }
 
 function inject (bot) {
@@ -338,6 +339,12 @@ function inject (bot) {
     // entity status
     const entity = fetchEntity(packet.entityId)
     const eventName = entityStatusEvents[packet.entityStatus]
+
+    if (eventName === 'entityHandSwap' && entity.equipment) {
+      [entity.equipment[0], entity.equipment[1]] = [entity.equipment[1], entity.equipment[0]]
+      entity.heldItem = entity.equipment[0] // Update held item like prismarine-entity does upon equipment updates
+    }
+
     if (eventName) bot.emit(eventName, entity)
   })
 

package/lib/plugins/inventory.js

@@ -479,6 +479,20 @@ function inject (bot, { hideErrors }) {
     }
   }
 
+  function getChangedSlots (oldSlots, newSlots) {
+    assert.equal(oldSlots.length, newSlots.length)
+
+    const changedSlots = []
+
+    for (let i = 0; i < newSlots.length; i++) {
+      if (!Item.equal(oldSlots[i], newSlots[i])) {
+        changedSlots.push(i)
+      }
+    }
+
+    return changedSlots
+  }
+
   async function clickWindow (slot, mouseButton, mode) {
     // if you click on the quick bar and have dug recently,
     // wait a bit
@@ -490,8 +504,7 @@ function inject (bot, { hideErrors }) {
     }
     const window = bot.currentWindow || bot.inventory
 
-    assert.ok(mouseButton === 0 || mouseButton === 1)
-    assert.strictEqual(mode, 0)
+    assert.ok(mode >= 0 && mode <= 4)
     const actionId = createActionNumber()
 
     const click = {
@@ -507,7 +520,33 @@ function inject (bot, { hideErrors }) {
     if (bot.supportFeature('transactionPacketExists')) {
       windowClickQueue.push(click)
     } else {
-      changedSlots = window.acceptClick(click)
+      if (
+      // this array indicates the clicks that return changedSlots
+        [
+          0,
+          // 1,
+          // 2,
+          3,
+          4
+          // 5,
+          // 6
+        ].includes(click.mode)) {
+        changedSlots = window.acceptClick(click)
+      } else {
+        // this is used as a fallback
+        const oldSlots = JSON.parse(JSON.stringify(window.slots))
+
+        window.acceptClick(click)
+
+        changedSlots = getChangedSlots(oldSlots, window.slots)
+      }
+
+      changedSlots = changedSlots.map(slot => {
+        return {
+          location: slot,
+          item: Item.toNotch(window.slots[slot])
+        }
+      })
     }
 
     // WHEN ADDING SUPPORT FOR OTHER CLICKS, MAKE SURE TO CHANGE changedSlots TO SUPPORT THEM
@@ -528,7 +567,8 @@ function inject (bot, { hideErrors }) {
         mouseButton,
         action: actionId,
         mode,
-        item: Item.toNotch(click.item)
+        // protocol expects null even if there is an item at the slot in mode 2 and 4
+        item: Item.toNotch((mode === 2 || mode === 4) ? null : click.item)
       })
     } else { // 1.17
       bot._client.write('window_click', {

package/lib/plugins/place_block.js

@@ -10,7 +10,12 @@ function inject (bot) {
 
     let newBlock = bot.blockAt(dest)
     if (oldBlock.type === newBlock.type) {
-      [oldBlock, newBlock] = await onceWithCleanup(bot, `blockUpdate:${dest}`, { timeout: 5000 })
+      [oldBlock, newBlock] = await onceWithCleanup(bot, `blockUpdate:${dest}`, {
+        timeout: 5000,
+        // Condition to wait to receive block update actually changing the block type, in case the bot receives block updates with no changes
+        // oldBlock and newBlock will both be null when the world unloads
+        checkCondition: (oldBlock, newBlock) => !oldBlock || !newBlock || oldBlock.type !== newBlock.type
+      })
     }
 
     // blockUpdate emits (null, null) when the world unloads

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mineflayer",
-  "version": "4.10.0",
+  "version": "4.11.0",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",
@@ -22,18 +22,18 @@
   "license": "MIT",
   "dependencies": {
     "minecraft-data": "^3.37.0",
-    "minecraft-protocol": "^1.43.1",
+    "minecraft-protocol": "^1.44.0",
     "prismarine-biome": "^1.1.1",
     "prismarine-block": "^1.17.0",
     "prismarine-chat": "^1.7.1",
     "prismarine-chunk": "^1.34.0",
     "prismarine-entity": "^2.2.0",
-    "prismarine-item": "^1.12.1",
+    "prismarine-item": "^1.14.0",
     "prismarine-nbt": "^2.0.0",
     "prismarine-physics": "^1.7.0",
     "prismarine-recipe": "^1.3.0",
     "prismarine-registry": "^1.5.0",
-    "prismarine-windows": "^2.5.0",
+    "prismarine-windows": "^2.8.0",
     "prismarine-world": "^3.6.0",
     "protodef": "^1.14.0",
     "typed-emitter": "^1.0.0",