mineflayer 4.17.0 → 4.18.0

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.1 (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.2 (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
@@ -35,7 +35,7 @@ First time using Node.js? You may want to start with the [tutorial](tutorial.md)
 
 ## Installation
 
-First install Node.js >= 14 from [nodejs.org](https://nodejs.org/) then:
+First install Node.js >= 18 from [nodejs.org](https://nodejs.org/) then:
 
 `npm install mineflayer`
 

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.1 (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.2 (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
@@ -35,7 +35,7 @@ First time using Node.js? You may want to start with the [tutorial](tutorial.md)
 
 ## Installation
 
-First install Node.js >= 14 from [nodejs.org](https://nodejs.org/) then:
+First install Node.js >= 18 from [nodejs.org](https://nodejs.org/) then:
 
 `npm install mineflayer`
 

package/docs/api.md

@@ -225,7 +225,7 @@
       - ["blockBreakProgressEnd" (block, entity)](#blockbreakprogressend-block-entity)
       - ["diggingCompleted" (block)](#diggingcompleted-block)
       - ["diggingAborted" (block)](#diggingaborted-block)
-      - ["usedFirework"](#usedfirework)
+      - ["usedfirework"](#usedfirework)
       - ["move"](#move)
       - ["forcedMove"](#forcedmove)
       - ["mount"](#mount)
@@ -291,7 +291,7 @@
       - [bot.getExplosionDamages(entity, position, radius, [rawDamages])](#botgetexplosiondamagesentity-position-radius-rawdamages)
       - [bot.lookAt(point, [force])](#botlookatpoint-force)
       - [bot.look(yaw, pitch, [force])](#botlookyaw-pitch-force)
-      - [bot.updateSign(block, text)](#botupdatesignblock-text)
+      - [bot.updateSign(block, text, back = false)](#botupdatesignblock-text-back--false)
       - [bot.equip(item, destination)](#botequipitem-destination)
       - [bot.unequip(destination)](#botunequipdestination)
       - [bot.tossStack(item)](#bottossstackitem)
@@ -331,6 +331,7 @@
       - [bot.setCommandBlock(pos, command, [options])](#botsetcommandblockpos-command-options)
       - [bot.supportFeature(name)](#botsupportfeaturename)
       - [bot.waitForTicks(ticks)](#botwaitforticksticks)
+      - [bot.respawn()](#botrespawn)
     - [Lower level inventory methods](#lower-level-inventory-methods)
       - [bot.clickWindow(slot, mouseButton, mode)](#botclickwindowslot-mousebutton-mode)
       - [bot.putSelectedItemRange(start, end, window, slot)](#botputselecteditemrangestart-end-window-slot)
@@ -2103,6 +2104,10 @@ The list of available features can be found inside the [./lib/features.json](htt
 
 This is a promise-based function that waits for a given number of in-game ticks to pass before continuing. This is useful for quick timers that need to function with specific timing, regardless of the given physics tick speed of the bot. This is similar to the standard Javascript setTimeout function, but runs on the physics timer of the bot specifically.
 
+#### bot.respawn()
+
+When `respawn` option is disabled, you can call this method manually to respawn.
+
 ### Lower level inventory methods
 
 These are lower level methods for the inventory, they can be useful sometimes but prefer the inventory methods presented above if you can.

package/docs/br/README_BR.md

@@ -33,7 +33,7 @@ Primeira vez usando o Node.js? Você pode querer começar com o tutorial [tutori
 - Dê uma olhada em nossos [projetos atuais](https://github.com/PrismarineJS/mineflayer/wiki/Big-Prismarine-projects)
 
 ## Instalação
-- Primeiro, instale o Node.js >= 14 a partir do [nodejs.org](https://nodejs.org/)
+- Primeiro, instale o Node.js >= 18 a partir do [nodejs.org](https://nodejs.org/)
 
 `npm install mineflayer`
 

package/docs/es/README_ES.md

@@ -34,7 +34,7 @@ Crea bots para Minecraft con una API de JavaScript potente, estable y de alto ni
 Echa un vistazo a nuestros [proyectos actuales](https://github.com/PrismarineJS/mineflayer/wiki/Big-Prismarine-projects)
 
 ## Instalación
-Primero instala Node.js >= 14 desde [nodejs.org](https://nodejs.org/)
+Primero instala Node.js >= 18 desde [nodejs.org](https://nodejs.org/)
 
 `npm install mineflayer`
 

package/docs/history.md

@@ -1,3 +1,10 @@
+## 4.18.0
+* [Minecraft 1.20.2 support (#3262)](https://github.com/PrismarineJS/mineflayer/commit/2ff9919760d714be57dcb678f8ab5ecff69f5fee) (thanks @rom1504)
+* [Update recommended Node.js version (#3279)](https://github.com/PrismarineJS/mineflayer/commit/5c71edf48bb2f2dfa16cddb9af5baa0c4d55cf0d) (thanks @Nyaasu66)
+* [feat: bot.respawn, fix respawn with flying squid (#3206)](https://github.com/PrismarineJS/mineflayer/commit/3a6ce543b4ba8a3d0f55777670d142968af14571) (thanks @zardoy)
+* [Add `maxCatchupTicks`, improve `supportFeature` typing (#3277)](https://github.com/PrismarineJS/mineflayer/commit/91108d392c4c5800204dd4674ce9247495ac98e0) (thanks @zardoy)
+* [Fixed typo of "fromt" to "from" (#3273)](https://github.com/PrismarineJS/mineflayer/commit/216cab742db1cd053d9fa23bd7293b770239085b) (thanks @BorretSquared)
+
 ## 4.17.0
 * [Exclude browser from node version check (#3268)](https://github.com/PrismarineJS/mineflayer/commit/c466d327227796865c53bfd24e66668911be4af5) (thanks @rom1504)
 * [Fix for a possible error in lib/plugins/entities.js file (#3254)](https://github.com/PrismarineJS/mineflayer/commit/15cfeb4fa59edfcddf7a0b70a966294b24d798ed) (thanks @Mykola1453)

package/docs/mineflayer.ipynb

@@ -368,7 +368,7 @@
         "mcData = require('minecraft-data')(bot.version)\n",
         "# Create a new movements class\n",
         "movements = pathfinder.Movements(bot, mcData)\n",
-        "# How far to be fromt the goal\n",
+        "# How far to be from the goal\n",
         "RANGE_GOAL = 1"
       ],
       "execution_count": null,
@@ -531,4 +531,4 @@
       ]
     }
   ]
-}
+}

package/docs/ru/README_RU.md

@@ -35,7 +35,7 @@
  
 ## Установка
 
-Сначала установите Node.js >= 14 из [nodejs.org](https://nodejs.org/), затем выполните:
+Сначала установите Node.js >= 18 из [nodejs.org](https://nodejs.org/), затем выполните:
 
 `npm install mineflayer`
 

package/docs/zh/README_ZH_CN.md

@@ -36,7 +36,7 @@
 
 ## 安装
 
-首先，从 [nodejs.org](https://nodejs.org/) 安装 nodejs（版本要求 >= 14），
+首先，从 [nodejs.org](https://nodejs.org/) 安装 nodejs（版本要求 >= 18），
 
 然后在你创建的bot项目目录中，使用命令行运行：
 

package/examples/pathfinder/package.json

@@ -3,7 +3,7 @@
   "version": "0.0.0",
   "private": true,
   "dependencies": {
-    "mineflayer-pathfinder": "^1.6.1",
+    "mineflayer-pathfinder": "^2.4.5",
     "mineflayer": "file:../../"
   },
   "description": "A mineflayer example"

package/index.d.ts

@@ -10,6 +10,7 @@ import { Entity } from 'prismarine-entity'
 import { ChatMessage } from 'prismarine-chat'
 import { world } from 'prismarine-world'
 import { Registry } from 'prismarine-registry'
+import { IndexedData } from 'minecraft-data'
 
 export function createBot (options: { client: Client } & Partial<BotOptions>): Bot
 export function createBot (options: BotOptions): Bot
@@ -26,6 +27,8 @@ export interface BotOptions extends ClientOptions {
   difficulty?: number
   chatLengthLimit?: number
   physicsEnabled?: boolean
+  /** @default 4 */
+  maxCatchupTicks?: number
   client?: Client
   brand?: string
   defaultChatPatterns?: boolean
@@ -64,6 +67,7 @@ export interface BotEvents {
   unmatchedMessage: (stringMsg: string, jsonMsg: ChatMessage) => Promise<void> | void
   inject_allowed: () => Promise<void> | void
   login: () => Promise<void> | void
+  /** When `respawn` option is disabled, you can call this method manually to respawn. */
   spawn: () => Promise<void> | void
   respawn: () => Promise<void> | void
   game: () => Promise<void> | void
@@ -204,7 +208,7 @@ export interface Bot extends TypedEmitter<BotEvents> {
 
   connect: (options: BotOptions) => void
 
-  supportFeature: (feature: string) => boolean
+  supportFeature: IndexedData['supportFeature']
 
   end: (reason?: string) => void
 
@@ -424,6 +428,8 @@ export interface Bot extends TypedEmitter<BotEvents> {
   acceptResourcePack: () => void
 
   denyResourcePack: () => void
+
+  respawn: () => void
 }
 
 export interface simpleClick {

package/lib/plugins/blocks.js

@@ -268,6 +268,30 @@ function inject (bot, { version, storageBuilder, hideErrors }) {
     }
   })
 
+  // Chunk batches are used by the server to throttle the chunks per tick for players based on their connection speed.
+  let chunkBatchStartTime = 0
+  // The Vanilla client uses nano seconds with its weighted average starting at 2000000 converted to milliseconds that is 2
+  let weightedAverage = 2
+  // This is used for keeping track of the weight of the old average when updating it.
+  let oldSampleWeight = 1
+
+  bot._client.on('chunk_batch_start', (packet) => {
+    // Get the time the chunk batch is starting.
+    chunkBatchStartTime = Date.now()
+  })
+
+  bot._client.on('chunk_batch_finished', (packet) => {
+    const milliPerChunk = (Date.now() - chunkBatchStartTime) / packet.batchSize
+    // Prevents the MilliPerChunk from being hugely different then the average, Vanilla uses 3 as a constant here.
+    const clampedMilliPerChunk = Math.min(Math.max(milliPerChunk, weightedAverage / 3.0), weightedAverage * 3.0)
+    weightedAverage = ((weightedAverage * oldSampleWeight) + clampedMilliPerChunk) / (oldSampleWeight + 1)
+    // 49 is used in Vanilla client to limit it to 50 samples
+    oldSampleWeight = Math.min(49, oldSampleWeight + 1)
+    bot._client.write('chunk_batch_received', {
+      // Vanilla uses 7000000 as a constant here, since we are using milliseconds that is now 7. Not sure why they pick this constant to convert from nano seconds per chunk to chunks per tick.
+      chunksPerTick: 7 / weightedAverage
+    })
+  })
   bot._client.on('map_chunk', (packet) => {
     addColumn({
       x: packet.x,

package/lib/plugins/entities.js

@@ -26,7 +26,7 @@ const entityStatusEvents = {
 }
 
 function inject (bot) {
-  const { mobs, entitiesArray } = bot.registry
+  const { mobs } = bot.registry
   const Entity = require('prismarine-entity')(bot.version)
   const Item = require('prismarine-item')(bot.version)
   const ChatMessage = require('prismarine-chat')(bot.registry)
@@ -129,33 +129,6 @@ function inject (bot) {
     if (eventName) bot.emit(eventName, entity)
   })
 
-  bot._client.on('named_entity_spawn', (packet) => {
-    // in case player_info packet was not sent before named_entity_spawn : ignore named_entity_spawn (see #213)
-    if (packet.playerUUID in bot.uuidToUsername) {
-      // spawn named entity
-      const entity = fetchEntity(packet.entityId)
-      entity.type = 'player'
-      entity.name = 'player'
-      entity.username = bot.uuidToUsername[packet.playerUUID]
-      entity.uuid = packet.playerUUID
-      entity.dataBlobs = packet.data
-      if (bot.supportFeature('fixedPointPosition')) {
-        entity.position.set(packet.x / 32, packet.y / 32, packet.z / 32)
-      } else if (bot.supportFeature('doublePosition')) {
-        entity.position.set(packet.x, packet.y, packet.z)
-      }
-      entity.yaw = conv.fromNotchianYawByte(packet.yaw)
-      entity.pitch = conv.fromNotchianPitchByte(packet.pitch)
-      entity.height = NAMED_ENTITY_HEIGHT
-      entity.width = NAMED_ENTITY_WIDTH
-      entity.metadata = parseMetadata(packet.metadata, entity.metadata)
-      if (bot.players[entity.username] !== undefined && !bot.players[entity.username].entity) {
-        bot.players[entity.username].entity = entity
-      }
-      bot.emit('entitySpawn', entity)
-    }
-  })
-
   bot.on('entityCrouch', (entity) => {
     entity.height = CROUCH_HEIGHT
   })
@@ -171,10 +144,11 @@ function inject (bot) {
     bot.emit('playerCollect', collector, collected)
   })
 
+  // What is internalId?
+  const entityDataByInternalId = Object.fromEntries(bot.registry.entitiesArray.map((e) => [e.internalId, e]))
+
   function setEntityData (entity, type, entityData) {
-    if (entityData === undefined) {
-      entityData = entitiesArray.find(entity => entity.internalId === type)
-    }
+    entityData ??= entityDataByInternalId[type]
     if (entityData) {
       entity.type = entityData.type || 'object'
       entity.displayName = entityData.displayName
@@ -193,24 +167,57 @@ function inject (bot) {
     }
   }
 
-  // spawn object/vehicle on versions < 1.19, on versions > 1.19 handles all non-player entities
-  bot._client.on('spawn_entity', (packet) => {
-    const entity = fetchEntity(packet.entityId)
-    const entityData = bot.registry.entities[packet.type]
-    setEntityData(entity, packet.type, entityData)
-
+  function updateEntityPos (entity, pos) {
     if (bot.supportFeature('fixedPointPosition')) {
-      entity.position.set(packet.x / 32, packet.y / 32, packet.z / 32)
+      entity.position.set(pos.x / 32, pos.y / 32, pos.z / 32)
     } else if (bot.supportFeature('doublePosition')) {
-      entity.position.set(packet.x, packet.y, packet.z)
-    } else if (bot.supportFeature('consolidatedEntitySpawnPacket')) {
-      entity.headPitch = conv.fromNotchianPitchByte(packet.headPitch)
+      entity.position.set(pos.x, pos.y, pos.z)
     }
+    entity.yaw = conv.fromNotchianYawByte(pos.yaw)
+    entity.pitch = conv.fromNotchianPitchByte(pos.pitch)
+  }
 
-    entity.uuid = packet.objectUUID
-    entity.yaw = conv.fromNotchianYawByte(packet.yaw)
-    entity.pitch = conv.fromNotchianPitchByte(packet.pitch)
-    entity.objectData = packet.objectData
+  function addNewPlayer (entityId, uuid, pos) {
+    const entity = fetchEntity(entityId)
+    entity.type = 'player'
+    entity.name = 'player'
+    entity.username = bot.uuidToUsername[uuid]
+    entity.uuid = uuid
+    updateEntityPos(entity, pos)
+    entity.height = NAMED_ENTITY_HEIGHT
+    entity.width = NAMED_ENTITY_WIDTH
+    if (bot.players[entity.username] !== undefined && !bot.players[entity.username].entity) {
+      bot.players[entity.username].entity = entity
+    }
+    return entity
+  }
+
+  function addNewNonPlayer (entityId, uuid, entityType, pos) {
+    const entity = fetchEntity(entityId)
+    const entityData = bot.registry.entities[entityType]
+    setEntityData(entity, entityType, entityData)
+    updateEntityPos(entity, pos)
+    return entity
+  }
+
+  bot._client.on('named_entity_spawn', (packet) => {
+    // in case player_info packet was not sent before named_entity_spawn : ignore named_entity_spawn (see #213)
+    if (packet.playerUUID in bot.uuidToUsername) {
+      // spawn named entity
+      const entity = addNewPlayer(packet.entityId, packet.playerUUID, packet, packet.metadata)
+      entity.dataBlobs = packet.data // this field doesn't appear to be listed on any version
+      entity.metadata = parseMetadata(packet.metadata, entity.metadata) // 1.8
+      bot.emit('entitySpawn', entity)
+    }
+  })
+
+  // spawn object/vehicle on versions < 1.19, on versions > 1.19 handles all non-player entities
+  // on versions >= 1.20.2, this also handles player entities
+  bot._client.on('spawn_entity', (packet) => {
+    const entityData = entityDataByInternalId[packet.type]
+    const entity = entityData?.type === 'player'
+      ? addNewPlayer(packet.entityId, packet.objectUUID, packet)
+      : addNewNonPlayer(packet.entityId, packet.objectUUID, packet.type, packet)
     bot.emit('entitySpawn', entity)
   })
 

package/lib/plugins/game.js

@@ -71,6 +71,11 @@ function inject (bot, options) {
   const brandChannel = getBrandCustomChannelName()
   bot._client.registerChannel(brandChannel, ['string', []])
 
+  // 1.20.2
+  bot._client.on('registry_data', (packet) => {
+    bot.registry.loadDimensionCodec(packet.codec)
+  })
+
   bot._client.on('login', (packet) => {
     handleRespawnPacketData(packet)
 

package/lib/plugins/health.js

@@ -25,10 +25,17 @@ function inject (bot, options) {
         bot.emit('death')
       }
       if (!options.respawn) return
-      bot._client.write('client_command', { payload: 0 })
+      bot.respawn()
     } else if (bot.health > 0 && !bot.isAlive) {
       bot.isAlive = true
       bot.emit('spawn')
     }
   })
+
+  const respawn = () => {
+    if (bot.isAlive) return
+    bot._client.write('client_command', bot.supportFeature('respawnIsPayload') ? { payload: 0 } : { actionId: 0 })
+  }
+
+  bot.respawn = respawn
 }

package/lib/version.js

@@ -1,6 +1,8 @@
-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']
+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']
 module.exports = {
+
   testedVersions,
   latestSupportedVersion: testedVersions[testedVersions.length - 1],
   oldestSupportedVersion: testedVersions[0]
+
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mineflayer",
-  "version": "4.17.0",
+  "version": "4.18.0",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",
@@ -17,11 +17,11 @@
     "url": "git://github.com/PrismarineJS/mineflayer.git"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=18"
   },
   "license": "MIT",
   "dependencies": {
-    "minecraft-data": "^3.44.0",
+    "minecraft-data": "^3.56.0",
     "minecraft-protocol": "^1.44.0",
     "prismarine-biome": "^1.1.1",
     "prismarine-block": "^1.17.0",