mineflayer 3.16.0 → 3.17.0

package/README.md

@@ -2,11 +2,12 @@
 
 [![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)
 [![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) |
 |-------------------------|----------------------------|----------------------------|----------------------------|----------------------------|----------------------------|
 

package/docs/README.md

@@ -2,11 +2,12 @@
 
 [![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)
 [![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) |
 |-------------------------|----------------------------|----------------------------|----------------------------|----------------------------|----------------------------|
 

package/docs/history.md

@@ -1,3 +1,7 @@
+## 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

package/examples/anvil.js

@@ -63,24 +63,22 @@ bot.on('chat', async (username, message) => {
   }
 })
 
-function tossItem (name, amount) {
+async function tossItem (name, amount) {
   amount = parseInt(amount, 10)
   const item = itemByName(name)
   if (!item) {
     bot.chat(`I have no ${name}`)
-  } else if (amount) {
-    bot.toss(item.type, null, amount, checkIfTossed)
   } else {
-    bot.tossStack(item, checkIfTossed)
-  }
-
-  function checkIfTossed (err) {
-    if (err) {
+    try {
+      if (amount) {
+        await bot.toss(item.type, null, amount)
+        bot.chat(`tossed ${amount} x ${name}`)
+      } else {
+        await bot.tossStack(item)
+        bot.chat(`tossed ${name}`)
+      }
+    } catch (err) {
       bot.chat(`unable to toss: ${err.message}`)
-    } else if (amount) {
-      bot.chat(`tossed ${amount} x ${name}`)
-    } else {
-      bot.chat(`tossed ${name}`)
     }
   }
 }

package/examples/chest.js

@@ -220,38 +220,36 @@ async function watchFurnace () {
       bot.removeListener('chat', onChat)
     }
 
-    function putInFurnace (where, name, amount) {
+    async function putInFurnace (where, name, amount) {
       const item = itemByName(furnace.items(), name)
       if (item) {
         const fn = {
           input: furnace.putInput,
           fuel: furnace.putFuel
         }[where]
-        fn.call(furnace, item.type, null, amount, (err) => {
-          if (err) {
-            bot.chat(`unable to put ${amount} ${item.name}`)
-          } else {
-            bot.chat(`put ${amount} ${item.name}`)
-          }
-        })
+        try {
+          await fn.call(furnace, item.type, null, amount)
+          bot.chat(`put ${amount} ${item.name}`)
+        } catch (err) {
+          bot.chat(`unable to put ${amount} ${item.name}`)
+        }
       } else {
         bot.chat(`unknown item ${name}`)
       }
     }
 
-    function takeFromFurnace (what) {
+    async function takeFromFurnace (what) {
       const fn = {
         input: furnace.takeInput,
         fuel: furnace.takeFuel,
         output: furnace.takeOutput
       }[what]
-      fn.call(furnace, (err, item) => {
-        if (err) {
-          bot.chat(`unable to take ${item.name}`)
-        } else {
-          bot.chat(`took ${item.name}`)
-        }
-      })
+      try {
+        const item = await fn.call(furnace)
+        bot.chat(`took ${item.name}`)
+      } catch (err) {
+        bot.chat('unable to take')
+      }
     }
   }
 }

package/examples/digger.js

@@ -56,7 +56,7 @@ function sayItems (items = bot.inventory.items()) {
   }
 }
 
-function dig () {
+async function dig () {
   let target
   if (bot.targetDigBlock) {
     bot.chat(`already digging ${bot.targetDigBlock.name}`)
@@ -64,19 +64,16 @@ function dig () {
     target = bot.blockAt(bot.entity.position.offset(0, -1, 0))
     if (target && bot.canDigBlock(target)) {
       bot.chat(`starting to dig ${target.name}`)
-      bot.dig(target, onDiggingCompleted)
+      try {
+        await bot.dig(target)
+        bot.chat(`finished digging ${target.name}`)
+      } catch (err) {
+        console.log(err.stack)
+      }
     } else {
       bot.chat('cannot dig')
     }
   }
-
-  function onDiggingCompleted (err) {
-    if (err) {
-      console.log(err.stack)
-      return
-    }
-    bot.chat(`finished digging ${target.name}`)
-  }
 }
 
 function build () {
@@ -87,28 +84,26 @@ function build () {
 
   let tryCount = 0
 
-  function placeIfHighEnough () {
+  async function placeIfHighEnough () {
     if (bot.entity.position.y > jumpY) {
-      bot.placeBlock(referenceBlock, vec3(0, 1, 0), (err) => {
-        if (err) {
-          tryCount++
-          if (tryCount > 10) {
-            bot.chat(err.message)
-            bot.setControlState('jump', false)
-            bot.removeListener('move', placeIfHighEnough)
-            return
-          }
-          return
-        }
+      try {
+        await bot.placeBlock(referenceBlock, vec3(0, 1, 0))
         bot.setControlState('jump', false)
         bot.removeListener('move', placeIfHighEnough)
         bot.chat('Placing a block was successful')
-      })
+      } catch (err) {
+        tryCount++
+        if (tryCount > 10) {
+          bot.chat(err.message)
+          bot.setControlState('jump', false)
+          bot.removeListener('move', placeIfHighEnough)
+        }
+      }
     }
   }
 }
 
-function equipDirt () {
+async function equipDirt () {
   const mcData = require('minecraft-data')(bot.version)
   let itemsByName
   if (bot.supportFeature('itemsAreNotBlocks')) {
@@ -116,13 +111,12 @@ function equipDirt () {
   } else if (bot.supportFeature('itemsAreAlsoBlocks')) {
     itemsByName = 'blocksByName'
   }
-  bot.equip(mcData[itemsByName].dirt.id, 'hand', (err) => {
-    if (err) {
-      bot.chat(`unable to equip dirt: ${err.message}`)
-    } else {
-      bot.chat('equipped dirt')
-    }
-  })
+  try {
+    await bot.equip(mcData[itemsByName].dirt.id, 'hand')
+    bot.chat('equipped dirt')
+  } catch (err) {
+    bot.chat(`unable to equip dirt: ${err.message}`)
+  }
 }
 
 function itemToString (item) {

package/examples/inventory.js

@@ -77,24 +77,22 @@ function sayItems (items = null) {
   }
 }
 
-function tossItem (name, amount) {
+async function tossItem (name, amount) {
   amount = parseInt(amount, 10)
   const item = itemByName(name)
   if (!item) {
     bot.chat(`I have no ${name}`)
-  } else if (amount) {
-    bot.toss(item.type, null, amount, checkIfTossed)
   } else {
-    bot.tossStack(item, checkIfTossed)
-  }
-
-  function checkIfTossed (err) {
-    if (err) {
+    try {
+      if (amount) {
+        await bot.toss(item.type, null, amount)
+        bot.chat(`tossed ${amount} x ${name}`)
+      } else {
+        await bot.tossStack(item)
+        bot.chat(`tossed ${name}`)
+      }
+    } catch (err) {
       bot.chat(`unable to toss: ${err.message}`)
-    } else if (amount) {
-      bot.chat(`tossed ${amount} x ${name}`)
-    } else {
-      bot.chat(`tossed ${name}`)
     }
   }
 }

package/lib/plugins/chat.js

@@ -1,4 +1,5 @@
 const { once } = require('events')
+const { printCallbackDepreciation } = require('../promise_utils')
 
 module.exports = inject
 
@@ -198,6 +199,16 @@ function callbackify (f) { // specifically for this function because cb isn't th
   return function (...args) {
     const cb = args[1]
     args.splice(1, 1)
-    return f(...args).then(r => { if (cb) { cb(undefined, r) } return r }, err => { if (cb) { cb(err) } else throw err })
+    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/digging.js

@@ -1,5 +1,5 @@
 const { performance } = require('perf_hooks')
-const { createDoneTask, createTask } = require('../promise_utils')
+const { createDoneTask, createTask, printCallbackDepreciation } = require('../promise_utils')
 const BlockFaces = require('prismarine-world').iterators.BlockFace
 const { Vec3 } = require('vec3')
 
@@ -213,7 +213,17 @@ function callbackify (f) { // specifically for this function because cb could be
     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) { cb(undefined, r) } return r }, err => { if (cb) { cb(err) } else throw err })
+    return f(...args).then(r => {
+      if (cb) {
+        printCallbackDepreciation()
+        cb(undefined, r)
+      } return r
+    }, err => {
+      if (cb) {
+        printCallbackDepreciation()
+        cb(err)
+      } else throw err
+    })
   }
 }
 

package/lib/promise_utils.js

@@ -1,10 +1,22 @@
+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) { cb(undefined, r) }
+      if (cb) {
+        printCallbackDepreciation()
+        cb(undefined, r)
+      }
       return r
-    }, err => { if (cb) { cb(err) } else throw err })
+    }, err => {
+      if (cb) {
+        printCallbackDepreciation()
+        cb(err)
+      } else throw err
+    })
   }
 }
 
@@ -97,5 +109,6 @@ module.exports = {
   createTask,
   createDoneTask,
   onceWithCleanup,
-  withTimeout
+  withTimeout,
+  printCallbackDepreciation
 }

package/package.json

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