mineflayer 4.20.1 → 4.22.0

package/.github/workflows/ci.yml

@@ -52,7 +52,7 @@ jobs:
       - name: Setup Java JDK
         uses: actions/setup-java@v1.4.3
         with:
-          java-version: 17
+          java-version: 21
           java-package: jre
       - name: Install Dependencies
         run: npm install

package/.gitpod.yml

@@ -1,2 +1,2 @@
 tasks:
-- command: npm install
+- command: npm install && sdk install java

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 to 1.20.4 (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)
+ * Supports Minecraft 1.8 to 1.20.5 (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 upto 1.20.6)
  * 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
@@ -43,7 +43,7 @@ npm install mineflayer
 
 To update mineflayer (or any Node.js) package and its dependencies, use 
 ```bash
-npm update --depth 9999
+npm update
 ```
 
 ## Documentation

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 to 1.20.4 (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)
+ * Supports Minecraft 1.8 to 1.20.5 (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 upto 1.20.6)
  * 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
@@ -43,7 +43,7 @@ npm install mineflayer
 
 To update mineflayer (or any Node.js) package and its dependencies, use 
 ```bash
-npm update --depth 9999
+npm update
 ```
 
 ## Documentation

package/docs/api.md

@@ -808,7 +808,7 @@ Create and return an instance of the class bot.
  * checkTimeoutInterval : default to `30*1000` (30s), check if keepalive received at that period, disconnect otherwise.
  * loadInternalPlugins : defaults to true
  * storageBuilder : an optional function, takes as argument version and worldName and return an instance of something with the same API as prismarine-provider-anvil. Will be used to save the world.
- * client : an instance of node-minecraft-protocol, if not specified, mineflayer makes it's own client. This can be used to enable using mineflayer through a proxy of many clients or a vanilla client and a mineflayer client.
+ * client : an instance of node-minecraft-protocol, if not specified, mineflayer makes its own client. This can be used to enable using mineflayer through a proxy of many clients or a vanilla client and a mineflayer client.
  * brand : the brand name for the client to use. Defaults to vanilla. Can be used to simulate custom clients for servers that require it.
  * respawn : when set to false disables bot from automatically respawning, defaults to true.
  * plugins : object : defaults to {}
@@ -974,7 +974,7 @@ Default true, whether or not you receive color codes in chats from the server.
 
 #### bot.settings.viewDistance
 
-Can be a string listed below or a postive number.
+Can be a string listed below or a positive number.
 Choices:
  * `far` (default)
  * `normal`
@@ -1035,7 +1035,7 @@ saturation of 5.0. Eating food increases the saturation as well as the food bar.
 
 #### bot.oxygenLevel
 
-Number in the range [0, 20] respresenting the number of water-icons known as oxygen level.
+Number in the range [0, 20] representing the number of water-icons known as oxygen level.
 
 #### bot.physics
 
@@ -1554,7 +1554,7 @@ Fires when a particle is created
 
 #### bot.blockAt(point, extraInfos=true)
 
-Returns the block at `point` or `null` if that point is not loaded. If `extraInfos` set to true, also returns informations about signs, paintings and block entities (slower).
+Returns the block at `point` or `null` if that point is not loaded. If `extraInfos` set to true, also returns information about signs, paintings and block entities (slower).
 See `Block`.
 
 #### bot.waitForChunksToLoad()
@@ -1596,8 +1596,8 @@ Finds the closest blocks from the given point.
    - `point` - The start position of the search (center). Default is the bot position.
    - `matching` - A function that returns true if the given block is a match. Also supports this value being a block id or array of block ids.
    - `useExtraInfo` - To preserve backward compatibility can result in two behavior depending on the type
-      - **boolean** - Provide your `matching` function more data - noticeably slower aproach
-      - **function** - Creates two stage maching, if block passes `matching` function it is passed further to `useExtraInfo` with additional info
+      - **boolean** - Provide your `matching` function more data - noticeably slower approach
+      - **function** - Creates two stage matching, if block passes `matching` function it is passed further to `useExtraInfo` with additional info
    - `maxDistance` - The furthest distance for the search, defaults to 16.
    - `count` - Number of blocks to find before returning the search. Default to 1. Can return less if not enough blocks are found exploring the whole area.
 
@@ -1627,7 +1627,7 @@ with `metadata`.
 
 #### bot.recipesAll(itemType, metadata, craftingTable)
 
-The same as bot.recipesFor except that it does not check wether the bot has enough materials for the recipe.
+The same as bot.recipesFor except that it does not check whether the bot has enough materials for the recipe.
 
 #### bot.nearestEntity(match = (entity) => { return true })
 
@@ -1635,7 +1635,7 @@ Return the nearest entity to the bot, matching the function (default to all enti
 
 Example:
 ```js
-const cow = bot.nearestEntity(entity => entity.name.toLowerCase() === 'cow') // we use .toLowercase() because in 1.8 cow was capitalized, for newer versions that can be ommitted
+const cow = bot.nearestEntity(entity => entity.name.toLowerCase() === 'cow') // we use .toLowercase() because in 1.8 cow was capitalized, for newer versions that can be omitted
 ```
 
 ### Methods
@@ -1657,7 +1657,7 @@ Requests chat completion from the server.
  * `str` - String to complete.
  * `assumeCommand` - Field sent to server, defaults to false.
  * `sendBlockInSight` - Field sent to server, defaults to true. Set this option to false if you want more performance.
- * `timeout` - Timeout in milliseconds, after which the function will return an ampty array, defaults to 5000.
+ * `timeout` - Timeout in milliseconds, after which the function will return an empty array, defaults to 5000.
 
 #### bot.chat(message)
 
@@ -1683,11 +1683,11 @@ Adds a regex pattern to the bot's chat matching. Useful for bukkit servers where
 make an event that is called every time the pattern is matched to a message,
 the event will be called `"chat:name"`, with name being the name passed
 * `name` - the name used to listen for the event
-* `pattern` - regular expression to match to messages recieved
+* `pattern` - regular expression to match to messages received
 * `chatPatternOptions` - object
   * `repeat` - defaults to true, whether to listen for this event after the first match
   * `parse` - instead of returning the actual message that was matched, return the capture groups from the regex
-  * `deprecated` - (**unstable**) used by bot.chatAddPattern to keep compatability, likely to be removed
+  * `deprecated` - (**unstable**) used by bot.chatAddPattern to keep compatibility, likely to be removed
 
 returns a number which can be used with bot.removeChatPattern() to only delete this pattern
 
@@ -1695,10 +1695,10 @@ returns a number which can be used with bot.removeChatPattern() to only delete t
 
 #### bot.addChatPatternSet(name, patterns, chatPatternOptions)
 
-make an event that is called every time all patterns havee been matched to messages,
+make an event that is called every time all patterns have been matched to messages,
 the event will be called `"chat:name"`, with name being the name passed
 * `name` - the name used to listen for the event
-* `patterns` - array of regular expression to match to messages recieved
+* `patterns` - array of regular expression to match to messages received
 * `chatPatternOptions` - object
   * `repeat` - defaults to true, whether to listen for this event after the first match
   * `parse` - instead of returning the actual message that was matched, return the capture groups from the regex
@@ -1892,7 +1892,7 @@ dig any other blocks until the block has been broken, or you call
 `bot.stopDigging()`.
 
  * `block` - the block to start digging into
- * `forceLook` - (optional) if true, look at the block and start mining instantly. If false, the bot will slowly turn to the block to mine. Additionally, this can be assigned to 'ignore' to prevent the bot from moving it's head at all. Also, this can be assigned to 'raycast' to raycast from the bots head to place where the bot is looking.
+ * `forceLook` - (optional) if true, look at the block and start mining instantly. If false, the bot will slowly turn to the block to mine. Additionally, this can be assigned to 'ignore' to prevent the bot from moving its head at all. Also, this can be assigned to 'raycast' to raycast from the bots head to place where the bot is looking.
  * `digFace` - (optional) Default is 'auto' looks at the center of the block and mines the top face. Can also be a vec3 vector
  of the face the bot should be looking at when digging the block. For example: ```vec3(0, 1, 0)``` when mining the top. Can also be 'raycast' raycast checks if there is a face visible by the bot and mines that face. Useful for servers with anti cheat.
 
@@ -2249,4 +2249,4 @@ Note that while flying, `bot.entity.velocity` will not be accurate.
 
 #### bot.creative.stopFlying()
 
-Restores `bot.physics.gravity` to it's original value.
+Restores `bot.physics.gravity` to its original value.

package/docs/history.md

@@ -1,3 +1,23 @@
+## 4.22.0
+* [Remove debug logging (#3478)](https://github.com/PrismarineJS/mineflayer/commit/eb29d350ede0590fce17e04bf21071807a87e3a1) (thanks @extremeheat)
+
+## 4.21.0
+* [1.20.6 (#3412)](https://github.com/PrismarineJS/mineflayer/commit/44fad41c18be5024564e24e1cdee624d35d4d387) (thanks @extremeheat)
+* [Update README.md (#3420)](https://github.com/PrismarineJS/mineflayer/commit/1c2a5c0fa78f74a63fabd7edde85c4a74db32dee) (thanks @SilkePilon)
+* [types: add pitchSpeed as an option in typings (#3446)](https://github.com/PrismarineJS/mineflayer/commit/05b48ad0dad4cf64a1c11660bac256d7b4015841) (thanks @GenerelSchwerz)
+* [Fixed a bug with not closing the window when changing the subserver (#3424)](https://github.com/PrismarineJS/mineflayer/commit/d00c386cfe51cefc361c0ff4d30b100aee9f114a) (thanks @DenisKvak1)
+* [Bump @types/node from 20.14.14 to 22.1.0 (#3431)](https://github.com/PrismarineJS/mineflayer/commit/1d461616b514969fdece38e49bfbec747ab8d76a) (thanks @dependabot[bot])
+* [Fix updateSlot event type (#3425)](https://github.com/PrismarineJS/mineflayer/commit/5d39db26a6ab17baac38b68af8ccd3eeb4af3def) (thanks @DenisKvak1)
+* [Player hitbox fixes (#3382)](https://github.com/PrismarineJS/mineflayer/commit/78b4eccb4572a821b11c3124b7a593f3b91f1180) (thanks @AreaDenial)
+* [Typo fixes (#3418)](https://github.com/PrismarineJS/mineflayer/commit/ef042a242ca9f5fc5820fe4dc2e1d997ef1db202) (thanks @kgurchiek)
+* [Added support for 1.18+ edit book packet #3204 (#3373)](https://github.com/PrismarineJS/mineflayer/commit/eb9982aa04973b0086aac68a2847005d77f01a3d) (thanks @unlimitedcoder2)
+* [Fix typos (#3381)](https://github.com/PrismarineJS/mineflayer/commit/d581ea7cee4d5b7df9606f671656bb0be0fdbf91) (thanks @data-miner00)
+* [Fix typescript types syntax for setCommandBlock (#3366)](https://github.com/PrismarineJS/mineflayer/commit/315cdfc4b1fc2760e4a8a36feb718626a66d5056) (thanks @undefined)
+* [Remove invalid sign check (#3328)](https://github.com/PrismarineJS/mineflayer/commit/ec76468c8ac4c6232bad3c2b66d4160f95f58396) (thanks @zardoy)
+* [refactor: simplifying the code of blockAtCursor (#3337)](https://github.com/PrismarineJS/mineflayer/commit/dc70f932ac9aaab6e6cdb15057b409b15c3232dd) (thanks @SnowRunescape)
+* [Updated setCommandBlock's 3rd argument (#3356)](https://github.com/PrismarineJS/mineflayer/commit/04ad6db404f0da779004b3ddd0e049bf2c6be0a3) (thanks @FlooferLand)
+* [Added the serverBrand property to index.d.ts (#3355)](https://github.com/PrismarineJS/mineflayer/commit/0bb2707d2f6d0d64a467d4e0d6ddc52adf526127) (thanks @Khaogamermain01)
+
 ## 4.20.1
 * [Add bossBarCreated event in index.d.ts (#3340)](https://github.com/PrismarineJS/mineflayer/commit/8299288526cd7ff24bcd87511814221f8ad62507) (thanks @gguio)
 * [Update scoreboard.js (#3318)](https://github.com/PrismarineJS/mineflayer/commit/195b3cbd70a110080af9b77a4659991c5d9e484a) (thanks @vicdum)

package/docs/tutorial.md

@@ -453,7 +453,7 @@ The function could also be called when an error occurs.
 
 Below is an example of a bot that will craft oak logs into oak planks and then into sticks.
 
-Incorect approach ❌:
+Incorrect approach ❌:
 
 ```js
 function craft (bot) {

package/examples/advanced/chest_confirm.md

@@ -1,4 +1,4 @@
-# Menual Chest Confirm
+# Manual Chest Confirm
 
 This code snippet will tell the bot not to wait for chest confirmations that some spigot plugins will not send
 

package/examples/chatterbox.js

@@ -10,7 +10,7 @@
  * may flood the chat, feel free to check them out for other purposes though.
  *
  * This bot also replies to some specific chat messages so you can ask him
- * a few informations while you are in game.
+ * a few information while you are in game.
  */
 const mineflayer = require('mineflayer')
 const { Vec3 } = require('vec3')

package/examples/echo.js

@@ -9,7 +9,7 @@
 const mineflayer = require('mineflayer')
 
 if (process.argv.length < 4 || process.argv.length > 6) {
-  console.log('Usage : node echo.js <host> <port> [<name>] [<password>]')
+  console.log('Usage : node echo.js <host> <port> [<name>] [online?]')
   process.exit(1)
 }
 
@@ -17,10 +17,14 @@ const bot = mineflayer.createBot({
   host: process.argv[2],
   port: parseInt(process.argv[3]),
   username: process.argv[4] ? process.argv[4] : 'echo',
-  password: process.argv[5]
+  auth: process.argv[5] ? 'microsoft' : 'offline'
 })
 
 bot.on('chat', (username, message) => {
   if (username === bot.username) return
   bot.chat(message)
 })
+
+bot.on('kicked', (reason) => {
+  console.log('I was kicked from the server: ' + reason)
+})

package/examples/looker.js

@@ -1,5 +1,5 @@
 /*
- * This script will automaticly look at the closest entity.
+ * This script will automatically look at the closest entity.
  * It checks for a near entity every tick.
  */
 const mineflayer = require('mineflayer')

package/examples/perfectShotBow.js

@@ -30,7 +30,7 @@ bot.on('spawn', function () {
 
   // Auto attack every 1,2 secs with bow
   // With crossbow attack when crossbow is charget (enchant 3 = 0.5s)
-  // ['snowball', 'ender_pearl', 'egg', 'splash_potion'] auto attack every 0,1 sec, no recomended use autoAttack for these items, instead use "bot.hawkEye.oneShot(target, weapon)"
+  // ['snowball', 'ender_pearl', 'egg', 'splash_potion'] auto attack every 0,1 sec, no recommended use autoAttack for these items, instead use "bot.hawkEye.oneShot(target, weapon)"
 
   bot.hawkEye.autoAttack(target, weapon)
   // If you force stop attack use:

package/examples/place_end_crystal/index.js

@@ -51,7 +51,7 @@ bot.on('chat', async (ign, msg) => {
       const { x: aboveX, y: aboveY, z: aboveZ } = block.position.offset(0, 1, 0)
       const blockBoundingBox = new AABB(aboveX, aboveY, aboveZ, aboveX + 1, aboveY + 2, aboveZ + 1)
       const entityAABBs = Object.values(bot.entities).map(entity => {
-        // taken from taken from https://github.com/PrismarineJS/prismarine-physics/blob/d145e54a4bb8604300258badd7563f59f2101922/index.js#L92
+        // taken from https://github.com/PrismarineJS/prismarine-physics/blob/d145e54a4bb8604300258badd7563f59f2101922/index.js#L92
         const w = entity.height / 2
         const { x, y, z } = entity.position
         return new AABB(-w, 0, -w, w, entity.height, w).offset(x, y, z)

package/examples/python/chatterbox.py

@@ -10,7 +10,7 @@
 # may flood the chat, feel free to check them out for other purposes though.
 #
 # This bot also replies to some specific chat messages so you can ask him
-# a few informations while you are in game.
+# a few information while you are in game.
 # ===========================================================================
 import sys, re
 from javascript import require, On, Once, console

package/index.d.ts

@@ -165,6 +165,13 @@ export interface BotEvents {
   particle: (particle: Particle) => Promise<void> | void
 }
 
+export interface CommandBlockOptions {
+  mode: number,
+  trackOutput: boolean,
+  conditional: boolean,
+  alwaysActive: boolean
+}
+
 export interface Bot extends TypedEmitter<BotEvents> {
   username: string
   protocolVersion: string
@@ -379,7 +386,9 @@ export interface Bot extends TypedEmitter<BotEvents> {
     times?: number
   ) => Promise<void>
 
-  setCommandBlock: (pos: Vec3, command: string, trackOutput: boolean) => void
+  
+  
+  setCommandBlock: (pos: Vec3, command: string, options: CommandBlockOptions) => void
 
   clickWindow: (
     slot: number,
@@ -457,6 +466,7 @@ export interface GameState {
   dimension: Dimension
   difficulty: Difficulty
   maxPlayers: number
+  serverBrand: string
 }
 
 export type LevelType =
@@ -531,6 +541,7 @@ export interface PhysicsOptions {
   playerHeight: number
   jumpSpeed: number
   yawSpeed: number
+  pitchSpeed: number
   sprintSpeed: number
   maxGroundSpeedSoulSand: number
   maxGroundSpeedWater: number
@@ -639,7 +650,7 @@ export class Painting {
 interface StorageEvents {
   open: () => void
   close: () => void
-  updateSlot: (oldItem: Item | null, newItem: Item | null) => void
+  updateSlot: (slot: number, oldItem: Item | null, newItem: Item | null) => void
 }
 
 interface FurnaceEvents extends StorageEvents {

package/lib/loader.js

@@ -95,6 +95,7 @@ function createBot (options = {}) {
     }).map(key => options.plugins[key])
   bot.loadPlugins([...internalPlugins, ...externalPlugins])
 
+  options.validateChannelProtocol = false
   bot._client = bot._client ?? mc.createClient(options)
   bot._client.on('connect', () => {
     bot.emit('connect')

package/lib/particle.js

@@ -5,8 +5,8 @@ module.exports = loader
 function loader (registry) {
   class Particle {
     constructor (id, position, offset, count = 1, movementSpeed = 0, longDistanceRender = false) {
-      Object.assign(this, registry.particles[id])
       this.id = id
+      Object.assign(this, registry.particles[id] || registry.particlesByName[id])
       this.position = position
       this.offset = offset
       this.count = count
@@ -15,14 +15,26 @@ function loader (registry) {
     }
 
     static fromNetwork (packet) {
-      return new Particle(
-        packet.particleId,
-        new Vec3(packet.x, packet.y, packet.z),
-        new Vec3(packet.offsetX, packet.offsetY, packet.offsetZ),
-        packet.particles,
-        packet.particleData,
-        packet.longDistance
-      )
+      if (registry.supportFeature('updatedParticlesPacket')) {
+        // TODO: We add extra data that's inside packet.particle.data that varies by the particle's .type
+        return new Particle(
+          packet.particle.type,
+          new Vec3(packet.x, packet.y, packet.z),
+          new Vec3(packet.offsetX, packet.offsetY, packet.offsetZ),
+          packet.amount,
+          packet.velocityOffset,
+          packet.longDistance
+        )
+      } else {
+        return new Particle(
+          packet.particleId,
+          new Vec3(packet.x, packet.y, packet.z),
+          new Vec3(packet.offsetX, packet.offsetY, packet.offsetZ),
+          packet.particles,
+          packet.particleData,
+          packet.longDistance
+        )
+      }
     }
   }
 

package/lib/plugins/blocks.js

@@ -221,7 +221,7 @@ function inject (bot, { version, storageBuilder, hideErrors }) {
   // if passed in block is within line of sight to the bot, returns true
   // also works on anything with a position value
   function canSeeBlock (block) {
-    const headPos = bot.entity.position.offset(0, bot.entity.height, 0)
+    const headPos = bot.entity.position.offset(0, bot.entity.eyeHeight, 0)
     const range = headPos.distanceTo(block.position)
     const dir = block.position.offset(0.5, 0.5, 0.5).minus(headPos)
     const match = (inputBlock, iter) => {
@@ -455,9 +455,10 @@ function inject (bot, { version, storageBuilder, hideErrors }) {
       bot.emit('error', new Error('too many lines for sign text'))
       return
     }
+
     for (let i = 0; i < lines.length; ++i) {
-      if (lines[i].length > 15) {
-        bot.emit('error', new Error('signs have max line length 15'))
+      if (lines[i].length > 45) {
+        bot.emit('error', new Error('Signs have a maximum of 45 characters per line'))
         return
       }
     }
@@ -530,6 +531,9 @@ function inject (bot, { version, storageBuilder, hideErrors }) {
     if (bot.supportFeature('dimensionIsAnInt')) {
       dimension = packet.dimension
       worldName = dimensionToFolderName(dimension)
+    } else if (bot.supportFeature('spawnRespawnWorldDataField')) { // 1.20.5+
+      dimension = packet.worldState.dimension
+      worldName = packet.worldState.name
     } else {
       dimension = packet.dimension
       worldName = /^minecraft:.+/.test(packet.worldName) ? packet.worldName : `minecraft:${packet.worldName}`
@@ -541,6 +545,11 @@ function inject (bot, { version, storageBuilder, hideErrors }) {
     if (bot.supportFeature('dimensionIsAnInt')) { // <=1.15.2
       if (dimension === packet.dimension) return
       dimension = packet.dimension
+    } else if (bot.supportFeature('spawnRespawnWorldDataField')) { // 1.20.5+
+      if (dimension === packet.worldState.dimension) return
+      if (worldName === packet.worldState.name && packet.copyMetadata === true) return // don't unload chunks if in same world and metaData is true
+      dimension = packet.worldState.dimension
+      worldName = packet.worldState.name
     } else { // >= 1.15.2
       if (dimension === packet.dimension) return
       if (worldName === packet.worldName && packet.copyMetadata === true) return // don't unload chunks if in same world and metaData is true

package/lib/plugins/book.js

@@ -10,17 +10,27 @@ function inject (bot) {
   if (bot.supportFeature('editBookIsPluginChannel')) {
     bot._client.registerChannel('MC|BEdit', 'slot')
     bot._client.registerChannel('MC|BSign', 'slot')
-    editBook = (book, signing = false) => {
+    editBook = (book, pages, title, slot, signing = false) => {
       if (signing) bot._client.writeChannel('MC|BSign', Item.toNotch(book))
       else bot._client.writeChannel('MC|BEdit', Item.toNotch(book))
     }
   } else if (bot.supportFeature('hasEditBookPacket')) {
-    editBook = (book, signing = false, hand = 0) => {
-      bot._client.write('edit_book', {
-        new_book: Item.toNotch(book),
-        signing,
-        hand
-      })
+    if (bot.supportFeature('editBookPacketUsesNbt')) { // 1.13 - 1.17
+      editBook = (book, pages, title, slot, signing = false, hand = 0) => {
+        bot._client.write('edit_book', {
+          hand: slot,
+          pages,
+          title
+        })
+      }
+    } else { // 1.18+
+      editBook = (book, pages, title, slot, signing = false, hand = 0) => {
+        bot._client.write('edit_book', {
+          new_book: Item.toNotch(book),
+          signing,
+          hand
+        })
+      }
     }
   }
 
@@ -38,7 +48,7 @@ function inject (bot) {
     bot.setQuickBarSlot(moveToQuickBar ? 0 : slot - 36)
 
     const modifiedBook = await modifyBook(moveToQuickBar ? 36 : slot, pages, author, title, signing)
-    editBook(modifiedBook, signing)
+    editBook(modifiedBook, pages, title, moveToQuickBar ? 0 : slot - 36, signing)
     await once(bot.inventory, `updateSlot:${moveToQuickBar ? 36 : slot}`)
 
     bot.setQuickBarSlot(quickBarSlot)

package/lib/plugins/breath.js

@@ -1,17 +1,19 @@
 module.exports = inject
 
 function inject (bot) {
+  if (bot.supportFeature('mcDataHasEntityMetadata')) {
+    // this is handled inside entities.js. We don't yet have entity metadataKeys for all versions but once we do
+    // we can delete the numerical checks here and in entities.js https://github.com/extremeheat/mineflayer/blob/eb9982aa04973b0086aac68a2847005d77f01a3d/lib/plugins/entities.js#L469
+    return
+  }
   bot._client.on('entity_metadata', (packet) => {
-    if (!bot?.entity?.id === packet?.entityId) return
-    if (packet?.metadata[1]?.key === 1) {
-      if (!packet?.metadata[1]?.value) return
-      bot.oxygenLevel = Math.round(packet.metadata[1].value / 15)
-      bot.emit('breath')
-    }
-    if (packet?.metadata[0]?.key === 1) {
-      if (!packet?.metadata[0]?.value) return
-      bot.oxygenLevel = Math.round(packet.metadata[0].value / 15)
-      bot.emit('breath')
+    if (!bot.entity) return
+    if (bot.entity.id !== packet.entityId) return
+    for (const metadata of packet.metadata) {
+      if (metadata.key === 1) {
+        bot.oxygenLevel = Math.round(packet.metadata[1].value / 15)
+        bot.emit('breath')
+      }
     }
   })
 }

package/lib/plugins/chat.js

@@ -196,7 +196,7 @@ function inject (bot, options) {
   bot.tabComplete = tabComplete
 
   function addDefaultPatterns () {
-    // 1.19 changes the chat format to move <sender> prefix from message contents to a seperate field.
+    // 1.19 changes the chat format to move <sender> prefix from message contents to a separate field.
     // TODO: new chat lister to handle this
     if (!defaultChatPatterns) return
     bot.addChatPattern('whisper', new RegExp(`^${USERNAME_REGEX} whispers(?: to you)?:? (.*)$`), { deprecated: true })

package/lib/plugins/creative.js

@@ -35,7 +35,10 @@ function inject (bot) {
       item: Item.toNotch(item)
     })
 
-    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 })
+    await onceWithCleanup(bot.inventory, `updateSlot:${slot}`, {
+      timeout: 5000,
+      checkCondition: (oldItem, newItem) => item === null ? newItem === null : newItem?.name === item.name && newItem?.count === item.count && newItem?.metadata === item.metadata
+    })
     creativeSlotsUpdates[slot] = false
   }
 

package/lib/plugins/digging.js

@@ -42,10 +42,10 @@ function inject (bot) {
         )
       } else if (digFace === 'raycast') {
         // Check faces that could be seen from the current position. If the delta is smaller then 0.5 that means the
-        // bot cam most likely not see the face as the block is 1 block thick
-        // this could be false for blocks that have a smaller bounding box then 1x1x1
+        // bot can most likely not see the face as the block is 1 block thick
+        // this could be false for blocks that have a smaller bounding box than 1x1x1
         const dx = bot.entity.position.x - (block.position.x + 0.5)
-        const dy = bot.entity.position.y + bot.entity.height - (block.position.y + 0.5)
+        const dy = bot.entity.position.y + bot.entity.eyeHeight - (block.position.y + 0.5)
         const dz = bot.entity.position.z - (block.position.z + 0.5)
         // Check y first then x and z
         const visibleFaces = {
@@ -63,7 +63,7 @@ function inject (bot) {
             0.5 + (i === 'y' ? visibleFaces[i] * 0.5 : 0),
             0.5 + (i === 'z' ? visibleFaces[i] * 0.5 : 0)
           )
-          const startPos = bot.entity.position.offset(0, bot.entity.height, 0)
+          const startPos = bot.entity.position.offset(0, bot.entity.eyeHeight, 0)
           const rayBlock = bot.world.raycast(startPos, targetPos.clone().subtract(startPos).normalize(), 5)
           if (rayBlock) {
             if (startPos.distanceTo(rayBlock.intersect) < startPos.distanceTo(targetPos)) {
@@ -94,7 +94,7 @@ function inject (bot) {
           for (const i in validFaces) {
             const tPos = validFaces[i].targetPos
             const cDist = new Vec3(tPos.x, tPos.y, tPos.z).distanceSquared(
-              bot.entity.position.offset(0, bot.entity.height, 0)
+              bot.entity.position.offset(0, bot.entity.eyeHeight, 0)
             )
             if (distSqrt > cDist) {
               closest = validFaces[i]

package/lib/plugins/entities.js

@@ -1,8 +1,12 @@
 const { Vec3 } = require('vec3')
 const conv = require('../conversions')
-const NAMED_ENTITY_HEIGHT = 1.62
-const NAMED_ENTITY_WIDTH = 0.6
-const CROUCH_HEIGHT = NAMED_ENTITY_HEIGHT - 0.08
+// These values are only accurate for versions 1.14 and above (crouch hitbox changes)
+// Todo: hitbox sizes for sleeping, swimming/crawling, and flying with elytra
+const PLAYER_HEIGHT = 1.8
+const CROUCH_HEIGHT = 1.5
+const PLAYER_WIDTH = 0.6
+const PLAYER_EYEHEIGHT = 1.62
+const CROUCH_EYEHEIGHT = 1.27
 
 module.exports = inject
 
@@ -102,6 +106,9 @@ function inject (bot) {
     bot.entity.username = bot._client.username
     bot.entity.type = 'player'
     bot.entity.name = 'player'
+    bot.entity.height = PLAYER_HEIGHT
+    bot.entity.width = PLAYER_WIDTH
+    bot.entity.eyeHeight = PLAYER_EYEHEIGHT
   })
 
   bot._client.on('entity_equipment', (packet) => {
@@ -130,11 +137,13 @@ function inject (bot) {
   })
 
   bot.on('entityCrouch', (entity) => {
+    entity.eyeHeight = CROUCH_EYEHEIGHT
     entity.height = CROUCH_HEIGHT
   })
 
   bot.on('entityUncrouch', (entity) => {
-    entity.height = NAMED_ENTITY_HEIGHT
+    entity.eyeHeight = PLAYER_EYEHEIGHT
+    entity.height = PLAYER_HEIGHT
   })
 
   bot._client.on('collect', (packet) => {
@@ -184,8 +193,9 @@ function inject (bot) {
     entity.username = bot.uuidToUsername[uuid]
     entity.uuid = uuid
     updateEntityPos(entity, pos)
-    entity.height = NAMED_ENTITY_HEIGHT
-    entity.width = NAMED_ENTITY_WIDTH
+    entity.eyeHeight = PLAYER_EYEHEIGHT
+    entity.height = PLAYER_HEIGHT
+    entity.width = PLAYER_WIDTH
     if (bot.players[entity.username] !== undefined && !bot.players[entity.username].entity) {
       bot.players[entity.username].entity = entity
     }
@@ -460,6 +470,12 @@ function inject (bot) {
           bot.emit('entityUncrouch', entity)
         }
       }
+
+      // Breathing (formerly in breath.js)
+      if (metas.air_supply != null) {
+        bot.oxygenLevel = Math.round(metas.air_supply / 15)
+        bot.emit('breath')
+      }
     } else {
       const typeSlot = (bot.supportFeature('itemsAreAlsoBlocks') ? 5 : 6) + (bot.supportFeature('entityMetadataHasLong') ? 1 : 0)
       const slot = packet.metadata.find(e => e.type === typeSlot)

package/lib/plugins/fishing.js

@@ -25,8 +25,13 @@ function inject (bot) {
     if (!lastBobber || fishingTask.done) return
 
     const pos = lastBobber.position
-    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) {
+
+    const bobberCondition = bot.registry.supportFeature('updatedParticlesPacket')
+      ? ((packet.particle.type === 'fishing' || packet.particle.type === 'bubble') && packet.amount === 6 && pos.distanceTo(new Vec3(packet.x, pos.y, packet.z)) <= 1.23)
+      // This "(particles.fishing ?? particles.bubble).id" condition doesn't make sense (these are both valid types)
+      : (packet.particleId === (bot.registry.particlesByName.fishing ?? bot.registry.particlesByName.bubble).id && packet.particles === 6 && pos.distanceTo(new Vec3(packet.x, pos.y, packet.z)) <= 1.23)
+
+    if (bobberCondition) {
       bot.activateItem()
       lastBobber = undefined
       fishingTask.finish()

package/lib/plugins/game.js

@@ -25,8 +25,14 @@ function inject (bot, options) {
   function handleRespawnPacketData (packet) {
     bot.game.levelType = packet.levelType ?? (packet.isFlat ? 'flat' : 'default')
     bot.game.hardcore = packet.isHardcore ?? Boolean(packet.gameMode & 0b100)
-    bot.game.gameMode = parseGameMode(packet.gameMode)
-    if (bot.supportFeature('dimensionIsAnInt')) {
+    bot.game.gameMode = packet.gamemode || parseGameMode(packet.gameMode)
+    if (bot.supportFeature('segmentedRegistryCodecData')) { // 1.20.5
+      if (typeof packet.dimension === 'number') {
+        bot.game.dimension = bot.registry.dimensionsArray[packet.dimension]?.name?.replace('minecraft:', '')
+      } else if (typeof packet.dimension === 'string') { // iirc, in 1.21 it's back to a string
+        bot.game.dimension = packet.dimension.replace('minecraft:', '')
+      }
+    } else if (bot.supportFeature('dimensionIsAnInt')) {
       bot.game.dimension = dimensionNames[packet.dimension]
     } else if (bot.supportFeature('dimensionIsAString')) {
       bot.game.dimension = packet.dimension.replace('minecraft:', '')
@@ -40,25 +46,24 @@ function inject (bot, options) {
       bot.registry.loadDimensionCodec(packet.dimensionCodec)
     }
 
+    bot.game.minY = 0
+    bot.game.height = 256
+
     if (bot.supportFeature('dimensionDataInCodec')) { // 1.19+
-      if (packet.worldType) { // login
+      // pre 1.20.5 before we consolidated login and respawn's SpawnInfo structure into one type,
+      // "dimension" was called "worldType" in login_packet's payload but not respawn.
+      if (packet.worldType && !bot.game.dimension) {
         bot.game.dimension = packet.worldType.replace('minecraft:', '')
-        const { minY, height } = bot.registry.dimensionsByName[bot.game.dimension]
-        bot.game.minY = minY
-        bot.game.height = height
-      } else if (packet.dimension) { // respawn
-        bot.game.dimension = packet.dimension.replace('minecraft:', '')
-        const { minY, height } = bot.registry.dimensionsByName[bot.game.dimension]
-        bot.game.minY = minY
-        bot.game.height = height
+      }
+      const dimData = bot.registry.dimensionsByName[bot.game.dimension]
+      if (dimData) {
+        bot.game.minY = dimData.minY
+        bot.game.height = dimData.height
       }
     } else if (bot.supportFeature('dimensionDataIsAvailable')) { // 1.18
       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) {
@@ -73,11 +78,11 @@ function inject (bot, options) {
 
   // 1.20.2
   bot._client.on('registry_data', (packet) => {
-    bot.registry.loadDimensionCodec(packet.codec)
+    bot.registry.loadDimensionCodec(packet.codec || packet)
   })
 
   bot._client.on('login', (packet) => {
-    handleRespawnPacketData(packet)
+    handleRespawnPacketData(packet.worldState || packet)
 
     bot.game.maxPlayers = packet.maxPlayers
     if (packet.enableRespawnScreen) {
@@ -95,7 +100,8 @@ function inject (bot, options) {
   })
 
   bot._client.on('respawn', (packet) => {
-    handleRespawnPacketData(packet)
+    // in 1.20.5+ protocol we move the shared spawn data into one SpawnInfo type under .worldState
+    handleRespawnPacketData(packet.worldState || packet)
     bot.emit('game')
   })
 

package/lib/plugins/inventory.js

@@ -691,6 +691,13 @@ function inject (bot, { hideErrors }) {
     bot.currentWindow = null
     bot.emit('windowClose', oldWindow)
   })
+  bot._client.on('login', () => {
+    // close window when switch subserver
+    const oldWindow = bot.currentWindow
+    if (!oldWindow) return
+    bot.currentWindow = null
+    bot.emit('windowClose', oldWindow)
+  })
   bot._client.on('set_slot', (packet) => {
     // set slot
     const window = packet.windowId === 0 ? bot.inventory : bot.currentWindow

package/lib/plugins/physics.js

@@ -323,7 +323,7 @@ function inject (bot, { physicsEnabled, maxCatchupTicks }) {
   }
 
   bot.lookAt = async (point, force) => {
-    const delta = point.minus(bot.entity.position.offset(0, bot.entity.height, 0))
+    const delta = point.minus(bot.entity.position.offset(0, bot.entity.eyeHeight, 0))
     const yaw = Math.atan2(-delta.x, -delta.z)
     const groundDistance = Math.sqrt(delta.x * delta.x + delta.z * delta.z)
     const pitch = Math.atan2(delta.y, groundDistance)
@@ -332,7 +332,9 @@ function inject (bot, { physicsEnabled, maxCatchupTicks }) {
 
   // player position and look (clientbound)
   bot._client.on('position', (packet) => {
-    bot.entity.height = 1.62
+    // Is this necessary? Feels like it might wrongly overwrite hitbox size sometimes
+    // e.g. when crouching/crawling/swimming. Can someone confirm?
+    bot.entity.height = 1.8
 
     // Velocity is only set to 0 if the flag is not set, otherwise keep current velocity
     const vel = bot.entity.velocity

package/lib/plugins/ray_trace.js

@@ -17,12 +17,7 @@ module.exports = (bot) => {
   }
 
   bot.blockAtCursor = (maxDistance = 256, matcher = null) => {
-    const { position, height, pitch, yaw } = bot.entity
-
-    const eyePosition = position.offset(0, height, 0)
-    const viewDirection = getViewDirection(pitch, yaw)
-
-    return bot.world.raycast(eyePosition, viewDirection, maxDistance, matcher)
+    return bot.blockAtEntityCursor(bot.entity, maxDistance, matcher)
   }
 
   bot.entityAtCursor = (maxDistance = 3.5) => {
@@ -33,7 +28,7 @@ module.exports = (bot) => {
       .filter(entity => entity.type !== 'object' && entity.username !== bot.username && entity.position.distanceTo(bot.entity.position) <= maxDistance)
 
     const dir = new Vec3(-Math.sin(bot.entity.yaw) * Math.cos(bot.entity.pitch), Math.sin(bot.entity.pitch), -Math.cos(bot.entity.yaw) * Math.cos(bot.entity.pitch))
-    const iterator = new RaycastIterator(bot.entity.position.offset(0, bot.entity.height, 0), dir.normalize(), maxDistance)
+    const iterator = new RaycastIterator(bot.entity.position.offset(0, bot.entity.eyeHeight, 0), dir.normalize(), maxDistance)
 
     let targetEntity = null
     let targetDist = maxDistance
@@ -42,7 +37,7 @@ module.exports = (bot) => {
       const entity = entities[i]
       const w = entity.width / 2
 
-      const shapes = [[-w, 0, -w, w, entity.height + (entity.type === 'player' ? 0.18 : 0), w]]
+      const shapes = [[-w, 0, -w, w, entity.height, w]]
       const intersect = iterator.intersect(shapes, entity.position)
       if (intersect) {
         const entityDir = entity.position.minus(bot.entity.position) // Can be combined into 1 line

package/lib/version.js

@@ -1,4 +1,4 @@
-const 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', '1.20.2', '1.20.4']
+const 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', '1.20.2', '1.20.4', '1.20.6']
 module.exports = {
 
   testedVersions,

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "mineflayer",
-  "version": "4.20.1",
+  "version": "4.22.0",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",
   "scripts": {
-    "mocha_test": "mocha --reporter spec --exit",
+    "mocha_test": "mocha --reporter spec --exit --bail",
     "test": "npm run mocha_test",
     "pretest": "npm run lint",
     "lint": "standard && standard-markdown",
@@ -21,32 +21,33 @@
   },
   "license": "MIT",
   "dependencies": {
-    "minecraft-data": "^3.56.0",
-    "minecraft-protocol": "^1.47.0",
+    "minecraft-data": "^3.76.0",
+    "minecraft-protocol": "^1.49.0",
     "prismarine-biome": "^1.1.1",
     "prismarine-block": "^1.17.0",
     "prismarine-chat": "^1.7.1",
     "prismarine-chunk": "^1.34.0",
     "prismarine-entity": "^2.3.0",
-    "prismarine-item": "^1.14.0",
+    "prismarine-item": "^1.15.0",
     "prismarine-nbt": "^2.0.0",
     "prismarine-physics": "^1.8.0",
     "prismarine-recipe": "^1.3.0",
-    "prismarine-registry": "^1.5.0",
+    "prismarine-registry": "^1.8.0",
     "prismarine-windows": "^2.9.0",
     "prismarine-world": "^3.6.0",
-    "protodef": "^1.14.0",
+    "protodef": "1.17.0",
     "typed-emitter": "^1.0.0",
     "vec3": "^0.1.7"
   },
   "devDependencies": {
-    "@types/node": "^20.2.1",
+    "@types/node": "^22.1.0",
     "doctoc": "^2.0.1",
     "minecraft-wrap": "^1.3.0",
     "mineflayer": "file:.",
     "mocha": "^10.0.0",
+    "protodef-yaml": "^1.5.3",
     "standard": "^17.0.0",
     "standard-markdown": "^7.1.0",
-    "typescript": "^5.0.3"
+    "typescript": "^5.4.5"
   }
 }