mineflayer 3.14.0 → 3.17.0

package/.github/FUNDING.yml

@@ -1 +1,4 @@
 # These are supported funding model platforms
+open_collective: prismarinejs
+custom: https://rysolv.com/repos/detail/74691b23-938d-4b2f-b65a-5c47bf5b3f0f
+github: PrismarineJS

package/.github/workflows/ci.yml

@@ -27,6 +27,8 @@ jobs:
         include:
          - javaVersion: 16
            mcVersion: '1.17.1'
+         - javaVersion: 17
+           mcVersion: '1.18.1'
       fail-fast: false
 
     steps:

package/README.md

@@ -2,10 +2,11 @@
 
 [![NPM version](https://badge.fury.io/js/mineflayer.svg)](https://www.npmjs.com/package/mineflayer)
 [![Build Status](https://github.com/PrismarineJS/mineflayer/workflows/CI/badge.svg)](https://github.com/PrismarineJS/mineflayer/actions?query=workflow%3A%22CI%22)
-[![Discord](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](https://discord.gg/GsEFRM8)
-[![Issue Hunt](https://github.com/BoostIO/issuehunt-materials/blob/master/v1/issuehunt-shield-v1.svg)](https://issuehunt.io/r/PrismarineJS/mineflayer)
 [![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)
+[![GitHub Sponsors](https://img.shields.io/github/sponsors/PrismarineJS)](https://github.com/sponsors/PrismarineJS)
+
+[![Official Discord](https://user-images.githubusercontent.com/61137113/152664460-65e41506-098b-497c-8938-8f54f7a600cc.svg)](https://discord.gg/GsEFRM8)
 
 | <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) |
 |-------------------------|----------------------------|----------------------------|----------------------------|----------------------------|----------------------------|
@@ -16,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 and 1.17.
+ * 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
@@ -31,7 +32,7 @@ First time using Node.js? You may want to start with the [tutorial](tutorial.md)
 ### Roadmap
 
  Checkout [this page](https://github.com/PrismarineJS/mineflayer/wiki/Big-Prismarine-projects) to see what our current projects are.
- 
+
 ## Installation
 
 First install Node.js >= 14 from [nodejs.org](https://nodejs.org/) then:
@@ -230,10 +231,14 @@ The most updated and useful are :
 Simply run: `npm test`
 
 ### Testing specific version
-Run `npm mocha_test -- -g <version>`, where `<version>` is a minecraft version like `1.12`, `1.15.2`...
+Run `npm run mocha_test -- -g <version>`, where `<version>` is a minecraft version like `1.12`, `1.15.2`...
 
 ### Testing specific test
-Run `npm mocha_test -- -g <test_name>`, where `<test_name>` is a name of the test like `bed`, `useChests`, `rayTrace`...
+Run `npm run mocha_test -- -g <test_name>`, where `<test_name>` is a name of the test like `bed`, `useChests`, `rayTrace`...
+
+### Example
+
+`npm run mocha_test -- -g "1.18.1.*BlockFinder"` to run the block finder test for 1.18.1
 
 ## License
 

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

@@ -2,10 +2,11 @@
 
 [![NPM version](https://badge.fury.io/js/mineflayer.svg)](https://www.npmjs.com/package/mineflayer)
 [![Build Status](https://github.com/PrismarineJS/mineflayer/workflows/CI/badge.svg)](https://github.com/PrismarineJS/mineflayer/actions?query=workflow%3A%22CI%22)
-[![Discord](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](https://discord.gg/GsEFRM8)
-[![Issue Hunt](https://github.com/BoostIO/issuehunt-materials/blob/master/v1/issuehunt-shield-v1.svg)](https://issuehunt.io/r/PrismarineJS/mineflayer)
 [![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)
+[![GitHub Sponsors](https://img.shields.io/github/sponsors/PrismarineJS)](https://github.com/sponsors/PrismarineJS)
+
+[![Official Discord](https://user-images.githubusercontent.com/61137113/152664460-65e41506-098b-497c-8938-8f54f7a600cc.svg)](https://discord.gg/GsEFRM8)
 
 | <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) |
 |-------------------------|----------------------------|----------------------------|----------------------------|----------------------------|----------------------------|
@@ -16,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 and 1.17.
+ * 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
@@ -31,7 +32,7 @@ First time using Node.js? You may want to start with the [tutorial](tutorial.md)
 ### Roadmap
 
  Checkout [this page](https://github.com/PrismarineJS/mineflayer/wiki/Big-Prismarine-projects) to see what our current projects are.
- 
+
 ## Installation
 
 First install Node.js >= 14 from [nodejs.org](https://nodejs.org/) then:
@@ -230,10 +231,14 @@ The most updated and useful are :
 Simply run: `npm test`
 
 ### Testing specific version
-Run `npm mocha_test -- -g <version>`, where `<version>` is a minecraft version like `1.12`, `1.15.2`...
+Run `npm run mocha_test -- -g <version>`, where `<version>` is a minecraft version like `1.12`, `1.15.2`...
 
 ### Testing specific test
-Run `npm mocha_test -- -g <test_name>`, where `<test_name>` is a name of the test like `bed`, `useChests`, `rayTrace`...
+Run `npm run mocha_test -- -g <test_name>`, where `<test_name>` is a name of the test like `bed`, `useChests`, `rayTrace`...
+
+### Example
+
+`npm run mocha_test -- -g "1.18.1.*BlockFinder"` to run the block finder test for 1.18.1
 
 ## License
 

package/docs/api.md

@@ -818,6 +818,14 @@ Whether the bot is using the item that it's holding, for example eating food or
 
 #### bot.game.serverBrand
 
+#### bot.game.minY
+
+minimum y of the world
+
+#### bot.game.height
+
+world height
+
 ### bot.physicsEnabled
 
 Enable physics, default true.

package/docs/history.md

@@ -1,3 +1,19 @@
+## 3.17.0
+
+* callback are now depreciated with mineflayer. Any use of them will print a warning
+
+## 3.16.0
+
+* Use prismarine-chunk for block entities
+
+## 3.15.0
+
+* Supports 1.18
+
+## 3.14.1
+
+* Fix arm_animation and use_entity (@amorashi)
+
 ## 3.14.0
 
 * Make prismarine-entity versioned (@u9g)

package/docs/zh/CONTRIBUTING.md

@@ -0,0 +1,93 @@
+# 贡献
+
+Mineflayer 最初主要是由 [andrewrk](http://github.com/andrewrk) 制作的
+但自那以后，许多[贡献者](https://github.com/andrewrk/mineflayer/graphs/contributors)对其进行了改进和修复 
+所以知道如何为mineflayer做出贡献的最佳方式很重要
+
+## Issue organization
+
+我们有3个阶段标签来尝试组织Issue:
+
+* Stage 1: 只是由项目新手创建的，我们还不知道它是否值得实现/修复
+* Stage 2: 有希望的想法，但在实施前需要更多思考
+* Stage 3: 想法被精确地指定了，就剩写代码了
+
+链接如 https://github.com/PrismarineJS/mineflayer/issues?q=is%3Aopen+is%3Aissue+-label%3AStage1 can be used to filter out stage 1 if you're looking for things that are ready for contribution
+
+## 创建测试
+Mineflayer 有两种测试 :
+
+ * [internal tests](test/internalTest.js) : 针对使用node-minecraft-protocol创建的简单服务器进行的测试
+ * [external tests](test/externalTests/) : 针对原版服务器进行的测试
+
+The objective of these tests is to know automatically what works and what doesn't in mineflayer, so it's easier to make mineflayer work.
+
+### 创建外部测试
+
+In order to add an external test now you only need to create a file in [test/externalTests](test/externalTests)
+
+一个例子 : [test/externalTests/digAndBuild.js](https://github.com/PrismarineJS/mineflayer/blob/master/test/externalTests/digAndBuild.js)
+
+That file needs to export a function returning a function or an array of function taking as parameter the bot object and a done callback,
+ it should contain asserts to test if the tested functionality failed.
+
+
+## 创建第三方插件
+Mineflayer 是可扩展的插件化的； 任何人都可以创建一个插件，在 Mineflayer 之上添加更高级别的 API。
+
+已经开发了几个这样的第三方插件 [查看](https://github.com/andrewrk/mineflayer#third-party-plugins)
+
+为了创建一个新的，您需要 :
+
+1. 创建一个新的 repo
+2. 在你的 index.js 文件中, 导出一个接受参数 mineflayer 的 init 函数 ([查看例子](https://github.com/andrewrk/mineflayer-navigate/blob/e24cb6a868ce64ae43bea2d035832c15ed01d301/index.js#L18))
+3. that function returns a inject function taking in argument the bot object ([example](https://github.com/andrewrk/mineflayer-navigate/blob/e24cb6a868ce64ae43bea2d035832c15ed01d301/index.js#L23))
+4. that inject function add functionalities to the bot object ([example](https://github.com/andrewrk/mineflayer-navigate/blob/e24cb6a868ce64ae43bea2d035832c15ed01d301/index.js#L32))
+
+Since the mineflayer object is passed in parameter, that new package doesn't need to depend on mineflayer (no mineflayer dependency in the package.json)
+
+参考 [全部示例](https://github.com/andrewrk/mineflayer-navigate/tree/e24cb6a868ce64ae43bea2d035832c15ed01d301) 
+
+## 反馈Bug
+Mineflayer 在大多数情况下都能很好地工作，但有时仍然存在bug.
+
+找到一个问题时，最好报告一个提供这些信息的问题 :
+
+* 你想做什么 (英语目标)
+* 你尝试过什么 (代码)
+* 发生了什么事
+* 你期望会发生什么
+
+## Mineflayer 代码
+提交请求或提交提交时需要考虑的一些事情 :
+
+### 错误处理
+在大多数情况下，mineflayer不会让机器人崩溃。即使有些东西失败了，机器人也可以选择另一条路线来达到它的目标。
+
+这意味着我们不应该使用 `throw(new Error("error"))` 而是使用node.js约定在回调中传递错误。
+
+例如 : 
+
+```js
+function myfunction (param1, callback) {
+  // do stuff
+  let toDo = 1
+  toDo = 2
+  if (toDo === 2) { // 一切正常
+    callback()
+  } else {
+    callback(new Error('什么东西出错了'))
+  }
+}
+```
+
+请参考另一个例子 [mineflayer code](https://github.com/andrewrk/mineflayer/blob/a8736c4ea473cf1a609c5a29046c0cdad006d429/lib/plugins/bed.js#L10)
+
+### 更新文档
+docs/api.md 的内容是用doctoc制作的。更新该文件后，应运行 `doctoc docs/api.md` 以更新目录。
+
+没有doctoc命令使用下面的命令安装
+
+```
+npm install -g doctoc
+```

package/docs/zh/FAQ.md

@@ -0,0 +1,169 @@
+## FAQ
+
+本文档旨在帮助人们解决常见问题
+
+### 如何隐藏报错 ?
+
+在createBot选项中使用`hideErrors:true`
+您也可以选择添加这些监听事件:
+
+```js
+client.on('error', () => {})
+client.on('end', () => {})
+```
+
+### 我无法在自定义服务器上获取聊天事件，如何解决?
+
+Spigot 服务器, 特别是一些插件, 使用的是自定义聊天格式,您需要使用自定义正则表达式/解析器对其进行解析。
+阅读并改编[chat_parsing.js](https://github.com/PrismarineJS/mineflayer/blob/master/examples/chat_parsing.js)使其适用于您的特定聊天插件. 或者阅读 http://mineflayer.prismarine.js.org/#/tutorial?id=custom-chat
+
+### 如何用自定义插件在聊天中收集信息 ?
+
+大多数定制的Minecraft服务器都有插件支持，很多插件会在聊天中说一些事情. 如果只是一条信息, 最好使用上述解决方案中讨论的解决方案, 但是当这些消息被分成许多小消息时, 另一个选择是使用 `"messagestr"` 事件 因为它允许轻松解析多行消息.
+
+**例子:**
+
+聊天栏中的信息看起来像:
+```
+(!) U9G has won the /jackpot and received
+$26,418,402,450! They purchased 2,350,000 (76.32%) ticket(s) out of the
+3,079,185 ticket(s) sold!
+```
+```js
+const regex = {
+  first: /\(!\) (.+) has won the \/jackpot and received +/,
+  second: /\$(.+)! They purchased (.+) \((.+)%\) ticket\(s\) out of the /,
+  third: /(.+) ticket\(s\) sold!/
+}
+
+let jackpot = {}
+bot.on('messagestr', msg => {
+  if (regex.first.test(msg)) {
+    const username = msg.match(regex.first)[1]
+    jackpot.username = username
+  } else if (regex.second.test(msg)) {
+    const [, moneyWon, boughtTickets, winPercent] = msg.match(regex.second)
+    jackpot.moneyWon = parseInt(moneyWon.replace(/,/g, ''))
+    jackpot.boughtTickets = parseInt(boughtTickets.replace(/,/g, ''))
+    jackpot.winPercent = parseFloat(winPercent)
+  } else if (regex.third.test(msg)) {
+    const totalTickets = msg.match(regex.third)[1]
+    jackpot.totalTickets = parseInt(totalTickets.replace(/,/g, ''))
+    onDone(jackpot)
+    jackpot = {}
+  }
+})
+```
+### 如何发送命令 ?
+
+使用  `bot.chat()`.
+
+**例子:**
+
+```js
+bot.chat('/give @p minecraft:diamond_sword')
+```
+
+### 是否可以使用bot = mineflayer.createbot登录多个帐户  同时分别控制它们 ?
+
+通过调用createBot创建不同的bot实例，然后为每个实例执行不同的操作，请参考 multiple.js
+
+### 如何让机器人丢出它的全部背包物品?
+
+bot.inventory.items() 返回机器人的物品数组. 您可以使用递归函数循环遍历它们，并使用 `bot.toss()`.  [点这里](https://gist.github.com/dada513/3d88f772be4224b40f9e5d1787bd63e9) 查看例子
+
+### 如何检查发送/接收的数据包 ?
+
+启用调试模式 https://github.com/PrismarineJS/mineflayer#debug
+
+### 我希望即使在服务器有延迟的情况下也能避免断开连接，如何实现这一点 ?
+
+一种方法是增加 [checkTimeoutInterval](https://github.com/PrismarineJS/node-minecraft-protocol/blob/master/docs/API.md#mccreateclientoptions) 选项的值(在createBot中设置)  (例如 `300*1000` 这是5分钟，而不是默认的30秒). 如果仍然断开连接，可以使用类似于此示例的方法自动重新连接 https://github.com/PrismarineJS/mineflayer/blob/master/examples/reconnector.js
+
+### 如何获取物品的 lore / text?
+
+你可以使用 `item.nbt` 属性. 此外建议使用 `prismarine-nbt` 库.   `nbt.simplify()` 方法可能有用
+
+**例子:**
+
+```js
+function getLore (item) {
+  let message = ''
+  if (item.nbt == null) return message
+
+  const nbt = require('prismarine-nbt')
+  const ChatMessage = require('prismarine-chat')(bot.version)
+
+  const data = nbt.simplify(item.nbt)
+  const display = data.display
+  if (display == null) return message
+
+  const lore = display.Lore
+  if (lore == null) return message
+  for (const line of lore) {
+    message += new ChatMessage(line).toString()
+    message += '\n'
+  }
+
+  return message
+}
+```
+
+### 如何从控制台发送消息到服务器?
+
+您可以使用类似`repl`的库来读取控制台输入的内容并用`bot.chat()`发送它。 你可以在这查看例子 [点这里](https://github.com/PrismarineJS/mineflayer/blob/master/examples/repl.js)
+
+### 创建插件时，如何将另一个插件指定为依赖项？
+
+在插件的`inject()`函数中，您可以安全地调用`bot.loadPlugin(anotherPlugin)`确保已加载该插件。如果插件之前已经加载，则不会发生任何事情。
+
+请注意，加载插件的顺序是动态的, 因此，永远不要在`inject()`函数中调用其他插件.
+
+### 如何使用socks5代理？
+
+在对象的选项中 `mineflayer.createBot(options)`,从选项对象中删除你的 `host` 选项,声明以下变量 `PROXY_IP, PROXY_PORT, PROXY_USERNAME, PROXY_PASSWORD, MC_SERVER_IP, MC_SERVER_PORT` 并将其添加到选项对象中:
+```js
+connect: (client) => {
+  socks.createConnection({
+    proxy: {
+      host: PROXY_IP,
+      port: PROXY_PORT,
+      type: 5,
+      userId: PROXY_USERNAME,
+      password: PROXY_PASSWORD
+    },
+    command: 'connect',
+    destination: {
+      host: MC_SERVER_IP,
+      port: MC_SERVER_PORT
+    }
+  }, (err, info) => {
+    if (err) {
+      console.log(err)
+      return
+    }
+    client.setSocket(info.socket)
+    client.emit('connect')
+  })
+}
+```
+  `socks` 用 `const socks = require('socks').SocksClient` 声明 使用的是[这个](https://www.npmjs.com/package/socks) 包.
+
+# 常见错误
+
+### `UnhandledPromiseRejectionWarning: Error: Failed to read asymmetric key`
+
+当你给 mineflayer 设定了错误的服务器版本，或者 mineflayer 检测到错误的服务器版本时会发生这种情况
+
+### `TypeError: Cannot read property '?' of undefined`
+
+您可能正在尝试在 bot 对象上使用尚不存在的内容，请尝试在 `spawn` 事件之后调用该语句
+
+### `SyntaxError: Unexpected token '?'`
+
+更新node版本
+
+### The bot can't break/place blocks or open chests
+
+检查出生点保护是否阻止了机器人的操作
+

package/docs/zh/README_ZH_CN.md

@@ -10,30 +10,29 @@
 [![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 and 1.16
-* 实体感知与追踪
-* 方块感知，你可以在几毫秒内查找到bot周围的任何方块
-* 物理和运动引擎 - 支持所有的碰撞箱
-* 攻击实体，使用运载工具
-* 背包管理
-* 使用工作台、箱子、酿造台、附魔台
-* 挖掘和建造
-* 各种各样的的信息接口，比如查看bot的血量和是否下雨
-* 激活方块和使用物品
-* 输入输出聊天信息
-
-### 路标
-
-点击这个页面，看看目前我们有哪些 [实用项目](https://github.com/PrismarineJS/mineflayer/wiki/Big-Prismarine-projects).
+ * 支持版本：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) 看看目前我们有哪些实用的项目
 
 ## 安装
 
@@ -85,8 +84,8 @@ const bot = mineflayer.createBot({
   username: 'email@example.com', // minecraft 用户名
   password: '12345678' // minecraft 密码, 如果你玩的是不需要正版验证的服务器，请注释掉。
   // port: 25565,                // 默认使用25565，如果你的服务器端口不是这个请取消注释并填写。
-  // version: false,             // 当你需要指定使用一个版本或快照时，请取消注释并手动填写（如："1.8.9 " 或 "1.16.5"），否则会自动设置。
-  // auth: 'mojang'              // 当你需要使用微软账号登录时，请取消注释，然后将值设置为 'microsoft'，否则会自动设置为 'mojang'。
+  // version: false,             // 如果需要指定使用一个版本或快照时，请取消注释并手动填写（如："1.8.9 " 或 "1.16.5"），否则会自动设置。
+  // auth: 'mojang'              // 如果需要使用微软账号登录时，请取消注释，然后将值设置为 'microsoft'，否则会自动设置为 'mojang'。
 })
 
 bot.on('chat', (username, message) => {
@@ -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/docs/zh/_sidebar.md

@@ -0,0 +1,9 @@
+- 入门手册
+  - [介绍](/)
+  - [API](api.md)
+  - [FAQ](FAQ.md)
+  - [演示](demos.md)
+  - [教程](tutorial.md)
+  - [不稳定的API](unstable_api.md)
+  - [贡献](CONTRIBUTING.md)
+  - [更新历史](history.md)