mineflayer 3.10.0 → 3.12.0

package/.github/FUNDING.yml

@@ -1,3 +1 @@
 # These are supported funding model platforms
-
-issuehunt: PrismarineJS/mineflayer

package/.github/workflows/ci.yml

@@ -2,10 +2,10 @@ name: CI
 
 on:
   push:
-    branches: 
+    branches:
       - master
   pull_request:
-  
+
 jobs:
   Lint:
     runs-on: ubuntu-latest
@@ -22,21 +22,25 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
+        javaVersion: [1.8]
         mcVersion: ['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']
+        include:
+         - javaVersion: 16
+           mcVersion: '1.17.1'
       fail-fast: false
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1.4.4
-      with:
-        node-version: 14.x
-    - name: Setup Java JDK
-      uses: actions/setup-java@v1.4.3
-      with:
-        java-version: 1.8
-        java-package: jre
-    - name: Install Dependencies
-      run: npm install
-    - name: Start Tests
-      run: npm run mocha_test -- -g ${{ matrix.mcVersion }}
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1.4.4
+        with:
+          node-version: 14.x
+      - name: Setup Java JDK
+        uses: actions/setup-java@v1.4.3
+        with:
+          java-version: ${{ matrix.javaVersion }}
+          java-package: jre
+      - name: Install Dependencies
+        run: npm install
+      - name: Start Tests
+        run: npm run mocha_test -- -g ${{ matrix.mcVersion }}

package/README.md

@@ -3,23 +3,20 @@
 [![NPM version](https://badge.fury.io/js/mineflayer.svg)](http://badge.fury.io/js/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)
-[![Gitter](https://img.shields.io/badge/chat-on%20gitter-brightgreen.svg)](https://gitter.im/PrismarineJS/general)
-[![Irc](https://img.shields.io/badge/chat-on%20irc-brightgreen.svg)](https://irc.gitter.im/)
 [![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)
 
-| 🇺🇸 [English](README.md) | 🇷🇺 [Russian](ru/README_RU.md) | 🇪🇸 [Spanish](es/README_ES.md) | 🇫🇷 [French](fr/README_FR.md) | 🇹🇷 [Turkish](tr/README_TR.md) | 🇨🇳 [Chinese](zh/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) |
 |-------------------------|----------------------------|----------------------------|----------------------------|----------------------------|----------------------------|
 
 Create Minecraft bots with a powerful, stable, and high level JavaScript [API](api.md), also usable from Python.
 
-First time using node.js ? You may want to start with the [tutorial](tutorial.md). Know Python ? Checkout some [Python examples](https://github.com/PrismarineJS/mineflayer/tree/master/examples/python) and try out [Mineflayer on Google Colab](https://colab.research.google.com/github/PrismarineJS/mineflayer/blob/master/docs/mineflayer.ipynb).
+First time using Node.js? You may want to start with the [tutorial](tutorial.md). Know Python? Checkout some [Python examples](https://github.com/PrismarineJS/mineflayer/tree/master/examples/python) and try out [Mineflayer on Google Colab](https://colab.research.google.com/github/PrismarineJS/mineflayer/blob/master/docs/mineflayer.ipynb).
 
 ## Features
 
- * Supports Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15 and 1.16.
+ * Supports Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16 and 1.17.
  * 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
@@ -33,11 +30,11 @@ First time using node.js ? You may want to start with the [tutorial](tutorial.md
 
 ### Roadmap
 
- Checkout this page to see what are our current [projects](https://github.com/PrismarineJS/mineflayer/wiki/Big-Prismarine-projects). 
+ Checkout [this page](https://github.com/PrismarineJS/mineflayer/wiki/Big-Prismarine-projects) to see what our current projects are.
  
 ## Installation
 
-First install nodejs >= 14 from [nodejs.org](https://nodejs.org/) then:
+First install Node.js >= 14 from [nodejs.org](https://nodejs.org/) then:
 
 `npm install mineflayer`
 
@@ -45,7 +42,7 @@ First install nodejs >= 14 from [nodejs.org](https://nodejs.org/) then:
 
 | link | description |
 |---|---|
-|[tutorial](tutorial.md) | Begin with node.js and mineflayer |
+|[tutorial](tutorial.md) | Begin with Node.js and mineflayer |
 | [FAQ.md](FAQ.md) | Got a question ? go there first |
 | [api.md](api.md) [unstable_api.md](unstable_api.md) | The full API reference |
 | [history.md](history.md) | The changelog for mineflayer |
@@ -71,7 +68,7 @@ If you want to learn more, more video tutorials are [there,](https://www.youtube
 
 **Getting Started**
 
-Without version specified, the version of the server will be guessed automatically.
+Without a version specified, the version of the server will be guessed automatically.
 Without auth specified, the mojang auth style will be guessed.
 
 ### Echo Example
@@ -99,7 +96,7 @@ bot.on('error', console.log)
 
 ### See what your bot is doing
 
-Thanks to [prismarine-viewer](https://github.com/PrismarineJS/prismarine-viewer) project, it's possible to display in a browser window what your bot is doing.
+Thanks to the [prismarine-viewer](https://github.com/PrismarineJS/prismarine-viewer) project, it's possible to display in a browser window what your bot is doing.
 Just run `npm install prismarine-viewer` and add this to your bot:
 ```js
 const { mineflayer: mineflayerViewer } = require('prismarine-viewer')
@@ -118,7 +115,7 @@ And you'll get a *live* view looking like this:
 |[viewer](https://github.com/PrismarineJS/mineflayer/tree/master/examples/viewer) | Display your bot world view in the browser |
 |[pathfinder](https://github.com/PrismarineJS/mineflayer/tree/master/examples/pathfinder) | Make your bot go to any location automatically |
 |[chest](https://github.com/PrismarineJS/mineflayer/blob/master/examples/chest.js) | Use chests, furnaces, dispensers, enchantment tables |
-|[digger](https://github.com/PrismarineJS/mineflayer/blob/master/examples/digger.js) | Learn how to create a simple bot that is capable of digging the block |
+|[digger](https://github.com/PrismarineJS/mineflayer/blob/master/examples/digger.js) | Learn how to create a simple bot that is capable of digging blocks |
 |[discord](https://github.com/PrismarineJS/mineflayer/blob/master/examples/discord.js) | Connect a discord bot with a mineflayer bot |
 |[jumper](https://github.com/PrismarineJS/mineflayer/blob/master/examples/jumper.js) | Learn how to move, jump, ride vehicles, attack nearby entities |
 |[ansi](https://github.com/PrismarineJS/mineflayer/blob/master/examples/ansi.js) | Display your bot's chat with all of the chat colors shown in your terminal |
@@ -182,14 +179,17 @@ The most updated and useful are :
  * [pathfinder](https://github.com/Karang/mineflayer-pathfinder) - advanced A* pathfinding with a lot of configurable features
  * [prismarine-viewer](https://github.com/PrismarineJS/prismarine-viewer) - simple web chunk viewer
  * [web-inventory](https://github.com/ImHarvol/mineflayer-web-inventory) - web based inventory viewer
- * [statemachine](https://github.com/TheDudeFromCI/mineflayer-statemachine) - A state machine API for more complex bot behavors
- * [Armor Manager](https://github.com/G07cha/MineflayerArmorManager) - automatic armor managment
+ * [statemachine](https://github.com/TheDudeFromCI/mineflayer-statemachine) - A state machine API for more complex bot behaviors
+ * [Armor Manager](https://github.com/G07cha/MineflayerArmorManager) - automatic armor management
  * [Collect Block](https://github.com/TheDudeFromCI/mineflayer-collectblock) - Quick and simple block collection API.
  * [Dashboard](https://github.com/wvffle/mineflayer-dashboard) - Frontend dashboard for mineflayer bot
  * [PVP](https://github.com/TheDudeFromCI/mineflayer-pvp) - Easy API for basic PVP and PVE.
- * [auto-eat](https://github.com/LINKdiscordd/mineflayer-auto-eat) - Automatic eating of food.
+ * [Auto Eat](https://github.com/link-discord/mineflayer-auto-eat) - Automatic eating of food.
+ * [Auto Crystal](https://github.com/link-discord/mineflayer-autocrystal) - Automatic placing & breaking of end crystals.
  * [Tool](https://github.com/TheDudeFromCI/mineflayer-tool) - A utility for automatic tool/weapon selection with a high level API.
  * [Hawkeye](https://github.com/sefirosweb/minecraftHawkEye) - A utility for using auto-aim with bows.
+ * [GUI](https://github.com/firejoust/mineflayer-GUI) - Eased navigation & management of nested chest-GUI windows
+ * [Projectile](https://github.com/firejoust/mineflayer-projectile) - Configurable tool for projectile based combat
 
 
  But also check out :
@@ -204,6 +204,7 @@ The most updated and useful are :
  * [Bloodhound](https://github.com/Nixes/mineflayer-bloodhound) - determine who and what is responsible for damage to another entity
  * [tps](https://github.com/SiebeDW/mineflayer-tps) - get the current tps (processed tps)
  * [panorama](https://github.com/IceTank/mineflayer-panorama) - take Panorama Images of your world
+ * [player-death-event](https://github.com/tuanzisama/mineflayer-death-event) - emit player death event in Mineflayer.
 
 ## Projects Using Mineflayer
 

package/docs/README.md

@@ -3,23 +3,20 @@
 [![NPM version](https://badge.fury.io/js/mineflayer.svg)](http://badge.fury.io/js/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)
-[![Gitter](https://img.shields.io/badge/chat-on%20gitter-brightgreen.svg)](https://gitter.im/PrismarineJS/general)
-[![Irc](https://img.shields.io/badge/chat-on%20irc-brightgreen.svg)](https://irc.gitter.im/)
 [![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)
 
-| 🇺🇸 [English](README.md) | 🇷🇺 [Russian](ru/README_RU.md) | 🇪🇸 [Spanish](es/README_ES.md) | 🇫🇷 [French](fr/README_FR.md) | 🇹🇷 [Turkish](tr/README_TR.md) | 🇨🇳 [Chinese](zh/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) |
 |-------------------------|----------------------------|----------------------------|----------------------------|----------------------------|----------------------------|
 
 Create Minecraft bots with a powerful, stable, and high level JavaScript [API](api.md), also usable from Python.
 
-First time using node.js ? You may want to start with the [tutorial](tutorial.md). Know Python ? Checkout some [Python examples](https://github.com/PrismarineJS/mineflayer/tree/master/examples/python) and try out [Mineflayer on Google Colab](https://colab.research.google.com/github/PrismarineJS/mineflayer/blob/master/docs/mineflayer.ipynb).
+First time using Node.js? You may want to start with the [tutorial](tutorial.md). Know Python? Checkout some [Python examples](https://github.com/PrismarineJS/mineflayer/tree/master/examples/python) and try out [Mineflayer on Google Colab](https://colab.research.google.com/github/PrismarineJS/mineflayer/blob/master/docs/mineflayer.ipynb).
 
 ## Features
 
- * Supports Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15 and 1.16.
+ * Supports Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16 and 1.17.
  * 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
@@ -33,11 +30,11 @@ First time using node.js ? You may want to start with the [tutorial](tutorial.md
 
 ### Roadmap
 
- Checkout this page to see what are our current [projects](https://github.com/PrismarineJS/mineflayer/wiki/Big-Prismarine-projects). 
+ Checkout [this page](https://github.com/PrismarineJS/mineflayer/wiki/Big-Prismarine-projects) to see what our current projects are.
  
 ## Installation
 
-First install nodejs >= 14 from [nodejs.org](https://nodejs.org/) then:
+First install Node.js >= 14 from [nodejs.org](https://nodejs.org/) then:
 
 `npm install mineflayer`
 
@@ -45,7 +42,7 @@ First install nodejs >= 14 from [nodejs.org](https://nodejs.org/) then:
 
 | link | description |
 |---|---|
-|[tutorial](tutorial.md) | Begin with node.js and mineflayer |
+|[tutorial](tutorial.md) | Begin with Node.js and mineflayer |
 | [FAQ.md](FAQ.md) | Got a question ? go there first |
 | [api.md](api.md) [unstable_api.md](unstable_api.md) | The full API reference |
 | [history.md](history.md) | The changelog for mineflayer |
@@ -71,7 +68,7 @@ If you want to learn more, more video tutorials are [there,](https://www.youtube
 
 **Getting Started**
 
-Without version specified, the version of the server will be guessed automatically.
+Without a version specified, the version of the server will be guessed automatically.
 Without auth specified, the mojang auth style will be guessed.
 
 ### Echo Example
@@ -99,7 +96,7 @@ bot.on('error', console.log)
 
 ### See what your bot is doing
 
-Thanks to [prismarine-viewer](https://github.com/PrismarineJS/prismarine-viewer) project, it's possible to display in a browser window what your bot is doing.
+Thanks to the [prismarine-viewer](https://github.com/PrismarineJS/prismarine-viewer) project, it's possible to display in a browser window what your bot is doing.
 Just run `npm install prismarine-viewer` and add this to your bot:
 ```js
 const { mineflayer: mineflayerViewer } = require('prismarine-viewer')
@@ -118,7 +115,7 @@ And you'll get a *live* view looking like this:
 |[viewer](https://github.com/PrismarineJS/mineflayer/tree/master/examples/viewer) | Display your bot world view in the browser |
 |[pathfinder](https://github.com/PrismarineJS/mineflayer/tree/master/examples/pathfinder) | Make your bot go to any location automatically |
 |[chest](https://github.com/PrismarineJS/mineflayer/blob/master/examples/chest.js) | Use chests, furnaces, dispensers, enchantment tables |
-|[digger](https://github.com/PrismarineJS/mineflayer/blob/master/examples/digger.js) | Learn how to create a simple bot that is capable of digging the block |
+|[digger](https://github.com/PrismarineJS/mineflayer/blob/master/examples/digger.js) | Learn how to create a simple bot that is capable of digging blocks |
 |[discord](https://github.com/PrismarineJS/mineflayer/blob/master/examples/discord.js) | Connect a discord bot with a mineflayer bot |
 |[jumper](https://github.com/PrismarineJS/mineflayer/blob/master/examples/jumper.js) | Learn how to move, jump, ride vehicles, attack nearby entities |
 |[ansi](https://github.com/PrismarineJS/mineflayer/blob/master/examples/ansi.js) | Display your bot's chat with all of the chat colors shown in your terminal |
@@ -182,14 +179,17 @@ The most updated and useful are :
  * [pathfinder](https://github.com/Karang/mineflayer-pathfinder) - advanced A* pathfinding with a lot of configurable features
  * [prismarine-viewer](https://github.com/PrismarineJS/prismarine-viewer) - simple web chunk viewer
  * [web-inventory](https://github.com/ImHarvol/mineflayer-web-inventory) - web based inventory viewer
- * [statemachine](https://github.com/TheDudeFromCI/mineflayer-statemachine) - A state machine API for more complex bot behavors
- * [Armor Manager](https://github.com/G07cha/MineflayerArmorManager) - automatic armor managment
+ * [statemachine](https://github.com/TheDudeFromCI/mineflayer-statemachine) - A state machine API for more complex bot behaviors
+ * [Armor Manager](https://github.com/G07cha/MineflayerArmorManager) - automatic armor management
  * [Collect Block](https://github.com/TheDudeFromCI/mineflayer-collectblock) - Quick and simple block collection API.
  * [Dashboard](https://github.com/wvffle/mineflayer-dashboard) - Frontend dashboard for mineflayer bot
  * [PVP](https://github.com/TheDudeFromCI/mineflayer-pvp) - Easy API for basic PVP and PVE.
- * [auto-eat](https://github.com/LINKdiscordd/mineflayer-auto-eat) - Automatic eating of food.
+ * [Auto Eat](https://github.com/link-discord/mineflayer-auto-eat) - Automatic eating of food.
+ * [Auto Crystal](https://github.com/link-discord/mineflayer-autocrystal) - Automatic placing & breaking of end crystals.
  * [Tool](https://github.com/TheDudeFromCI/mineflayer-tool) - A utility for automatic tool/weapon selection with a high level API.
  * [Hawkeye](https://github.com/sefirosweb/minecraftHawkEye) - A utility for using auto-aim with bows.
+ * [GUI](https://github.com/firejoust/mineflayer-GUI) - Eased navigation & management of nested chest-GUI windows
+ * [Projectile](https://github.com/firejoust/mineflayer-projectile) - Configurable tool for projectile based combat
 
 
  But also check out :
@@ -204,6 +204,7 @@ The most updated and useful are :
  * [Bloodhound](https://github.com/Nixes/mineflayer-bloodhound) - determine who and what is responsible for damage to another entity
  * [tps](https://github.com/SiebeDW/mineflayer-tps) - get the current tps (processed tps)
  * [panorama](https://github.com/IceTank/mineflayer-panorama) - take Panorama Images of your world
+ * [player-death-event](https://github.com/tuanzisama/mineflayer-death-event) - emit player death event in Mineflayer.
 
 ## Projects Using Mineflayer
 

package/docs/api.md

@@ -86,6 +86,7 @@
       - [bot.username](#botusername)
       - [bot.spawnPoint](#botspawnpoint)
       - [bot.heldItem](#bothelditem)
+      - [bot.usingHeldItem](#botusinghelditem)
       - [bot.game.levelType](#botgameleveltype)
       - [bot.game.dimension](#botgamedimension)
       - [bot.game.difficulty](#botgamedifficulty)
@@ -105,13 +106,13 @@
       - [bot.settings.viewDistance](#botsettingsviewdistance)
       - [bot.settings.difficulty](#botsettingsdifficulty)
       - [bot.settings.skinParts](#botsettingsskinparts)
-        - [bot.settings.skinParts.showCape](#botsettingsskinpartsshowcape)
-        - [bot.settings.skinParts.showJacket](#botsettingsskinpartsshowjacket)
-        - [bot.settings.skinParts.showLeftSleeve](#botsettingsskinpartsshowleftsleeve)
-        - [bot.settings.skinParts.showRightSleeve](#botsettingsskinpartsshowrightsleeve)
-        - [bot.settings.skinParts.showLeftPants](#botsettingsskinpartsshowleftpants)
-        - [bot.settings.skinParts.showRightPants](#botsettingsskinpartsshowrightpants)
-        - [bot.settings.skinParts.showHat](#botsettingsskinpartsshowhat)
+        - [bot.settings.skinParts.showCape - boolean](#botsettingsskinpartsshowcape---boolean)
+        - [bot.settings.skinParts.showJacket - boolean](#botsettingsskinpartsshowjacket---boolean)
+        - [bot.settings.skinParts.showLeftSleeve - boolean](#botsettingsskinpartsshowleftsleeve---boolean)
+        - [bot.settings.skinParts.showRightSleeve - boolean](#botsettingsskinpartsshowrightsleeve---boolean)
+        - [bot.settings.skinParts.showLeftPants - boolean](#botsettingsskinpartsshowleftpants---boolean)
+        - [bot.settings.skinParts.showRightPants - boolean](#botsettingsskinpartsshowrightpants---boolean)
+        - [bot.settings.skinParts.showHat - boolean](#botsettingsskinpartsshowhat---boolean)
       - [bot.experience.level](#botexperiencelevel)
       - [bot.experience.points](#botexperiencepoints)
       - [bot.experience.progress](#botexperienceprogress)
@@ -157,13 +158,13 @@
       - ["weatherUpdate"](#weatherupdate)
       - ["time"](#time)
       - ["kicked" (reason, loggedIn)](#kicked-reason-loggedin)
-      - ["end"](#end)
+      - ["end" (reason)](#end-reason)
       - ["error" (err)](#error-err)
       - ["spawnReset"](#spawnreset)
       - ["death"](#death)
       - ["health"](#health)
       - ["breath"](#breath)
-      - ["entityAttributes"](#entityattributes-entity)
+      - ["entityAttributes" (entity)](#entityattributes-entity)
       - ["entitySwingArm" (entity)](#entityswingarm-entity)
       - ["entityHurt" (entity)](#entityhurt-entity)
       - ["entityDead" (entity)](#entitydead-entity)
@@ -237,6 +238,7 @@
       - [bot.waitForChunksToLoad(cb)](#botwaitforchunkstoloadcb)
       - [bot.blockInSight(maxSteps, vectorLength)](#botblockinsightmaxsteps-vectorlength)
       - [bot.blockAtCursor(maxDistance=256)](#botblockatcursormaxdistance256)
+      - [bot.blockAtEntityCursor(entity=bot.entity, maxDistance=256)](#botblockatentitycursorentitybotentity-maxdistance256)
       - [bot.canSeeBlock(block)](#botcanseeblockblock)
       - [bot.findBlocks(options)](#botfindblocksoptions)
       - [bot.findBlock(options)](#botfindblockoptions)
@@ -245,7 +247,7 @@
       - [bot.recipesAll(itemType, metadata, craftingTable)](#botrecipesallitemtype-metadata-craftingtable)
       - [bot.nearestEntity(match = (entity) => { return true })](#botnearestentitymatch--entity---return-true-)
     - [Methods](#methods)
-      - [bot.end()](#botend)
+      - [bot.end(reason)](#botendreason)
       - [bot.quit(reason)](#botquitreason)
       - [bot.tabComplete(str, cb, [assumeCommand], [sendBlockInSight])](#bottabcompletestr-cb-assumecommand-sendblockinsight)
       - [bot.chat(message)](#botchatmessage)
@@ -264,9 +266,8 @@
       - [bot.wake([cb])](#botwakecb)
       - [bot.setControlState(control, state)](#botsetcontrolstatecontrol-state)
       - [bot.getControlState(control)](#botgetcontrolstatecontrol)
-      - [bot.getControlState(control)](#botgetcontrolstatecontrol-state)
-      - [bot.getExplosionDamages(entity, position, radius, [rawDamages])](#botgetexplosiondamages)
       - [bot.clearControlStates()](#botclearcontrolstates)
+      - [bot.getExplosionDamages(entity, position, radius, [rawDamages])](#botgetexplosiondamagesentity-position-radius-rawdamages)
       - [bot.lookAt(point, [force], [callback])](#botlookatpoint-force-callback)
       - [bot.look(yaw, pitch, [force], [callback])](#botlookyaw-pitch-force-callback)
       - [bot.updateSign(block, text)](#botupdatesignblock-text)
@@ -280,6 +281,7 @@
       - [bot.acceptResourcePack()](#botacceptresourcepack)
       - [bot.denyResourcePack()](#botdenyresourcepack)
       - [bot.placeBlock(referenceBlock, faceVector, cb)](#botplaceblockreferenceblock-facevector-cb)
+      - [bot.placeEntity(referenceBlock, faceVector)](#botplaceentityreferenceblock-facevector)
       - [bot.activateBlock(block, [callback])](#botactivateblockblock-callback)
       - [bot.activateEntity(entity, [callback])](#botactivateentityentity-callback)
       - [bot.activateEntityAt(entity, position, [callback])](#botactivateentityatentity-position-callback)
@@ -288,8 +290,8 @@
       - [bot.activateItem(offHand=false)](#botactivateitemoffhandfalse)
       - [bot.deactivateItem()](#botdeactivateitem)
       - [bot.useOn(targetEntity)](#botuseontargetentity)
-      - [bot.attack(entity)](#botattackentity)
-      - [bot.swingArm([hand])](#botswingarmhand)
+      - [bot.attack(entity, swing = true)](#botattackentity-swing--true)
+      - [bot.swingArm([hand], showHand)](#botswingarmhand-showhand)
       - [bot.mount(entity)](#botmountentity)
       - [bot.dismount()](#botdismount)
       - [bot.moveVehicle(left,forward)](#botmovevehicleleftforward)
@@ -309,8 +311,8 @@
       - [bot.waitForTicks(ticks)](#botwaitforticksticks)
     - [Lower level inventory methods](#lower-level-inventory-methods)
       - [bot.clickWindow(slot, mouseButton, mode, cb)](#botclickwindowslot-mousebutton-mode-cb)
-      - [bot.putSelectedItemRange(start, end, window, slot, noWaiting)](#botputselecteditemrangestart-end-window-slot-nowaiting)
-      - [bot.putAway(slot, noWaiting)](#botputawayslot-nowaiting)
+      - [bot.putSelectedItemRange(start, end, window, slot)](#botputselecteditemrangestart-end-window-slot)
+      - [bot.putAway(slot)](#botputawayslot)
       - [bot.closeWindow(window)](#botclosewindowwindow)
       - [bot.transfer(options, cb)](#bottransferoptions-cb)
       - [bot.openBlock(block)](#botopenblockblock)
@@ -755,6 +757,7 @@ Create and return an instance of the class bot.
  * [difficulty](#bot.settings.difficulty)
  * [skinParts](#bot.settings.skinParts)
  * chatLengthLimit : the maximum amount of characters that can be sent in a single message. If this is not set, it will be 100 in < 1.11 and 256 in >= 1.11.
+ * defaultChatPatterns: defaults to true, set to false to not add the patterns such as chat and whisper
 
 ### Properties
 
@@ -797,6 +800,10 @@ Coordinates to the main spawn point, where all compasses point to.
 
 The item in the bot's hand, represented as a [prismarine-item](https://github.com/PrismarineJS/prismarine-item) instance specified with arbitrary metadata, nbtdata, etc.
 
+#### bot.usingHeldItem
+
+Whether the bot is using the item that it's holding, for example eating food or using a shield.
+
 #### bot.game.levelType
 
 #### bot.game.dimension
@@ -828,6 +835,8 @@ Bot's player object
 }
 ```
 
+A player's ping starts at 0, you might have to wait a bit for the server to send their actual ping.
+
 #### bot.players
 
 Map of username to people playing the game.
@@ -1147,9 +1156,10 @@ is a chat message explaining why you were kicked. `loggedIn`
 is `true` if the client was kicked after successfully logging in,
 or `false` if the kick occurred in the login phase.
 
-#### "end"
+#### "end" (reason)
 
 Emitted when you are no longer connected to the server.
+`reason` is a string explaining why the client was disconnected. (defaults to 'socketClosed')
 
 #### "error" (err)
 
@@ -1441,6 +1451,12 @@ Returns the block at which bot is looking at or `null`
 Returns the block at which bot is looking at or `null`
  * `maxDistance` - The maximum distance the block can be from the eye, defaults to 256.
 
+#### bot.blockAtEntityCursor(entity=bot.entity, maxDistance=256)
+
+Returns the block at which specific entity is looking at or `null`
+ * `entity` - Entity data as `Object`
+ * `maxDistance` - The maximum distance the block can be from the eye, defaults to 256.
+
 #### bot.canSeeBlock(block)
 
 Returns true or false depending on whether the bot can see the specified `block`.
@@ -1489,11 +1505,17 @@ The same as bot.recipesFor except that it does not check wether the bot has enou
 
 Return the nearest entity to the bot, matching the function (default to all entities). Return null if no entity is found.
 
+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
+```
+
 ### Methods
 
-#### bot.end()
+#### bot.end(reason)
 
 End the connection with the server.
+* `reason` - Optional string that states the reason of the end.
 
 #### bot.quit(reason)
 
@@ -1652,6 +1674,7 @@ Sets all controls to off.
 #### bot.getExplosionDamages(entity, position, radius, [rawDamages])
 
 Returns how much damage will be done to the entity in a radius around the position of the explosion.
+It will return `null` if the entity has no armor and rawDamages is not set to true, since the function can't calculate the damage with armor if there is no armor.
 
 * `entity` - Entity instance
 * `position` - [Vec3](https://github.com/andrewrk/node-vec3) instance
@@ -1739,12 +1762,14 @@ 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.
+ * `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.
  * `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.
  * `callback(err)` - (optional) called when the block is broken or you
    are interrupted.
 
+If you call bot.dig twice before the first dig is finished, you will get a fatal 'diggingAborted' error.
+
 #### bot.stopDigging()
 
 #### bot.digTime(block)
@@ -1838,10 +1863,13 @@ Deactivates the currently held item. This is how you release an arrow, stop eati
 Use the currently held item on an `Entity` instance. This is how you apply a saddle and
 use shears.
 
-#### bot.attack(entity)
+#### bot.attack(entity, swing = true)
 
 Attack a player or a mob.
 
+ * `entity` is a type of entity. To get a specific entity use [bot.nearestEntity()](#botnearestentitymatch--entity---return-true-) or [bot.entities](#botentities).
+ * `swing` Default `true`. If false the bot does not swing is arm when attacking.
+
 #### bot.swingArm([hand], showHand)
 
 Play an arm swing animation.
@@ -1963,20 +1991,15 @@ This function also returns a `Promise`, with `void` as its argument upon complet
 
 Click on the current window. See details at https://wiki.vg/Protocol#Click_Window
 
-#### bot.putSelectedItemRange(start, end, window, slot, noWaiting)
+#### bot.putSelectedItemRange(start, end, window, slot)
 
 This function also returns a `Promise`, with `void` as its argument upon completion.
 
 Put the item at `slot` in the specified range.
 
-`noWaiting` will not wait for items to be moved.
-Can be useful in case the client is supposed to simulate without feedback from the server.
-
-#### bot.putAway(slot, noWaiting)
+#### bot.putAway(slot)
 
 This function also returns a `Promise`, with `void` as its argument upon completion.
-`noWaiting` calls putSelectedItemRange with `noWaiting` option: it will not wait for items to be moved.
-Can be useful in case the client is supposed to simulate without feedback from the server.
 
 Put the item at `slot` in the inventory.
 

package/docs/es/README_ES.md

@@ -8,7 +8,7 @@
 
 [![Try it on gitpod](https://img.shields.io/badge/try-on%20gitpod-brightgreen.svg)](https://gitpod.io/#https://github.com/PrismarineJS/mineflayer)
 
-| 🇺🇸 [English](../README.md) | 🇷🇺 [Russian](../ru/README_RU.md) | 🇪🇸 [Spanish](../es/README_ES.md) | 🇫🇷 [French](../fr/README_FR.md) | 🇹🇷 [Turkish](../tr/README_TR.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) |
 |-------------------------|----------------------------|----------------------------|----------------------------|----------------------------|
 
 Crea bots para Minecraft con una API de JavaScript potente, estable y de alto nivel.