mineflayer 4.8.0 → 4.8.1

package/README.md

@@ -123,7 +123,7 @@ And you'll get a *live* view looking like this:
 |[guard](https://github.com/PrismarineJS/mineflayer/blob/master/examples/guard.js) | Make a bot guard a defined area from nearby mobs |
 |[multiple-from-file](https://github.com/PrismarineJS/mineflayer/blob/master/examples/multiple_from_file.js) | Add a text file with accounts and have them all login |
 
-And many mores in the [examples](https://github.com/PrismarineJS/mineflayer/tree/master/examples) folder
+And many more in the [examples](https://github.com/PrismarineJS/mineflayer/tree/master/examples) folder.
 
 ### Modules
 

package/docs/README.md

@@ -123,7 +123,7 @@ And you'll get a *live* view looking like this:
 |[guard](https://github.com/PrismarineJS/mineflayer/blob/master/examples/guard.js) | Make a bot guard a defined area from nearby mobs |
 |[multiple-from-file](https://github.com/PrismarineJS/mineflayer/blob/master/examples/multiple_from_file.js) | Add a text file with accounts and have them all login |
 
-And many mores in the [examples](https://github.com/PrismarineJS/mineflayer/tree/master/examples) folder
+And many more in the [examples](https://github.com/PrismarineJS/mineflayer/tree/master/examples) folder.
 
 ### Modules
 

package/docs/history.md

@@ -1,3 +1,12 @@
+## 4.8.1
+
+* Fix client crashing when player_remove contains unknown player (@frej4189)
+* Improve look and fix bug slow craft (@sefirosweb)
+* Fix player entity being unset when player is updated (@frej4189)
+* Fix type (@sefirosweb)
+* Improve crafting stacks (@sefirosweb)
+* add example for using the node:readline module (@Jovan-04)
+
 ## 4.8.0
 
 * Update chat parsing (@frej4189)

package/examples/cli/readline.js

@@ -0,0 +1,50 @@
+/*
+ * This example is an easy way to connect mineflayer to the node:readline module
+ * See: https://nodejs.org/api/readline.html
+ * Using this, we can make a simple terminal-to-ingame-chat interface
+ *
+ * Made by Jovan04 01/24/2023
+*/
+
+if (process.argv.length < 4 || process.argv.length > 6) {
+  console.log('Usage : node readline.js <host> <port> [<name>] [<auth>]')
+  process.exit(1)
+}
+
+const mineflayer = require('mineflayer') // load mineflayer library
+const readline = require('node:readline') // load the node.js readline module
+
+// bot options
+const options = {
+  host: process.argv[2],
+  port: parseInt(process.argv[3]),
+  username: process.argv[4] || 'readline',
+  auth: process.argv[5] || 'offline'
+}
+
+const bot = mineflayer.createBot(options) // join the minecraft server
+
+const rl = readline.createInterface({ // creates our readline interface with our console as input and output
+  input: process.stdin,
+  output: process.stdout
+})
+
+bot.once('spawn', () => {
+  console.log(`Bot joined the game with username ${bot.username}.`)
+  rl.setPrompt('> '); rl.prompt() // gives us a little arrow at the bottom for the input line
+})
+
+bot.on('message', (message) => {
+  readline.moveCursor(process.stdout, -2, 0) // we move the cursor to the left two places because our cursor is already two positions in (because of the input arrow)
+  console.log(message.toAnsi()) // convert our message to ansi to preserve chat formatting
+  rl.prompt() // regenerate our little arrow on the input line
+})
+
+rl.on('line', (line) => {
+  readline.moveCursor(process.stdout, 0, -1) // move cursor up one line
+  readline.clearScreenDown(process.stdout) // clear all the lines below the cursor (i.e. the last line we entered)
+  bot.chat(line.toString()) // sends the line we entered to ingame chat
+})
+
+bot.on('kicked', console.log)
+bot.on('error', console.log)

package/index.d.ts

@@ -122,7 +122,7 @@ interface BotEvents {
   ) => Promise<void> | void
   noteHeard: (block: Block, instrument: Instrument, pitch: number) => Promise<void> | void
   pistonMove: (block: Block, isPulling: number, direction: number) => Promise<void> | void
-  chestLidMove: (block: Block, isOpen: number) => Promise<void> | void
+  chestLidMove: (block: Block, isOpen: number, block2: Block | null) => Promise<void> | void
   blockBreakProgressObserved: (block: Block, destroyStage: number) => Promise<void> | void
   blockBreakProgressEnd: (block: Block) => Promise<void> | void
   diggingCompleted: (block: Block) => Promise<void> | void

package/lib/plugins/craft.js

@@ -6,6 +6,7 @@ module.exports = inject
 function inject (bot) {
   const Item = require('prismarine-item')(bot.registry)
   const Recipe = require('prismarine-recipe')(bot.registry).Recipe
+  let windowCraftingTable
 
   async function craft (recipe, count, craftingTable) {
     assert.ok(recipe)
@@ -13,19 +14,36 @@ function inject (bot) {
     if (recipe.requiresTable && !craftingTable) {
       throw new Error('recipe requires craftingTable')
     }
-    for (let i = 0; i < count; i++) {
-      await craftOnce(recipe, craftingTable)
+
+    try {
+      for (let i = 0; i < count; i++) {
+        await craftOnce(recipe, craftingTable)
+      }
+
+      if (windowCraftingTable) {
+        bot.closeWindow(windowCraftingTable)
+        windowCraftingTable = undefined
+      }
+    } catch (err) {
+      if (windowCraftingTable) {
+        bot.closeWindow(windowCraftingTable)
+        windowCraftingTable = undefined
+      }
+      throw new Error(err)
     }
   }
 
   async function craftOnce (recipe, craftingTable) {
     if (craftingTable) {
-      bot.activateBlock(craftingTable)
-      const [window] = await once(bot, 'windowOpen')
-      if (!window.type.startsWith('minecraft:crafting')) {
+      if (!windowCraftingTable) {
+        bot.activateBlock(craftingTable)
+        const [window] = await once(bot, 'windowOpen')
+        windowCraftingTable = window
+      }
+      if (!windowCraftingTable.type.startsWith('minecraft:crafting')) {
         throw new Error('crafting: non craftingTable used as craftingTable')
       }
-      await startClicking(window, 3, 3)
+      await startClicking(windowCraftingTable, 3, 3)
     } else {
       await startClicking(bot.inventory, 2, 2)
     }
@@ -73,7 +91,7 @@ function inject (bot) {
         if (ingredient.id === -1) return nextShapeClick()
         if (!window.selectedItem || window.selectedItem.type !== ingredient.id ||
           (ingredient.metadata != null &&
-          window.selectedItem.metadata !== ingredient.metadata)) {
+            window.selectedItem.metadata !== ingredient.metadata)) {
           // we are not holding the item we need. click it.
           const sourceItem = window.findInventoryItem(ingredient.id, ingredient.metadata)
           if (!sourceItem) throw new Error('missing ingredient')
@@ -89,7 +107,7 @@ function inject (bot) {
         const destSlot = extraSlots.pop()
         if (!window.selectedItem || window.selectedItem.type !== ingredient.id ||
           (ingredient.metadata != null &&
-          window.selectedItem.metadata !== ingredient.metadata)) {
+            window.selectedItem.metadata !== ingredient.metadata)) {
           // we are not holding the item we need. click it.
           const sourceItem = window.findInventoryItem(ingredient.id, ingredient.metadata)
           if (!sourceItem) throw new Error('missing ingredient')
@@ -126,7 +144,6 @@ function inject (bot) {
           for (let i = 1; i <= w * h; i++) {
             window.updateSlot(i, null)
           }
-          closeTheWindow()
           return
         }
         const slotsToClick = []
@@ -145,11 +162,6 @@ function inject (bot) {
         for (const _slot of slotsToClick) {
           await bot.putAway(_slot)
         }
-        closeTheWindow()
-      }
-
-      function closeTheWindow () {
-        bot.closeWindow(window)
       }
 
       function slot (x, y) {

package/lib/plugins/entities.js

@@ -484,7 +484,7 @@ function inject (bot) {
           Object.assign(player, obj)
         }
 
-        const playerEntity = Object.values(bot.entities).find(e => e.type === 'player' && e.username === obj.username)
+        const playerEntity = Object.values(bot.entities).find(e => e.type === 'player' && e.username === player.username)
         player.entity = playerEntity
 
         if (playerEntity === bot.entity) {
@@ -579,7 +579,7 @@ function inject (bot) {
     for (const uuid of packet.players) {
       const player = bot.uuidToUsername[uuid] ? bot.players[bot.uuidToUsername[uuid]] : null
 
-      if (player.entity === bot.entity) continue
+      if (!player || player.entity === bot.entity) continue
 
       player.entity = null
       delete bot.players[player.username]

package/lib/plugins/physics.js

@@ -235,6 +235,10 @@ function inject (bot, { physicsEnabled }) {
     const yawChange = Math.round((yaw - bot.entity.yaw) / sensitivity) * sensitivity
     const pitchChange = Math.round((pitch - bot.entity.pitch) / sensitivity) * sensitivity
 
+    if (yawChange === 0 && pitchChange === 0) {
+      return
+    }
+
     bot.entity.yaw += yawChange
     bot.entity.pitch += pitchChange
 

package/package.json

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