mineflayer 4.9.0 → 4.10.1

package/.github/workflows/ci.yml

@@ -37,6 +37,8 @@ jobs:
            mcVersion: '1.19.3'
          - javaVersion: 17
            mcVersion: '1.19.4'
+         - javaVersion: 17
+           mcVersion: '1.20.1'
       fail-fast: false
 
     steps:

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

@@ -422,21 +422,26 @@ The skin data is stored in the `skinData` property of the player object, if pres
 
 See [prismarine-block](https://github.com/PrismarineJS/prismarine-block)
 
-Also `block.blockEntity` is additional field with block entity data as `Object`
+Also `block.blockEntity` is additional field with block entity data as `Object`. The data in this varies between versions.
 ```js
-// sign.blockEntity
+// sign.blockEntity example from 1.19
 {
-  x: -53,
-  y: 88,
-  z: 66,
-  id: 'minecraft:sign', // 'Sign' in 1.10
-  Text1: { toString: Function }, // ChatMessage object
-  Text2: { toString: Function }, // ChatMessage object
-  Text3: { toString: Function }, // ChatMessage object
-  Text4: { toString: Function } // ChatMessage object
+  GlowingText: 0, // 0 for false, 1 for true
+  Color: 'black',
+  Text1: '{"text":"1"}',
+  Text2: '{"text":"2"}',
+  Text3: '{"text":"3"}',
+  Text4: '{"text":"4"}'
 }
 ```
 
+Note if you want to get a sign's plain text, you can use [`block.getSignText()`](https://github.com/PrismarineJS/prismarine-block/blob/master/doc/API.md#sign) instead of unstable blockEntity data.
+```java
+> block = bot.blockAt(new Vec3(0, 60, 0)) // assuming a sign is here
+> block.getSignText()
+[ "Front text\nHello world", "Back text\nHello world" ]
+```
+
 ### Biome
 
 See [prismarine-biome](https://github.com/PrismarineJS/prismarine-biome)
@@ -1803,9 +1808,9 @@ Set the direction your head is facing.
    are looking, such as for dropping items or shooting arrows. This is not
    needed for client-side calculation such as walking direction.
 
-#### bot.updateSign(block, text)
+#### bot.updateSign(block, text, back = false)
 
-Changes the text on the sign.
+Changes the text on the sign. On Minecraft 1.20 and newer, a truthy `back` will try setting the text on the back of a sign (only visible if not attached to a wall).
 
 #### bot.equip(item, destination)
 

package/docs/history.md

@@ -1,3 +1,12 @@
+## 4.10.1
+
+* Fix attempting to access unloaded chunks (@frej4189)
+
+## 4.10.0
+
+* Fix handling for entities with unknown metadata (@extremeheat)
+* support 1.20 (@PondWader)
+
 ## 4.9.0
 
 * Fix bot not updating world height on respawn packet (@frej4189)

package/index.d.ts

@@ -275,7 +275,7 @@ export interface Bot extends TypedEmitter<BotEvents> {
     force?: boolean
   ) => Promise<void>
 
-  updateSign: (block: Block, text: string) => void
+  updateSign: (block: Block, text: string, back?: boolean) => void
 
   equip: (
     item: Item | number,

package/lib/plugins/blocks.js

@@ -413,17 +413,19 @@ 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)
     }
   })
 
-  bot.updateSign = (block, text) => {
+  bot.updateSign = (block, text, back = false) => {
     const lines = text.split('\n')
     if (lines.length > 4) {
       bot.emit('error', new Error('too many lines for sign text'))
@@ -452,8 +454,10 @@ function inject (bot, { version, storageBuilder, hideErrors }) {
         text4: lines[3] ?? ''
       }
     }
+
     bot._client.write('update_sign', {
       location: block.position,
+      isFrontText: !back,
       ...signData
     })
   }

package/lib/plugins/entities.js

@@ -362,8 +362,8 @@ function inject (bot) {
     bot.emit('entityUpdate', entity)
 
     if (bot.supportFeature('mcDataHasEntityMetadata')) {
-      const { metadataKeys } = bot.registry.entitiesByName[entity.name] ?? {}
-      const metas = Object.fromEntries(packet.metadata.map(e => [metadataKeys[e.key], e.value]))
+      const metadataKeys = bot.registry.entitiesByName[entity.name]?.metadataKeys
+      const metas = metadataKeys ? Object.fromEntries(packet.metadata.map(e => [metadataKeys[e.key], e.value])) : {}
       if (packet.metadata.some(m => m.type === 'item_stack')) {
         bot.emit('itemDrop', entity)
       }

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mineflayer",
-  "version": "4.9.0",
+  "version": "4.10.1",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",
@@ -21,16 +21,16 @@
   },
   "license": "MIT",
   "dependencies": {
-    "minecraft-data": "^3.26.0",
-    "minecraft-protocol": "^1.42.0",
+    "minecraft-data": "^3.37.0",
+    "minecraft-protocol": "^1.43.1",
     "prismarine-biome": "^1.1.1",
-    "prismarine-block": "^1.13.1",
+    "prismarine-block": "^1.17.0",
     "prismarine-chat": "^1.7.1",
-    "prismarine-chunk": "^1.32.0",
+    "prismarine-chunk": "^1.34.0",
     "prismarine-entity": "^2.2.0",
     "prismarine-item": "^1.12.1",
     "prismarine-nbt": "^2.0.0",
-    "prismarine-physics": "^1.3.1",
+    "prismarine-physics": "^1.7.0",
     "prismarine-recipe": "^1.3.0",
     "prismarine-registry": "^1.5.0",
     "prismarine-windows": "^2.5.0",