mineflayer 4.18.0 → 4.19.0

package/README.md

@@ -37,9 +37,14 @@ First time using Node.js? You may want to start with the [tutorial](tutorial.md)
 
 First install Node.js >= 18 from [nodejs.org](https://nodejs.org/) then:
 
-`npm install mineflayer`
+```bash
+npm install mineflayer
+```
 
-To update mineflayer (or any Node.js) package and its dependencies, use `npm update --depth 9999`
+To update mineflayer (or any Node.js) package and its dependencies, use 
+```bash
+npm update --depth 9999
+```
 
 ## Documentation
 
@@ -80,11 +85,11 @@ const mineflayer = require('mineflayer')
 
 const bot = mineflayer.createBot({
   host: 'localhost', // minecraft server ip
-  username: 'Bot', // username or email, switch if you want to change accounts
+  username: 'Bot', // username to join as if auth is `offline`, else a unique identifier for this account. Switch if you want to change accounts
   auth: 'microsoft' // for offline mode servers, you can set this to 'offline'
-  // port: 25565,                // only set if you need a port that isn't 25565
-  // version: false,             // only set if you need a specific version or snapshot (ie: "1.8.9" or "1.16.5"), otherwise it's set automatically
-  // password: '12345678'        // set if you want to use password-based auth (may be unreliable). If specified, the `username` must be an email
+  // port: 25565,              // set if you need a port that isn't 25565
+  // version: false,           // only set if you need a specific version or snapshot (ie: "1.8.9" or "1.16.5"), otherwise it's set automatically
+  // password: '12345678'      // set if you want to use password-based auth (may be unreliable). If specified, the `username` must be an email
 })
 
 bot.on('chat', (username, message) => {
@@ -98,9 +103,10 @@ bot.on('error', console.log)
 ```
 
 If `auth` is set to `microsoft`, you will be prompted to login to microsoft.com with a code in your browser. After signing in on your browser, 
-the bot will automatically obtain and cache authentication tokens in the local file system so you don't have to sign-in again. 
-To switch the account, update the supplied `username`. By default, cached tokens will be stored in your user's .minecraft folder.
-For more information on these options and others, see node-minecraft-protocol's [API doc](https://github.com/PrismarineJS/node-minecraft-protocol/blob/master/docs/API.md#mccreateclientoptions).
+the bot will automatically obtain and cache authentication tokens (under your specified username) so you don't have to sign-in again. 
+
+To switch the account, update the supplied `username`. By default, cached tokens will be stored in your user's .minecraft folder, or if `profilesFolder` is specified, they'll instead be stored there.
+For more information on bot options see node-minecraft-protocol's [API doc](https://github.com/PrismarineJS/node-minecraft-protocol/blob/master/docs/API.md#mccreateclientoptions).
 
 #### Connecting to a Realm
 
@@ -248,17 +254,36 @@ The most updated and useful are :
 
 ### Testing everything
 
-Simply run: `npm test`
+Simply run: 
+
+```bash
+npm test
+```
 
 ### Testing specific version
-Run `npm run mocha_test -- -g <version>`, where `<version>` is a minecraft version like `1.12`, `1.15.2`...
+Run 
+
+```bash
+npm run mocha_test -- -g <version>
+```
+
+where `<version>` is a minecraft version like `1.12`, `1.15.2`...
 
 ### Testing specific test
-Run `npm run mocha_test -- -g <test_name>`, where `<test_name>` is a name of the test like `bed`, `useChests`, `rayTrace`...
+Run 
+
+```bash
+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
+```bash
+npm run mocha_test -- -g "1.18.1.*BlockFinder"
+```
+to run the block finder test for 1.18.1
 
 ## License
 

package/docs/README.md

@@ -37,9 +37,14 @@ First time using Node.js? You may want to start with the [tutorial](tutorial.md)
 
 First install Node.js >= 18 from [nodejs.org](https://nodejs.org/) then:
 
-`npm install mineflayer`
+```bash
+npm install mineflayer
+```
 
-To update mineflayer (or any Node.js) package and its dependencies, use `npm update --depth 9999`
+To update mineflayer (or any Node.js) package and its dependencies, use 
+```bash
+npm update --depth 9999
+```
 
 ## Documentation
 
@@ -80,11 +85,11 @@ const mineflayer = require('mineflayer')
 
 const bot = mineflayer.createBot({
   host: 'localhost', // minecraft server ip
-  username: 'Bot', // username or email, switch if you want to change accounts
+  username: 'Bot', // username to join as if auth is `offline`, else a unique identifier for this account. Switch if you want to change accounts
   auth: 'microsoft' // for offline mode servers, you can set this to 'offline'
-  // port: 25565,                // only set if you need a port that isn't 25565
-  // version: false,             // only set if you need a specific version or snapshot (ie: "1.8.9" or "1.16.5"), otherwise it's set automatically
-  // password: '12345678'        // set if you want to use password-based auth (may be unreliable). If specified, the `username` must be an email
+  // port: 25565,              // set if you need a port that isn't 25565
+  // version: false,           // only set if you need a specific version or snapshot (ie: "1.8.9" or "1.16.5"), otherwise it's set automatically
+  // password: '12345678'      // set if you want to use password-based auth (may be unreliable). If specified, the `username` must be an email
 })
 
 bot.on('chat', (username, message) => {
@@ -98,9 +103,10 @@ bot.on('error', console.log)
 ```
 
 If `auth` is set to `microsoft`, you will be prompted to login to microsoft.com with a code in your browser. After signing in on your browser, 
-the bot will automatically obtain and cache authentication tokens in the local file system so you don't have to sign-in again. 
-To switch the account, update the supplied `username`. By default, cached tokens will be stored in your user's .minecraft folder.
-For more information on these options and others, see node-minecraft-protocol's [API doc](https://github.com/PrismarineJS/node-minecraft-protocol/blob/master/docs/API.md#mccreateclientoptions).
+the bot will automatically obtain and cache authentication tokens (under your specified username) so you don't have to sign-in again. 
+
+To switch the account, update the supplied `username`. By default, cached tokens will be stored in your user's .minecraft folder, or if `profilesFolder` is specified, they'll instead be stored there.
+For more information on bot options see node-minecraft-protocol's [API doc](https://github.com/PrismarineJS/node-minecraft-protocol/blob/master/docs/API.md#mccreateclientoptions).
 
 #### Connecting to a Realm
 
@@ -248,17 +254,36 @@ The most updated and useful are :
 
 ### Testing everything
 
-Simply run: `npm test`
+Simply run: 
+
+```bash
+npm test
+```
 
 ### Testing specific version
-Run `npm run mocha_test -- -g <version>`, where `<version>` is a minecraft version like `1.12`, `1.15.2`...
+Run 
+
+```bash
+npm run mocha_test -- -g <version>
+```
+
+where `<version>` is a minecraft version like `1.12`, `1.15.2`...
 
 ### Testing specific test
-Run `npm run mocha_test -- -g <test_name>`, where `<test_name>` is a name of the test like `bed`, `useChests`, `rayTrace`...
+Run 
+
+```bash
+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
+```bash
+npm run mocha_test -- -g "1.18.1.*BlockFinder"
+```
+to run the block finder test for 1.18.1
 
 ## License
 

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" (fireworkEntityId)](#usedfirework-fireworkentityid)
       - ["move"](#move)
       - ["forcedMove"](#forcedmove)
       - ["mount"](#mount)
@@ -270,7 +270,7 @@
     - [Methods](#methods)
       - [bot.end(reason)](#botendreason)
       - [bot.quit(reason)](#botquitreason)
-      - [bot.tabComplete(str, [assumeCommand], [sendBlockInSight])](#bottabcompletestr-assumecommand-sendblockinsight)
+      - [bot.tabComplete(str, [assumeCommand], [sendBlockInSight], [timeout])](#bottabcompletestr-assumecommand-sendblockinsight-timeout)
       - [bot.chat(message)](#botchatmessage)
       - [bot.whisper(username, message)](#botwhisperusername-message)
       - [bot.chatAddPattern(pattern, chatType, description)](#botchataddpatternpattern-chattype-description)
@@ -1649,7 +1649,7 @@ End the connection with the server.
 
 Gracefully disconnect from the server with the given reason (defaults to 'disconnect.quitting').
 
-#### bot.tabComplete(str, [assumeCommand], [sendBlockInSight])
+#### bot.tabComplete(str, [assumeCommand], [sendBlockInSight], [timeout])
 
 This function returns a `Promise`, with `matches` as its argument upon completion.
 
@@ -1657,6 +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.
 
 #### bot.chat(message)
 

package/docs/br/README_BR.md

@@ -213,16 +213,33 @@ Mas também dê uma olhada em:
 
 ### Executar Todos os Testes
 
-Basta executar: `npm test`
+Basta executar:
+
+```bash
+npm test
+```
 
 ### Executar Testes para uma Versão Específica do Minecraft
-Execute `npm test -- -g <versão>`, onde `<versão>` é uma versão do Minecraft, como `1.12`, `1.15.2`...
+
+Execute
+
+```bash
+npm test -- -g <versão>
+```
+
+onde `<versão>` é uma versão do Minecraft, como `1.12`, `1.15.2`...
 
 ### Executar um Teste Específico
-Execute `npm test -- -g <nome_do_teste>`, onde `<nome_do_teste>` é o nome do teste que você deseja executar, como `bed`, `useChests`, `rayTrace`...
+
+Execute
+```bash
+npm test -- -g <nome_do_teste>
+```
+
+onde `<nome_do_teste>` é o nome do teste que você deseja executar, como `bed`, `useChests`, `rayTrace`...
 
 ## Licença
 
-[MIT](LICENSE)
+[MIT](../../LICENSE)
 
 Esta documentação não é oficialmente mantida. Para ver as últimas atualizações, consulte a documentação original: [unstable_api](../README.md)

package/docs/es/README_ES.md

@@ -213,17 +213,33 @@ Pero también echa un vistazo a:
 
 ### Ejecuta todas las pruebas
 
-Simplemente ejecuta: `npm test`
+Simplemente ejecuta:
+
+```bash
+npm test
+```
 
 ### Ejecuta pruebas para una versión específica de Minecraft
-Ejecuta `npm test -- -g <version>`, donde `<version>` es una versión de minecraft como `1.12`, `1.15.2`...
+
+Ejecuta
+```bash
+npm test -- -g <version>
+```
+
+donde `<version>` es una versión de minecraft como `1.12`, `1.15.2`...
 
 ### Ejecuta una prueba específica
-Ejecuta `npm test -- -g <test_name>`, donde `<test_name>` es el nombre de la prueba que quieres ejecutar como `bed`, `useChests`, `rayTrace`...
+
+Ejecuta
+```bash
+npm test -- -g <test_name>
+```
+
+donde `<test_name>` es el nombre de la prueba que quieres ejecutar como `bed`, `useChests`, `rayTrace`...
 
 ## Licencia
 
-[MIT](LICENSE)
+[MIT](../../LICENSE)
 
 
 Esta documentación no está mantenida oficialmente, si quiere ver las últimas novedades, por favor dirijase a la documentación original: [unstable_api](../README.md)

package/docs/fr/README_FR.md

@@ -221,14 +221,32 @@ Laissez un coup d'oeil à ses projets :
 
 ### Tout tester
 
-Exécuter seulement : `npm test`
+Exécuter seulement :
+
+```bash
+npm test
+```
 
 ### Tester une version spécifique
-Exécutez `npm test -g <version>`, où `<version>` est une version de Minecraft comme `1.12`, `1.15.2`...
+
+Exécutez
+
+```bash
+npm test -g <version>
+```
+
+où `<version>` est une version de Minecraft comme `1.12`, `1.15.2`...
 
 ### Tester un test spécifique
-Executer `npm test -g <test_name>`, où `<test_name>` est le nom d'un teste comme `lit`, `utiliseCoffre`, `rayTrace`...
+
+Executer
+
+```bash
+npm test -g <test_name>
+```
+
+où `<test_name>` est le nom d'un teste comme `lit`, `utiliseCoffre`, `rayTrace`...
 
 ## Licence
 
-[MIT](LICENCE)
+[MIT](../../LICENSE)

package/docs/history.md

@@ -1,3 +1,14 @@
+## 4.19.0
+* [Clarify readme createBot username handling (#3300)](https://github.com/PrismarineJS/mineflayer/commit/7a2680bc07f53d16626679537ea1f07aae180549) (thanks @extremeheat)
+* [fix world typing (#3302)](https://github.com/PrismarineJS/mineflayer/commit/5dc36d6cdeaf4be72ea023827d45b9d78e575f66) (thanks @GenerelSchwerz)
+* [modified the README.md files for other languages and fixed a linking issue at those files. (#3297)](https://github.com/PrismarineJS/mineflayer/commit/cc98f1307e3ab48477d2a9ff29da4447f42b30bc) (thanks @Axwaizee)
+* [formatted docs/README.md for easy copy (#3295)](https://github.com/PrismarineJS/mineflayer/commit/468c8aa9d382a7872ec991c3b834b98cbe495e8d) (thanks @Axwaizee)
+* [Added missing bot.teams definition (#3294)](https://github.com/PrismarineJS/mineflayer/commit/fb8ee7aa619bd38cc97d5dbd870bb11455d51d39) (thanks @Ynfuien)
+* [Timeout for bot.tabComplete() (#3293)](https://github.com/PrismarineJS/mineflayer/commit/4231a169d579d08ac7b9ec0694e18b1f6ac837ea) (thanks @Ynfuien)
+* [:label: Update types to be updated with what's in JavaScript (#3287)](https://github.com/PrismarineJS/mineflayer/commit/210785e86c031f7e3323d7d2ffe5152d2d4a5eb6) (thanks @fantomitechno)
+* [Fixed some typo (#3290)](https://github.com/PrismarineJS/mineflayer/commit/ba53a953d03a6edb34aa5bf38bccde58e65d816d) (thanks @SilianZ)
+* [Updated digging code to account for raycasted tall grass checks (#3285)](https://github.com/PrismarineJS/mineflayer/commit/bd0fb5c4d3b665f264009f62f9288828f3018cea) (thanks @GenerelSchwerz)
+
 ## 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)

package/docs/ru/README_RU.md

@@ -219,17 +219,38 @@ Mineflayer поддерживает сторонние плагины. Любо
 
 ### Тестирование всего
 
-Просто запустите: `npm test`
+Просто запустите:
+
+```bash
+npm test
+```
 
 ### Тестирование определённой версии
-Запустите `npm run mocha_test -- -g <version>`, где `<version>` означает версию, таких как `1.12`, `1.15.2`...
+Запустите
+
+```bash
+npm run mocha_test -- -g <version>
+```
+
+где `<version>` означает версию, таких как `1.12`, `1.15.2`...
 
 ### Тестирование определённой функции
-Запустите `npm run mocha_test -- -g <test_name>`, где `<test_name>` означает название проверки, таких как `bed`, `useChests`, `rayTrace`...
+
+Запустите
+
+```bash
+npm run mocha_test -- -g <test_name>
+```
+
+где `<test_name>` означает название проверки, таких как `bed`, `useChests`, `rayTrace`...
 
 ### Пример
 
-`npm run mocha_test -- -g "1.18.1.*BlockFinder"` запустит тест BlockFinder на версии 1.18.1
+```bash
+npm run mocha_test -- -g "1.18.1.*BlockFinder"
+```
+
+запустит тест BlockFinder на версии 1.18.1
 
 ## Лицензия
 

package/docs/tr/README_TR.md

@@ -218,13 +218,28 @@ En çok güncellenen ve en kullanışlı olan bazıları:
 
 ### Her şeyi test etme
 
-Basitçe `npm test` komutunu çalıştırın
+Basitçe
+```bash
+npm test
+```
+
+komutunu çalıştırın
 
 ### Özel bir sürümü test etme
-`npm test -- -g <version>` komutunu çalıştırın, `<version>` bir Minecraft sürümü olmalı (`1.12`, `1.15.2` gibi).
+
+```bash
+npm test -- -g <version>
+```
+
+komutunu çalıştırın, `<version>` bir Minecraft sürümü olmalı (`1.12`, `1.15.2` gibi).
 
 ### Özel bir şeyi test etme
-`npm test -- -g <test_name>` komutunu çalıştırın, `<test_name>` kısmının olduğu bölüm bir test adı olmalı (`bed`, `useChests`, `rayTrace` gibi).
+
+```bash
+npm test -- -g <test_name>
+```
+
+komutunu çalıştırın, `<test_name>` kısmının olduğu bölüm bir test adı olmalı (`bed`, `useChests`, `rayTrace` gibi).
 
 ## Lisans
-[MIT](LICENSE)
+[MIT](../../LICENSE)

package/docs/zh/CONTRIBUTING.md

@@ -88,6 +88,6 @@ docs/api.md 的内容是用doctoc制作的。更新该文件后，应运行 `doc
 
 没有doctoc命令使用下面的命令安装
 
-```
+```bash
 npm install -g doctoc
 ```

package/docs/zh/README_ZH_CN.md

@@ -13,9 +13,9 @@
 | <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) | <sub>BR</sub> [Portuguese](../br/README_BR.md) |
 |-------------------------|----------------------------|----------------------------|----------------------------|----------------------------|----------------------------|----------------------------|
 
-使用强大、稳定、高级的JavaScript [API](../api.md) 来开发Minecraft机器人，同时支持 Python。
+使用强大、稳定、高级的 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) 来体验一下。
 
 ## 特点
 
@@ -30,6 +30,7 @@
  * 各种各样的的信息接口，比如查看你的血量或是否下雨
  * 激活方块和使用物品
  * 进行聊天
+
 ### 路线图
 
  [点这里](https://github.com/PrismarineJS/mineflayer/wiki/Big-Prismarine-projects) 看看目前我们有哪些实用的项目
@@ -80,11 +81,11 @@
 const mineflayer = require('mineflayer')
 
 const bot = mineflayer.createBot({
-  host: 'localhost', // minecraft 服务器的 ip地址
+  host: 'localhost', // minecraft 服务器的 IP 地址
   username: 'email@example.com', // minecraft 用户名
   password: '12345678' // minecraft 密码, 如果你玩的是不需要正版验证的服务器，请注释掉。
-  // port: 25565,                // 默认使用25565，如果你的服务器端口不是这个请取消注释并填写。
-  // version: false,             // 如果需要指定使用一个版本或快照时，请取消注释并手动填写（如："1.8.9 " 或 "1.16.5"），否则会自动设置。
+  // port: 25565,                // 默认使用 25565，如果你的服务器端口不是这个请取消注释并填写。
+  // version: false,             // 如果需要指定使用一个版本或快照时，请取消注释并手动填写（如："1.8.9" 或 "1.16.5"），否则会自动设置。
   // auth: 'mojang'              // 如果需要使用微软账号登录时，请取消注释，然后将值设置为 'microsoft'，否则会自动设置为 'mojang'。
 })
 
@@ -93,15 +94,15 @@ bot.on('chat', (username, message) => {
   bot.chat(message)
 })
 
-//  记录错误和被踢出服务器的原因:
+// 记录错误和被踢出服务器的原因:
 bot.on('kicked', console.log)
 bot.on('error', console.log)
 ```
 
-### 看看你的bot在做什么
+### 看看你的 bot 在做什么
 
-感谢 [prismarin-viewer](https://github.com/PrismarineJS/prismarine-viewer)项目，它可以在浏览器窗口显示你的机器人正在做什么。  
-只需要运行 `npm install prismarine-viewer` 并将其添加到你的bot代码中。
+感谢 [prismarine-viewer](https://github.com/PrismarineJS/prismarine-viewer)项目，它可以在浏览器窗口显示你的机器人正在做什么。  
+只需要运行 `npm install prismarine-viewer` 并将其添加到你的 bot 代码中。
 
 ```js
 const { mineflayer: mineflayerViewer } = require('prismarine-viewer')
@@ -118,13 +119,13 @@ bot.once('spawn', () => {
 
 | 例子 | 描述 |
 |---|---|
-|[viewer](https://github.com/PrismarineJS/mineflayer/tree/master/examples/viewer) | 在浏览器中显示bot的视角 |
-|[pathfinder](https://github.com/PrismarineJS/mineflayer/tree/master/examples/pathfinder) | 让你的bot自动前往任何地点  |
+|[viewer](https://github.com/PrismarineJS/mineflayer/tree/master/examples/viewer) | 在浏览器中显示 bot 的视角 |
+|[pathfinder](https://github.com/PrismarineJS/mineflayer/tree/master/examples/pathfinder) | 让你的 bot 自动前往任何地点  |
 |[chest](https://github.com/PrismarineJS/mineflayer/blob/master/examples/chest.js) | 使用箱子、熔炉、酿造台、附魔台 |
 |[digger](https://github.com/PrismarineJS/mineflayer/blob/master/examples/digger.js) | 学习如何创建一个能够挖掘方块的简单bot |
 |[discord](https://github.com/PrismarineJS/mineflayer/blob/master/examples/discord.js) | 将 discord bot 与 mineflayer bot 进行消息互通 |
 |[jumper](https://github.com/PrismarineJS/mineflayer/blob/master/examples/jumper.js) | 学习如何移动、跳跃、骑乘载具、攻击附近的实体 |
-|[ansi](https://github.com/PrismarineJS/mineflayer/blob/master/examples/ansi.js) | 使用全彩色在命令行中显示bot的聊天记录 |
+|[ansi](https://github.com/PrismarineJS/mineflayer/blob/master/examples/ansi.js) | 使用全彩色在命令行中显示 bot 的聊天记录 |
 |[guard](https://github.com/PrismarineJS/mineflayer/blob/master/examples/guard.js) | 让bot守卫一个指定的区域，不让附近的生物进入。 |
 |[multiple-from-file](https://github.com/PrismarineJS/mineflayer/blob/master/examples/multiple_from_file.js) | 创建一个包含账户信息的文本文件，让它们全部同时登录 |
 
@@ -132,15 +133,15 @@ bot.once('spawn', () => {
 
 ### 模块
 
-很多活跃的开发都发生在 mineflayer 所使用的小型npm包内
+很多活跃的开发都发生在 mineflayer 所使用的小型 npm 包内
 
-#### The Node Way&trade;
+#### The Node Way & trade;
 
 > "当你很好的编写了一个应用程序，此时它的价值仅限于这些特定的需求。你要知道，真正好的、可重复使用的优秀组件都会升华到github和npm上，在那里，每个人都可以合作来推进公共事业。" — [《 how I write modules 》 - substack](https://gist.github.com/substack/5075355)
 
 #### 子模块
 
-这些是 构成Mineflayer 的主要模块：
+这些是 构成 mineflayer 的主要模块：
 
 | 模块 | 描述 |
 |---|---|
@@ -177,7 +178,7 @@ node your_script.js
 
 ## 第三方插件
 
-Mineflayer 支持插件；任何人都可以创建一个插件，在 Mineflayer 之上添加更高级别的 API。
+mineflayer 支持插件；任何人都可以创建一个插件，在 mineflayer 之上添加更高级别的 API。
 
 最新和最有用的有：
 
@@ -206,9 +207,9 @@ Mineflayer 支持插件；任何人都可以创建一个插件，在 Mineflayer
 * [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里监听玩家死亡事件
+ * [player-death-event](https://github.com/tuanzisama/mineflayer-death-event) - 在 Mineflayer 里监听玩家死亡事件
 
-## 正在使用 Mineflayer 的项目
+## 正在使用 mineflayer 的项目
 
 * [rom1504/rbot](https://github.com/rom1504/rbot)
   * [YouTube - 建造旋转楼梯](https://www.youtube.com/watch?v=UM1ZV5200S0)
@@ -227,20 +228,39 @@ Mineflayer 支持插件；任何人都可以创建一个插件，在 Mineflayer
 
 ### 完整测试
 
-运行：`npm test`
+运行
+```bash
+npm test
+````
 
 ### 测试指定版本
 
-运行 `npm mocha_test -- -g <version>`, 其中 `<version>` 表示 minecraft 版本号 如 `1.12`, `1.15.2`...
+运行 
+
+```bash
+npm mocha_test -- -g <version>
+```
+
+其中 `<version>` 表示 minecraft 版本号 如 `1.12`, `1.15.2`...
 
 ### 测试指定测试脚本
 
-运行 `npm mocha_test -- -g <test_name>`，其中 `<test_name>` 是测试名称，例如 `bed`, `useChests`, `rayTrace`...
+运行 
+
+```bash
+npm mocha_test -- -g <test_name>
+```
+
+其中 `<test_name>` 是测试名称，例如 `bed`, `useChests`, `rayTrace`...
 
 ### 示例
 
-`npm run mocha_test -- -g "1.18.1.*BlockFinder"` 进行1.18.1寻路测试
+```bash
+npm run mocha_test -- -g "1.18.1.*BlockFinder"
+```
+
+进行 1.18.1 寻路测试
 
 ## 许可证
 
-[MIT](../LICENSE)
+[MIT](../../LICENSE)

package/index.d.ts

@@ -194,10 +194,11 @@ export interface Bot extends TypedEmitter<BotEvents> {
   isSleeping: boolean
   scoreboards: { [name: string]: ScoreBoard }
   scoreboard: { [slot in DisplaySlot]: ScoreBoard }
+  teams: { [name: string]: Team }
   teamMap: { [name: string]: Team }
   controlState: ControlStateStatus
   creative: creativeMethods
-  world: world.World
+  world: world.WorldSync
   _client: Client
   heldItem: Item | null
   usingHeldItem: boolean
@@ -245,7 +246,8 @@ export interface Bot extends TypedEmitter<BotEvents> {
   tabComplete: (
     str: string,
     assumeCommand?: boolean,
-    sendBlockInSight?: boolean
+    sendBlockInSight?: boolean,
+    timeout?: number
   ) => Promise<string[]>
 
   chat: (message: string) => void
@@ -779,7 +781,7 @@ export class ScoreBoard {
 
   setTitle (title: string): void;
 
-  add (name: string, value: number, displayName: ChatMessage): ScoreBoardItem;
+  add(name: string, value: number): ScoreBoardItem;
 
   remove (name: string): ScoreBoardItem;
 }
@@ -791,6 +793,7 @@ export interface ScoreBoardItem {
 }
 
 export class Team {
+  team: string
   name: ChatMessage
   friendlyFire: number
   nameTagVisibility: string
@@ -798,8 +801,10 @@ export class Team {
   color: string
   prefix: ChatMessage
   suffix: ChatMessage
+  memberMap: { [name: string]: '' }
+  members: string[]
 
-  constructor (packet: object);
+  constructor(team: string, name: string, friendlyFire: boolean, nameTagVisibility: string, collisionRule: string, formatting: number, prefix: string, suffix: string);
 
   parseMessage (value: string): ChatMessage;
 
@@ -841,6 +846,7 @@ export class BossBar {
   color: 'pink' | 'blue' | 'red' | 'green' | 'yellow' | 'purple' | 'white'
   shouldDarkenSky: boolean
   isDragonBar: boolean
+  createFog: boolean
   shouldCreateFog: boolean
 
   constructor (
@@ -854,23 +860,22 @@ export class BossBar {
 }
 
 export class Particle {
-    id: number
-    name: string
-    position: Vec3
-    offset: Vec3
-    count: number
-    movementSpeed: number
-    longDistanceRender: boolean
-    static fromNetwork(packet: Object): Particle
-
-    constructor (
-        id: number,
-        position: Vec3,
-        offset: Vec3,
-        count?: number,
-        movementSpeed?: number,
-        longDistanceRender?: boolean
-    );
+  id: number
+  position: Vec3
+  offset: Vec3
+  count: number
+  movementSpeed: number
+  longDistanceRender: boolean
+  static fromNetwork(packet: Object): Particle
+
+  constructor(
+    id: number,
+    position: Vec3,
+    offset: Vec3,
+    count?: number,
+    movementSpeed?: number,
+    longDistanceRender?: boolean
+  );
 }
 
 export let testedVersions: string[]

package/lib/plugins/chat.js

@@ -1,4 +1,4 @@
-const { once } = require('events')
+const { onceWithCleanup } = require('../promise_utils')
 
 const USERNAME_REGEX = '(?:\\(.{1,15}\\)|\\[.{1,15}\\]|.){0,5}?(\\w+)'
 const LEGACY_VANILLA_CHAT_REGEX = new RegExp(`^${USERNAME_REGEX}\\s?[>:\\-»\\]\\)~]+\\s(.*)$`)
@@ -165,7 +165,7 @@ function inject (bot, options) {
     })
   }
 
-  async function tabComplete (text, assumeCommand = false, sendBlockInSight = true) {
+  async function tabComplete (text, assumeCommand = false, sendBlockInSight = true, timeout = 5000) {
     let position
 
     if (sendBlockInSight) {
@@ -182,7 +182,7 @@ function inject (bot, options) {
       lookedAtBlock: position
     })
 
-    const [packet] = await once(bot._client, 'tab_complete')
+    const [packet] = await onceWithCleanup(bot._client, 'tab_complete', { timeout })
     return packet.matches
   }
 

package/lib/plugins/digging.js

@@ -54,6 +54,7 @@ function inject (bot) {
           z: Math.sign(Math.abs(dz) > 0.5 ? dz : 0)
         }
         const validFaces = []
+        const closerBlocks = []
         for (const i in visibleFaces) {
           if (!visibleFaces[i]) continue // skip as this face is not visible
           // target position on the target block face. -> 0.5 + (current face) * 0.5
@@ -65,13 +66,19 @@ function inject (bot) {
           const startPos = bot.entity.position.offset(0, bot.entity.height, 0)
           const rayBlock = bot.world.raycast(startPos, targetPos.clone().subtract(startPos).normalize(), 5)
           if (rayBlock) {
+            if (startPos.distanceTo(rayBlock.intersect) < startPos.distanceTo(targetPos)) {
+              // Block is closer then the raycasted block
+              closerBlocks.push(rayBlock)
+              // continue since if distance is ever less, then we did not intersect the block we wanted,
+              // meaning that the position of the intersected block is not what we want.
+              continue
+            }
             const rayPos = rayBlock.position
             if (
               rayPos.x === block.position.x &&
                             rayPos.y === block.position.y &&
                             rayPos.z === block.position.z
             ) {
-              // console.info(rayBlock)
               validFaces.push({
                 face: rayBlock.face,
                 targetPos: rayBlock.intersect
@@ -95,6 +102,11 @@ function inject (bot) {
           }
           await bot.lookAt(closest.targetPos, forceLook)
           diggingFace = closest.face
+        } else if (closerBlocks.length === 0 && block.shapes.length === 0) {
+          // no other blocks were detected and the block has no shapes.
+          // The block in question is replaceable (like tall grass) so we can just dig it
+          // TODO: do AABB + ray intercept check to this position for diggingFace.
+          await bot.lookAt(block.position.offset(0.5, 0.5, 0.5), forceLook)
         } else {
           // Block is obstructed return error?
           throw new Error('Block not in view')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mineflayer",
-  "version": "4.18.0",
+  "version": "4.19.0",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",