mineflayer 3.18.0 → 4.0.0

package/README.md

@@ -17,7 +17,7 @@ First time using Node.js? You may want to start with the [tutorial](tutorial.md)
 
 ## Features
 
- * Supports Minecraft 1.8, 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/README.md

@@ -17,7 +17,7 @@ First time using Node.js? You may want to start with the [tutorial](tutorial.md)
 
 ## Features
 
- * Supports Minecraft 1.8, 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/es/README_ES.md

@@ -17,7 +17,7 @@ Crea bots para Minecraft con una API de JavaScript potente, estable y de alto ni
 
 ## Características
 
- * Soporta Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15 y 1.16.
+ * Soporta Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17 y 1.18.
  * Rastreo e información de entidades.
  * Información sobre bloques. Puedes solicitar información de todo lo que te rodea. Encuentra bloques en milisegundos
  * Físicas y movimientos básicos - maneja todos los cuadros de colisión
@@ -34,6 +34,7 @@ Crea bots para Minecraft con una API de JavaScript potente, estable y de alto ni
 Echa un vistazo a nuestros [proyectos actuales](https://github.com/PrismarineJS/mineflayer/wiki/Big-Prismarine-projects)
 
 ## Instalación
+Primero instala Node.js >= 14 desde [nodejs.org](https://nodejs.org/)
 
 `npm install mineflayer`
 
@@ -66,10 +67,9 @@ Si quieres aprender más, puedes mirar [aquí, ](https://www.youtube.com/playlis
 
 **Empezando**
 
-Sin especificar una versión, la versión del servidor se detectará automáticamente, puedes configurar una versión específica utilizando la opción de versión.
-Por ejemplo `version:" 1.8 "`.
+Si no se especifica una versión, la versión del servidor se detectará automáticamente. Si no se especifica ningún tipo de autenticación, se utilizará el login de Mojang automáticamente. 
 
-### Ejemplo
+### Ejemplo: echo
 ```js
 const mineflayer = require('mineflayer')
 
@@ -92,7 +92,7 @@ bot.on('kicked', (reason, loggedIn) => console.log(reason, loggedIn))
 bot.on('error', err => console.log(err))
 ```
 
-### Mira lo que tu bot hace
+### Mira lo que hace tu bot
 
 Gracias al proyecto [prismarine-viewer](https://github.com/PrismarineJS/prismarine-viewer), puedes ver en una pestaña del navegador qué está haciendo tu bot.
 Solo tienes que ejecutar `npm install prismarine-viewer` y añadir lo siguiente a tu bot:
@@ -124,7 +124,7 @@ Más ejemplos en la carpeta de [ejemplos](https://github.com/PrismarineJS/minefl
 
 ### Módulos
 
-La mayoría del desarrollo se esta produciendo dentro de pequeños módulos npm que son usados por mineflayer
+La mayoría del desarrollo se está produciendo dentro de pequeños módulos npm que son usados por mineflayer
 
 #### The Node Way™
 

package/docs/history.md

@@ -1,3 +1,8 @@
+## 4.0.0
+
+* useEntity maintains sneak state
+* BREAKING: remove all callbacks in favor of promises
+
 ## 3.18.0
 
 * remove callbacks from types and docs

package/lib/plugins/anvil.js

@@ -1,5 +1,5 @@
 const assert = require('assert')
-const { callbackify, sleep } = require('../promise_utils')
+const { sleep } = require('../promise_utils')
 const { once } = require('events')
 
 module.exports = inject
@@ -105,11 +105,11 @@ function inject (bot) {
       await bot.transfer(options)
     }
 
-    anvil.combine = callbackify(combine)
-    anvil.rename = callbackify(rename)
+    anvil.combine = combine
+    anvil.rename = rename
 
     return anvil
   }
 
-  bot.openAnvil = callbackify(openAnvil)
+  bot.openAnvil = openAnvil
 }

package/lib/plugins/bed.js

@@ -1,5 +1,4 @@
 const { Vec3 } = require('vec3')
-const { callbackify } = require('../promise_utils')
 
 module.exports = inject
 
@@ -174,7 +173,7 @@ function inject (bot) {
   })
 
   bot.parseBedMetadata = parseBedMetadata
-  bot.wake = callbackify(wake)
-  bot.sleep = callbackify(sleep)
+  bot.wake = wake
+  bot.sleep = sleep
   bot.isABed = isABed
 }

package/lib/plugins/blocks.js

@@ -1,7 +1,7 @@
 const { Vec3 } = require('vec3')
 const assert = require('assert')
 const Painting = require('../painting')
-const { onceWithCleanup, callbackify } = require('../promise_utils')
+const { onceWithCleanup } = require('../promise_utils')
 
 const { OctahedronIterator } = require('prismarine-world').iterators
 
@@ -548,7 +548,7 @@ function inject (bot, { version, storageBuilder }) {
   bot.canSeeBlock = canSeeBlock
   bot.blockAt = blockAt
   bot._updateBlockState = updateBlockState
-  bot.waitForChunksToLoad = callbackify(waitForChunksToLoad)
+  bot.waitForChunksToLoad = waitForChunksToLoad
 }
 
 function onesInShort (n) {

package/lib/plugins/book.js

@@ -1,6 +1,5 @@
 const assert = require('assert')
 const { once } = require('events')
-const { callbackify } = require('../promise_utils')
 
 module.exports = inject
 
@@ -83,11 +82,11 @@ function inject (bot, { version }) {
     return book
   }
 
-  bot.writeBook = callbackify(async (slot, pages) => {
+  bot.writeBook = async (slot, pages) => {
     await write(slot, pages, null, null, false)
-  })
+  }
 
-  bot.signBook = callbackify(async (slot, pages, author, title) => {
+  bot.signBook = async (slot, pages, author, title) => {
     await write(slot, pages, author, title, true)
-  })
+  }
 }

package/lib/plugins/chat.js

@@ -1,5 +1,4 @@
 const { once } = require('events')
-const { printCallbackDepreciation } = require('../promise_utils')
 
 module.exports = inject
 
@@ -170,7 +169,7 @@ function inject (bot, options) {
     chatWithHeader('', message)
   }
 
-  bot.tabComplete = callbackify(tabComplete)
+  bot.tabComplete = tabComplete
 
   function addDefaultPatterns () {
     if (!defaultChatPatterns) return
@@ -194,21 +193,3 @@ function inject (bot, options) {
   }
   bot.awaitMessage = awaitMessage
 }
-
-function callbackify (f) { // specifically for this function because cb isn't the last parameter
-  return function (...args) {
-    const cb = args[1]
-    args.splice(1, 1)
-    return f(...args).then(r => {
-      if (cb) {
-        printCallbackDepreciation()
-        cb(undefined, r)
-      } return r
-    }, err => {
-      if (cb) {
-        printCallbackDepreciation()
-        cb(err)
-      } else throw err
-    })
-  }
-}

package/lib/plugins/chest.js

@@ -1,4 +1,3 @@
-const { callbackify } = require('../promise_utils')
 
 module.exports = inject
 
@@ -26,7 +25,7 @@ function inject (bot) {
     return chest
   }
 
-  bot.openContainer = callbackify(openContainer)
-  bot.openChest = callbackify(openContainer)
-  bot.openDispenser = callbackify(openContainer)
+  bot.openContainer = openContainer
+  bot.openChest = openContainer
+  bot.openDispenser = openContainer
 }

package/lib/plugins/craft.js

@@ -1,6 +1,5 @@
 const assert = require('assert')
 const { once } = require('events')
-const { callbackify } = require('../promise_utils')
 
 module.exports = inject
 
@@ -226,7 +225,7 @@ function inject (bot, { version }) {
     return true
   }
 
-  bot.craft = callbackify(craft)
+  bot.craft = craft
   bot.recipesFor = recipesFor
   bot.recipesAll = recipesAll
 }

package/lib/plugins/creative.js

@@ -1,6 +1,6 @@
 const assert = require('assert')
 const { Vec3 } = require('vec3')
-const { callbackify, sleep } = require('../promise_utils')
+const { sleep } = require('../promise_utils')
 const { once } = require('events')
 
 module.exports = inject
@@ -10,8 +10,8 @@ function inject (bot, { version }) {
 
   // these features only work when you are in creative mode.
   bot.creative = {
-    setInventorySlot: callbackify(setInventorySlot),
-    flyTo: callbackify(flyTo),
+    setInventorySlot: setInventorySlot,
+    flyTo: flyTo,
     startFlying,
     stopFlying
   }
@@ -23,7 +23,7 @@ function inject (bot, { version }) {
     }
   })
 
-  // WARN: This method should not be called twice on the same slot before first callback succeeds
+  // WARN: This method should not be called twice on the same slot before first promise succeeds
   async function setInventorySlot (slot, item) {
     assert(slot >= 0 && slot <= 44)
 

package/lib/plugins/digging.js

@@ -1,5 +1,5 @@
 const { performance } = require('perf_hooks')
-const { createDoneTask, createTask, printCallbackDepreciation } = require('../promise_utils')
+const { createDoneTask, createTask } = require('../promise_utils')
 const BlockFaces = require('prismarine-world').iterators.BlockFace
 const { Vec3 } = require('vec3')
 
@@ -198,35 +198,12 @@ function inject (bot) {
     return block.digTime(type, creative, bot.entity.isInWater, !bot.entity.onGround, enchantments, bot.entity.effects)
   }
 
-  bot.dig = callbackify(dig)
+  bot.dig = dig
   bot.stopDigging = noop
   bot.canDigBlock = canDigBlock
   bot.digTime = digTime
 }
 
-function callbackify (f) { // specifically for this function because cb could be the non-last parameter
-  return function (...args) {
-    const cbIndex = typeof args[1] === 'function' ? 1 : (typeof args[2] === 'function' ? 2 : 3)
-    const cb = args[cbIndex]
-
-    if (cbIndex === 1) args[1] = true
-    else if (typeof args[1] === 'string') args[1] = args[1] === 'ignore' ? args[1] : false
-    else args[1] = !!args[1] // coerce to boolean
-
-    return f(...args).then(r => {
-      if (cb) {
-        printCallbackDepreciation()
-        cb(undefined, r)
-      } return r
-    }, err => {
-      if (cb) {
-        printCallbackDepreciation()
-        cb(err)
-      } else throw err
-    })
-  }
-}
-
 function noop (err) {
   if (err) throw err
 }

package/lib/plugins/enchantment_table.js

@@ -1,6 +1,5 @@
 const assert = require('assert')
 const { once } = require('events')
-const { callbackify } = require('../promise_utils')
 
 module.exports = inject
 
@@ -15,10 +14,10 @@ function inject (bot) {
 
     resetEnchantmentOptions()
 
-    enchantmentTable.enchant = callbackify(enchant)
-    enchantmentTable.takeTargetItem = callbackify(takeTargetItem)
-    enchantmentTable.putTargetItem = callbackify(putTargetItem)
-    enchantmentTable.putLapis = callbackify(putLapis)
+    enchantmentTable.enchant = enchant
+    enchantmentTable.takeTargetItem = takeTargetItem
+    enchantmentTable.putTargetItem = putTargetItem
+    enchantmentTable.putLapis = putLapis
     enchantmentTable.targetItem = function () { return this.slots[0] }
 
     bot._client.on('craft_progress_bar', onUpdateWindowProperty)
@@ -100,5 +99,5 @@ function inject (bot) {
     }
   }
 
-  bot.openEnchantmentTable = callbackify(openEnchantmentTable)
+  bot.openEnchantmentTable = openEnchantmentTable
 }

package/lib/plugins/entities.js

@@ -588,6 +588,7 @@ function inject (bot, { version }) {
   }
 
   function useEntity (target, leftClick, x, y, z) {
+    const sneaking = bot.getControlState('sneak')
     if (x && y && z) {
       bot._client.write('use_entity', {
         target: target.id,
@@ -595,13 +596,13 @@ function inject (bot, { version }) {
         x,
         y,
         z,
-        sneaking: false
+        sneaking
       })
     } else {
       bot._client.write('use_entity', {
         target: target.id,
         mouse: leftClick,
-        sneaking: false
+        sneaking
       })
     }
   }

package/lib/plugins/fishing.js

@@ -1,5 +1,5 @@
 const { Vec3 } = require('vec3')
-const { callbackify, createDoneTask, createTask } = require('../promise_utils')
+const { createDoneTask, createTask } = require('../promise_utils')
 
 module.exports = inject
 
@@ -54,5 +54,5 @@ function inject (bot) {
     await fishingTask.promise
   }
 
-  bot.fish = callbackify(fish)
+  bot.fish = fish
 }

package/lib/plugins/furnace.js

@@ -1,5 +1,4 @@
 const assert = require('assert')
-const { callbackify } = require('../promise_utils')
 
 module.exports = inject
 
@@ -25,11 +24,11 @@ function inject (bot) {
     furnace.totalProgress = null
     furnace.progress = null
     furnace.progressSeconds = null
-    furnace.takeInput = callbackify(takeInput)
-    furnace.takeFuel = callbackify(takeFuel)
-    furnace.takeOutput = callbackify(takeOutput)
-    furnace.putInput = callbackify(putInput)
-    furnace.putFuel = callbackify(putFuel)
+    furnace.takeInput = takeInput
+    furnace.takeFuel = takeFuel
+    furnace.takeOutput = takeOutput
+    furnace.putInput = putInput
+    furnace.putFuel = putFuel
     furnace.inputItem = function () { return this.slots[0] }
     furnace.fuelItem = function () { return this.slots[1] }
     furnace.outputItem = function () { return this.slots[2] }
@@ -118,5 +117,5 @@ function inject (bot) {
     return ticks * 0.05
   }
 
-  bot.openFurnace = callbackify(openFurnace)
+  bot.openFurnace = openFurnace
 }

package/lib/plugins/inventory.js

@@ -1,7 +1,7 @@
 const assert = require('assert')
 const { Vec3 } = require('vec3')
 const { once } = require('events')
-const { callbackify, sleep, createDoneTask, createTask, withTimeout } = require('../promise_utils')
+const { sleep, createDoneTask, createTask, withTimeout } = require('../promise_utils')
 
 module.exports = inject
 
@@ -306,7 +306,7 @@ function inject (bot, { version, hideErrors }) {
       window.emit('close')
       closeWindow(window)
     }
-    window.withdraw = callbackify(async (itemType, metadata, count) => {
+    window.withdraw = async (itemType, metadata, count) => {
       if (bot.inventory.emptySlotCount() === 0) {
         throw new Error('Unable to withdraw, Bot inventory is full.')
       }
@@ -322,8 +322,8 @@ function inject (bot, { version, hideErrors }) {
         destEnd: window.inventoryEnd
       }
       await transfer(options)
-    })
-    window.deposit = callbackify(async (itemType, metadata, count) => {
+    }
+    window.deposit = async (itemType, metadata, count) => {
       const options = {
         window: window,
         itemType,
@@ -335,7 +335,7 @@ function inject (bot, { version, hideErrors }) {
         destEnd: window.inventoryStart
       }
       await transfer(options)
-    })
+    }
   }
 
   async function openBlock (block) {
@@ -643,21 +643,21 @@ function inject (bot, { version, hideErrors }) {
     bot.emit(`setWindowItems:${window.id}`)
   })
 
-  bot.activateBlock = callbackify(activateBlock)
-  bot.activateEntity = callbackify(activateEntity)
-  bot.activateEntityAt = callbackify(activateEntityAt)
-  bot.consume = callbackify(consume)
+  bot.activateBlock = activateBlock
+  bot.activateEntity = activateEntity
+  bot.activateEntityAt = activateEntityAt
+  bot.consume = consume
   bot.activateItem = activateItem
   bot.deactivateItem = deactivateItem
 
   // not really in the public API
-  bot.clickWindow = callbackify(clickWindow)
+  bot.clickWindow = clickWindow
   bot.putSelectedItemRange = putSelectedItemRange
   bot.putAway = putAway
   bot.closeWindow = closeWindow
-  bot.transfer = callbackify(transfer)
-  bot.openBlock = callbackify(openBlock)
-  bot.openEntity = callbackify(openEntity)
-  bot.moveSlotItem = callbackify(moveSlotItem)
+  bot.transfer = transfer
+  bot.openBlock = openBlock
+  bot.openEntity = openEntity
+  bot.moveSlotItem = moveSlotItem
   bot.updateHeldItem = updateHeldItem
 }

package/lib/plugins/physics.js

@@ -3,7 +3,7 @@ const assert = require('assert')
 const math = require('../math')
 const conv = require('../conversions')
 const { performance } = require('perf_hooks')
-const { callbackify, createDoneTask, createTask } = require('../promise_utils')
+const { createDoneTask, createTask } = require('../promise_utils')
 
 const { Physics, PlayerState } = require('prismarine-physics')
 
@@ -223,7 +223,7 @@ function inject (bot, { physicsEnabled }) {
     }
   })
 
-  bot.look = callbackify(async (yaw, pitch, force) => {
+  bot.look = async (yaw, pitch, force) => {
     if (!lookingTask.done) {
       lookingTask.finish() // finish the previous one
     }
@@ -245,15 +245,15 @@ function inject (bot, { physicsEnabled }) {
     }
 
     await lookingTask.promise
-  })
+  }
 
-  bot.lookAt = callbackify(async (point, force) => {
+  bot.lookAt = async (point, force) => {
     const delta = point.minus(bot.entity.position.offset(0, bot.entity.height, 0))
     const yaw = Math.atan2(-delta.x, -delta.z)
     const groundDistance = Math.sqrt(delta.x * delta.x + delta.z * delta.z)
     const pitch = Math.atan2(delta.y, groundDistance)
     await bot.look(yaw, pitch, force)
-  })
+  }
 
   // player position and look (clientbound)
   bot._client.on('position', (packet) => {

package/lib/plugins/place_block.js

@@ -1,4 +1,4 @@
-const { onceWithCleanup, callbackify } = require('../promise_utils')
+const { onceWithCleanup } = require('../promise_utils')
 
 module.exports = inject
 
@@ -24,6 +24,6 @@ function inject (bot) {
     await placeBlockWithOptions(referenceBlock, faceVector, { swingArm: 'right' })
   }
 
-  bot.placeBlock = callbackify(placeBlock)
+  bot.placeBlock = placeBlock
   bot._placeBlockWithOptions = placeBlockWithOptions
 }

package/lib/plugins/simple_inventory.js

@@ -1,5 +1,4 @@
 const assert = require('assert')
-const { callbackify } = require('../promise_utils')
 
 module.exports = inject
 
@@ -144,10 +143,10 @@ function inject (bot) {
     return bot.clickWindow(slot, 1, 0)
   }
 
-  bot.equip = callbackify(equip)
-  bot.unequip = callbackify(unequip)
-  bot.toss = callbackify(toss)
-  bot.tossStack = callbackify(tossStack)
+  bot.equip = equip
+  bot.unequip = unequip
+  bot.toss = toss
+  bot.tossStack = tossStack
   bot.setQuickBarSlot = setQuickBarSlot
   bot.getEquipmentDestSlot = getDestSlot
   bot.simpleClick = { leftMouse, rightMouse }

package/lib/plugins/villager.js

@@ -1,6 +1,5 @@
 const assert = require('assert')
 const { once } = require('events')
-const { callbackify } = require('../promise_utils')
 
 module.exports = inject
 
@@ -249,6 +248,6 @@ function inject (bot, { version }) {
     await bot.transfer(options)
   }
 
-  bot.openVillager = callbackify(openVillager)
-  bot.trade = callbackify(trade)
+  bot.openVillager = openVillager
+  bot.trade = trade
 }

package/lib/promise_utils.js

@@ -1,25 +1,3 @@
-function printCallbackDepreciation () {
-  console.log('[depreciation notice] Callback are deprecated with mineflayer, use promise instead. They will be removed in version 4.0.0.')
-}
-
-function callbackify (f) {
-  return function (...args) {
-    const cb = args[f.length]
-    return f(...args).then(r => {
-      if (cb) {
-        printCallbackDepreciation()
-        cb(undefined, r)
-      }
-      return r
-    }, err => {
-      if (cb) {
-        printCallbackDepreciation()
-        cb(err)
-      } else throw err
-    })
-  }
-}
-
 function sleep (ms) {
   return new Promise(resolve => setTimeout(resolve, ms))
 }
@@ -104,11 +82,9 @@ function withTimeout (promise, timeout) {
 }
 
 module.exports = {
-  callbackify,
   sleep,
   createTask,
   createDoneTask,
   onceWithCleanup,
-  withTimeout,
-  printCallbackDepreciation
+  withTimeout
 }

package/package.json

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