mineflayer 3.15.0 → 3.16.0

package/README.md

@@ -16,7 +16,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 and 1.18.
+ * Supports Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17 and 1.18. 
  * 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/FAQ.md

@@ -2,6 +2,13 @@
 
 This Frequently Asked Question document is meant to help people for the most common things.
 
+### I get an error when trying to login with a microsoft account.
+
+Make sure the email you entered into the username option in createBot can be used to login to `minecraft.net` using the 'Login with Microsoft' button.
+Make sure you have the option `auth: 'microsoft'` in your createBot options. 
+
+When you get an error that says something about invalid credentials or 'Does this account own Minecraft?' try removing the password field in the `createBot` options and try again.
+
 ### How to hide errors ?
 
 Use `hideErrors: true` in createBot options
@@ -119,7 +126,7 @@ Note that the order in which plugins are loaded is dynamic, so you should never
 
 ### How can I use a socks5 proxy?
 
-In the options object for `mineflayer.createBot(options)`, remove your `host` option from the options object, have the following variables declared `PROXY_IP, PROXY_PORT, PROXY_USERNAME, PROXY_PASSWORD, MC_SERVER_IP, MC_SERVER_PORT` and add this to your options object:
+In the options object for `mineflayer.createBot(options)`, remove your `host` option from the options object, have the following variables declared `PROXY_IP, PROXY_PORT, PROXY_USERNAME, PROXY_PASSWORD, MC_SERVER_ADDRESS, MC_SERVER_PORT` and add this to your options object:
 ```js
 connect: (client) => {
     socks.createConnection({
@@ -132,7 +139,7 @@ connect: (client) => {
       },
       command: 'connect',
       destination: {
-        host: MC_SERVER_IP,
+        host: MC_SERVER_ADDRESS,
         port: MC_SERVER_PORT
       }
     }, (err, info) => {
@@ -146,6 +153,7 @@ connect: (client) => {
   }
   ```
   `socks` is declared with `const socks = require('socks').SocksClient` and uses [this](https://www.npmjs.com/package/socks) package.
+  Some servers might reject the connection. If that happens try adding `fakeHost: MC_SERVER_ADDRESS` to your createBot options.
   
 # Common Errors
 

package/docs/README.md

@@ -16,7 +16,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 and 1.18.
+ * Supports Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17 and 1.18. 
  * 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/history.md

@@ -1,3 +1,7 @@
+## 3.16.0
+
+* Use prismarine-chunk for block entities
+
 ## 3.15.0
 
 * Supports 1.18

package/docs/zh/README_ZH_CN.md

@@ -10,27 +10,26 @@
 [![Try it on gitpod](https://img.shields.io/badge/try-on%20gitpod-brightgreen.svg)](https://gitpod.io/#https://github.com/PrismarineJS/mineflayer)
 [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/PrismarineJS/mineflayer/blob/master/docs/mineflayer.ipynb)
 
-| <sub>EN</sub> [英语](../README.md) | <sub>RU</sub> [俄语](../ru/README_RU.md) | <sub>ES</sub> [西班牙语](../es/README_ES.md) | <sub>FR</sub> [法语](../fr/README_FR.md) | <sub>TR</sub> [土耳其语](../tr/README_TR.md) | <sub>ZH</sub> [中文](README_ZH_CN.md) |
+| <sub>EN</sub> [English](README.md) | <sub>RU</sub> [русский](ru/README_RU.md) | <sub>ES</sub> [Español](es/README_ES.md) | <sub>FR</sub> [Français](fr/README_FR.md) | <sub>TR</sub> [Türkçe](tr/README_TR.md) | <sub>ZH</sub> [中文](zh/README_ZH_CN.md) |
 |-------------------------|----------------------------|----------------------------|----------------------------|----------------------------|----------------------------|
 
 使用强大、稳定、高级的JavaScript [API](../api.md) 来开发Minecraft机器人，同时支持 Python。
 
-第一次使用 node.js ？你可以先看看 [使用教程](../tutorial.md) 。了解过 Python？这里有一些 [Python实例](https://github.com/PrismarineJS/mineflayer/tree/master/examples/python)，可以 [在谷歌Colab中运行Mineflayer](https://colab.research.google.com/github/PrismarineJS/mineflayer/blob/master/docs/mineflayer.ipynb) 来体验一下。
+第一次使用 node.js ？你可以先看看 [使用教程](../tutorial.md) 。了解过 Python？这里有一些 [Python实例](https://github.com/PrismarineJS/mineflayer/tree/master/examples/python)，同时你也可以 [在谷歌Colab中运行Mineflayer](https://colab.research.google.com/github/PrismarineJS/mineflayer/blob/master/docs/mineflayer.ipynb) 来体验一下。
 
 ## 特点
 
-* 支持版本：Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15 1.16 1.17
-* 实体感知与追踪
-* 方块感知，你可以在几毫秒内查找到bot周围的任何方块
-* 物理和运动引擎 - 支持所有的碰撞箱
-* 攻击实体，使用运载工具
-* 背包管理
-* 使用工作台、箱子、酿造台、附魔台
-* 挖掘和建造
-* 各种各样的的信息接口，比如查看bot的血量和是否下雨
-* 激活方块和使用物品
-* 输入输出聊天信息
-
+ * 支持版本：Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15 1.16 1.17,1.18 
+ * 实体感知与追踪
+ * 方块感知，你可以在几毫秒内查找到bot周围的任何方块
+ * 物理和运动引擎 - 支持所有的碰撞箱
+ * 攻击实体，使用交通工具
+ * 背包管理
+ * 使用工作台、箱子、酿造台、附魔台
+ * 挖掘和建造
+ * 各种各样的的信息接口，比如查看你的血量或是否下雨
+ * 激活方块和使用物品
+ * 进行聊天
 ### 路线图
 
  [点这里](https://github.com/PrismarineJS/mineflayer/wiki/Big-Prismarine-projects) 看看目前我们有哪些实用的项目
@@ -178,7 +177,7 @@ node your_script.js
 
 ## 第三方插件
 
-Mineflayer 是可插拔的；任何人都可以创建一个插件，在 Mineflayer 之上添加更高级别的 API。
+Mineflayer 支持插件；任何人都可以创建一个插件，在 Mineflayer 之上添加更高级别的 API。
 
 最新和最有用的有：
 
@@ -191,8 +190,12 @@ Mineflayer 是可插拔的；任何人都可以创建一个插件，在 Mineflay
 * [Dashboard](https://github.com/wvffle/mineflayer-dashboard) - mineflayer bot 的前端仪表板
 * [PVP](https://github.com/TheDudeFromCI/mineflayer-pvp) - 用于基本 PVP 和 PVE 的简单 API
 * [auto-eat](https://github.com/LINKdiscordd/mineflayer-auto-eat) - 自动进食
-* [Tool](https://github.com/TheDudeFromCI/mineflayer-tool) - 具有高级 API 的自动工具/武器选择实用程序
-* [Hawkeye](https://github.com/sefirosweb/minecraftHawkEye) - 使用弓箭自动瞄准的实用程序
+ * [Auto Crystal](https://github.com/link-discord/mineflayer-autocrystal) - 自动放置和破碎结
+ * [Tool](https://github.com/TheDudeFromCI/mineflayer-tool) - 一个具有高级API的工具/武器自动选择工具的工具
+ * [Hawkeye](https://github.com/sefirosweb/minecraftHawkEye) - 一个使用自动瞄准弓的工具
+ * [GUI](https://github.com/firejoust/mineflayer-GUI) - 简化了嵌套箱子GUI窗口的导航和管理
+ * [Projectile](https://github.com/firejoust/mineflayer-projectile) - 以投射物为基础的战斗的可配置插件
+
 
  也可以看看这些 :
 
@@ -203,13 +206,14 @@ Mineflayer 是可插拔的；任何人都可以创建一个插件，在 Mineflay
 * [Bloodhound](https://github.com/Nixes/mineflayer-bloodhound) - 确定谁和什么对另一个实体的损害负责
 * [tps](https://github.com/SiebeDW/mineflayer-tps) - 获取当前的 tps（已处理的 tps）
 * [panorama](https://github.com/IceTank/mineflayer-panorama) - 拍摄您的世界的全景图像
+ * [player-death-event](https://github.com/tuanzisama/mineflayer-death-event) - 在Mineflayer里监听玩家死亡事件
 
 ## 正在使用 Mineflayer 的项目
 
 * [rom1504/rbot](https://github.com/rom1504/rbot)
-  * [YouTube - building a spiral staircase](https://www.youtube.com/watch?v=UM1ZV5200S0)
-  * [YouTube - replicating a building](https://www.youtube.com/watch?v=0cQxg9uDnzA)
-* [Darthfett/Helperbot](https://github.com/Darthfett/Helperbot)
+  * [YouTube - 建造旋转楼梯](https://www.youtube.com/watch?v=UM1ZV5200S0)
+  * [YouTube - 复制一个建筑](https://www.youtube.com/watch?v=0cQxg9uDnzA)
+* [Darthfett/Helperbot](https://github.com/Darthfett/Helperbot) - 完成一些简单指令
 * [vogonistic/voxel](https://github.com/vogonistic/mineflayer-voxel) - 使用 voxel.js 可视化机器人正在做什么
 * [JonnyD/Skynet](https://github.com/JonnyD/Skynet) -  将玩家活动记录到在线 API 上
 * [MinecraftChat](https://github.com/rom1504/MinecraftChat) （最后一个开源版本，由 AlexKvazos 构建）——基于 Minecraft 网络的聊天客户端 <https://minecraftchat.net/>
@@ -233,6 +237,9 @@ Mineflayer 是可插拔的；任何人都可以创建一个插件，在 Mineflay
 
 运行 `npm mocha_test -- -g <test_name>`，其中 `<test_name>` 是测试名称，例如 `bed`, `useChests`, `rayTrace`...
 
+### 示例
+
+`npm run mocha_test -- -g "1.18.1.*BlockFinder"` 进行1.18.1寻路测试
 ## 许可证
 
 [MIT](../LICENSE)

package/index.d.ts

@@ -189,6 +189,7 @@ export interface Bot extends TypedEmitter<BotEvents> {
   heldItem: Item | null
   currentWindow: Window | null
   simpleClick: simpleClick
+  tablist: Tablist
 
   connect: (options: BotOptions) => void
 
@@ -427,6 +428,11 @@ export interface simpleClick {
   rightMouse: (slot: number) => Promise<void>
 }
 
+export interface Tablist {
+  header: ChatMessage
+  footer: ChatMessage
+}
+
 export interface chatPatternOptions {
   repeat: boolean
   parse: boolean
@@ -796,7 +802,7 @@ export class Team {
 
   update (name: string, friendlyFire: boolean, nameTagVisibility: string, collisionRule: string, formatting: number, prefix: string, suffix: string): void;
 
-  displayName (member: string);
+  displayName (member: string): ChatMessage;
 }
 
 export type DisplaySlot =

package/lib/features.json

@@ -328,5 +328,10 @@
     "name": "tallWorld",
     "description": "world starts at -64 and ends at 384",
     "versions": ["1.18", "1.18.1"]
+  },
+  {
+    "name": "sendStringifiedSignText",
+    "description": "sign text send when updating signs is send as stringified strings",
+    "versions": ["1.8", "1.8.9"]
   }
 ]

package/lib/plugins/blocks.js

@@ -21,17 +21,12 @@ const dimensionNames = {
 }
 
 function inject (bot, { version, storageBuilder }) {
-  const nbt = require('prismarine-nbt')
   const Block = require('prismarine-block')(version)
   const Chunk = require('prismarine-chunk')(version)
-  const ChatMessage = require('prismarine-chat')(version)
   const World = require('prismarine-world')(version)
-  const signs = {}
   const paintingsByPos = {}
   const paintingsById = {}
 
-  const blockEntities = new Map()
-
   function addPainting (painting) {
     paintingsById[painting.id] = painting
     paintingsByPos[painting.position] = painting
@@ -42,43 +37,6 @@ function inject (bot, { version, storageBuilder }) {
     delete paintingsByPos[painting.position]
   }
 
-  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' || blockEntity.type === signType) {
-      const prepareJson = (i) => {
-        const data = blockEntity[`Text${i}`]
-
-        if (data === null || data === '') return ''
-
-        const json = JSON.parse(data)
-        if (json === null || !('text' in json)) return ''
-
-        json.text = json.text.replace(/^"|"$/g, '')
-        return json
-      }
-
-      blockEntity.Text1 = new ChatMessage(prepareJson(1))
-      blockEntity.Text2 = new ChatMessage(prepareJson(2))
-      blockEntity.Text3 = new ChatMessage(prepareJson(3))
-      blockEntity.Text4 = new ChatMessage(prepareJson(4))
-
-      signs[pos] = [
-        blockEntity.Text1.toString(),
-        blockEntity.Text2.toString(),
-        blockEntity.Text3.toString(),
-        blockEntity.Text4.toString()
-      ].join('\n')
-    }
-
-    blockEntities[pos] = blockEntity
-  }
-
   function delColumn (chunkX, chunkZ) {
     bot.world.unloadColumn(chunkX, chunkZ)
   }
@@ -254,9 +212,7 @@ function inject (bot, { version, storageBuilder }) {
     if (!block) return null
 
     if (extraInfos) {
-      block.signText = signs[block.position]
       block.painting = paintingsByPos[block.position]
-      block.blockEntity = blockEntities[block.position]
     }
 
     return block
@@ -293,9 +249,6 @@ function inject (bot, { version, storageBuilder }) {
     }
     if (oldBlock.type !== newBlock.type) {
       const pos = point.floored()
-      delete blockEntities[pos]
-      delete signs[pos]
-
       const painting = paintingsByPos[pos]
       if (painting) deletePainting(painting)
     }
@@ -335,11 +288,13 @@ function inject (bot, { version, storageBuilder }) {
     })
 
     if (typeof packet.blockEntities !== 'undefined') {
+      const column = bot.world.getColumn(packet.x, packet.z)
       for (const blockEntity of packet.blockEntities) {
-        if (blockEntity.x !== undefined) {
-          addBlockEntity(blockEntity.nbtData, blockEntity.x, blockEntity.y, blockEntity.z, blockEntity.type)
+        if (blockEntity.x !== undefined) { // 1.17+
+          column.setBlockEntity(blockEntity, blockEntity.nbtData)
         } else {
-          addBlockEntity(blockEntity)
+          const pos = new Vec3(blockEntity.value.x.value & 0xf, blockEntity.value.y.value, blockEntity.value.z.value & 0xf)
+          column.setBlockEntity(pos, blockEntity)
         }
       }
     }
@@ -434,36 +389,33 @@ function inject (bot, { version, storageBuilder }) {
   })
 
   bot._client.on('update_sign', (packet) => {
-    const pos = new Vec3(packet.location.x, packet.location.y, packet.location.z)
-
-    const prepareString = (i) => {
-      let text = packet[`text${i}`]
+    const pos = new Vec3(packet.location.x & 0xf, packet.location.y, packet.location.z & 0xf)
 
-      if (text === 'null' || text === '') {
-        text = '""'
-      }
-
-      const json = JSON.parse(text)
-      if (json.text) {
-        json.text = json.text.replace(/^"|"$/g, '')
-      }
-
-      return new ChatMessage(json)
+    // TODO: warn if out of loaded world?
+    const column = bot.world.getColumn(packet.location.x >> 4, packet.location.z >> 4)
+    if (!column) {
+      return
     }
 
-    signs[pos] = [
-      prepareString(1),
-      prepareString(2),
-      prepareString(3),
-      prepareString(4)
-    ].join('\n')
+    const blockAt = column.getBlock(pos)
+
+    blockAt.signText = [packet.text1, packet.text2, packet.text3, packet.text4].map(text => {
+      if (text === 'null' || text === '') return ''
+      return JSON.parse(text)
+    })
+    column.setBlock(pos, blockAt)
   })
 
   bot._client.on('tile_entity_data', (packet) => {
     if (packet.location !== undefined) {
-      addBlockEntity(packet.nbtData, packet.location.x, packet.location.y, packet.location.z, packet.action)
+      const column = bot.world.getColumn(packet.location.x >> 4, packet.location.z >> 4)
+      const pos = new Vec3(packet.location.x & 0xf, packet.location.y, packet.location.z & 0xf)
+      column.setBlockEntity(pos, packet.nbtData)
     } else {
-      addBlockEntity(packet.nbtData)
+      const tag = packet.nbtData
+      const column = bot.world.getColumn(tag.value.x.value >> 4, tag.value.z.value >> 4)
+      const pos = new Vec3(tag.value.x.value & 0xf, tag.value.y.value, tag.value.z.value & 0xf)
+      column.setBlockEntity(pos, tag)
     }
   })
 
@@ -480,12 +432,25 @@ function inject (bot, { version, storageBuilder }) {
       }
     }
 
+    let signData
+    if (bot.supportFeature('sendStringifiedSignText')) {
+      signData = {
+        text1: lines[0] ? JSON.stringify(lines[0]) : '""',
+        text2: lines[1] ? JSON.stringify(lines[1]) : '""',
+        text3: lines[2] ? JSON.stringify(lines[2]) : '""',
+        text4: lines[3] ? JSON.stringify(lines[3]) : '""'
+      }
+    } else {
+      signData = {
+        text1: lines[0] ?? '',
+        text2: lines[1] ?? '',
+        text3: lines[2] ?? '',
+        text4: lines[3] ?? ''
+      }
+    }
     bot._client.write('update_sign', {
       location: block.position,
-      text1: JSON.stringify(lines[0]),
-      text2: JSON.stringify(lines[1]),
-      text3: JSON.stringify(lines[2]),
-      text4: JSON.stringify(lines[3])
+      ...signData
     })
   }
 
@@ -583,7 +548,6 @@ function inject (bot, { version, storageBuilder }) {
   bot.canSeeBlock = canSeeBlock
   bot.blockAt = blockAt
   bot._updateBlockState = updateBlockState
-  bot._blockEntities = blockEntities
   bot.waitForChunksToLoad = callbackify(waitForChunksToLoad)
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mineflayer",
-  "version": "3.15.0",
+  "version": "3.16.0",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",
@@ -24,9 +24,9 @@
     "minecraft-data": "^2.109.0",
     "minecraft-protocol": "^1.26.5",
     "prismarine-biome": "^1.1.1",
-    "prismarine-block": "^1.10.3",
+    "prismarine-block": "^1.13.1",
     "prismarine-chat": "^1.3.3",
-    "prismarine-chunk": "^1.28.1",
+    "prismarine-chunk": "^1.29.0",
     "prismarine-entity": "^2.0.0",
     "prismarine-item": "^1.11.0",
     "prismarine-nbt": "^2.0.0",
@@ -35,7 +35,7 @@
     "prismarine-windows": "^2.4.2",
     "prismarine-world": "^3.6.0",
     "protodef": "^1.14.0",
-    "typed-emitter": "^2.0.0",
+    "typed-emitter": "^1.0.0",
     "vec3": "^0.1.7"
   },
   "devDependencies": {