mineflayer 4.7.0 → 4.8.1

package/.github/workflows/ci.yml

@@ -33,6 +33,8 @@ jobs:
            mcVersion: '1.19'
          - javaVersion: 17
            mcVersion: '1.19.2'
+         - javaVersion: 17
+           mcVersion: '1.19.3'
       fail-fast: false
 
     steps:

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,18 @@
+## 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)
+* Fix message event not including chat position (@frej4189)
+* 1.19.3  (@frej4189)
+
 ## 4.7.0
 
 * 1.19.2 support (@frej4189)

package/docs/ru/README_RU.md

@@ -12,9 +12,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) |
 |-------------------------|----------------------------|----------------------------|----------------------------|----------------------------|----------------------------|
 
-Создавайте ботов Minecraft с помощью мощного, стабильного и высокоуровневого JavaScript [API](api.md).
+Создавайте ботов Minecraft с помощью мощного, стабильного и высокоуровневого JavaScript [API](api.md), также можете использовать Python
 
-Первый раз используете Node.js? Начните с [этого](tutorial.md).
+Первый раз используете Node.js? Начните с [этого](tutorial.md). Любите гонять змею? Зацените [Python примеры](https://github.com/PrismarineJS/mineflayer/tree/master/examples/python) и попробуйте колабнуться в [Mineflayer Google коллабе](https://colab.research.google.com/github/PrismarineJS/mineflayer/blob/master/docs/mineflayer.ipynb).
 
 ## Возможности
 

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
@@ -567,6 +567,7 @@ export interface TransferOptions {
   window: Window
   itemType: number
   metadata: number | null
+  count?: number,
   sourceStart: number
   sourceEnd: number
   destStart: number

package/lib/plugins/chat.js

@@ -113,30 +113,18 @@ function inject (bot, options) {
     const verified = data.verified
     let msg
     if (bot.supportFeature('clientsideChatFormatting')) {
-      let sender
-
-      try {
-        sender = JSON.parse(data.senderName)
-      } catch {
-        sender = {
-          insertion: data.senderName,
-          clickEvent: { action: 'suggest_command', value: `/tell ${data.senderName} ` },
-          hoverEvent: { action: 'show_entity', contents: { id: bot.findPlayer(data.senderName).id, name: data.senderName } },
-          text: data.senderName
-        }
-      }
-
       const parameters = {
-        sender,
+        sender: data.senderName ? JSON.parse(data.senderName) : undefined,
+        target: data.targetName ? JSON.parse(data.targetName) : undefined,
         content: message ? JSON.parse(message) : { text: data.plainMessage }
       }
       msg = ChatMessage.fromNetwork(data.type, parameters)
 
       if (data.unsignedContent) {
-        msg.unsigned = ChatMessage.fromNetwork(data.type, { sender, content: JSON.parse(data.unsignedContent) })
+        msg.unsigned = ChatMessage.fromNetwork(data.type, { sender: parameters.sender, target: parameters.target, content: JSON.parse(data.unsignedContent) })
       }
     } else {
-      msg = ChatMessage.fromNotch(data.formattedMessage)
+      msg = ChatMessage.fromNotch(message)
     }
     bot.emit('message', msg, 'chat', data.sender, verified)
     bot.emit('messagestr', msg.toString(), 'chat', msg, data.sender, verified)
@@ -148,9 +136,9 @@ function inject (bot, options) {
       1: 'system',
       2: 'game_info'
     }
-    bot.emit('message', msg, chatPositions[data.positionid], null)
-    bot.emit('messagestr', msg.toString(), chatPositions[data.positionid], msg, null)
-    if (data.positionid === 2) bot.emit('actionBar', msg, null)
+    bot.emit('message', msg, chatPositions[data.positionId], null)
+    bot.emit('messagestr', msg.toString(), chatPositions[data.positionId], msg, null)
+    if (data.positionId === 2) bot.emit('actionBar', msg, null)
   })
 
   function chatWithHeader (header, message) {
@@ -170,6 +158,8 @@ function inject (bot, options) {
           salt: 0n,
           argumentSignatures: [],
           signedPreview: false,
+          messageCount: 0,
+          acknowledged: Buffer.alloc(3),
           // 1.19.2 Chat Command packet also includes an array of last seen messages
           previousMessages: []
         })

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

@@ -361,13 +361,14 @@ function inject (bot) {
     entity.metadata = metadata
     bot.emit('entityUpdate', entity)
 
-    const typeSlot = bot.supportFeature('itemsAreAlsoBlocks') ? 5 : 6
+    const typeSlot = (bot.supportFeature('itemsAreAlsoBlocks') ? 5 : 6) + (bot.supportFeature('entityMetadataHasLong') ? 1 : 0)
     const slot = packet.metadata.find(e => e.type === typeSlot)
     if (entity.name && (entity.name.toLowerCase() === 'item' || entity.name === 'item_stack') && slot) {
       bot.emit('itemDrop', entity)
     }
 
-    const pose = packet.metadata.find(e => e.type === 18)
+    const typePose = bot.supportFeature('entityMetadataHasLong') ? 19 : 18
+    const pose = packet.metadata.find(e => e.type === typePose)
     if (pose && pose.value === 2) {
       bot.emit('entitySleep', entity)
     }
@@ -444,81 +445,149 @@ function inject (bot) {
 
   bot._client.on('player_info', (packet) => {
     // player list item(s)
-    for (const item of packet.data) {
-      let player = bot.uuidToUsername[item.UUID] ? bot.players[bot.uuidToUsername[item.UUID]] : null
-      if (packet.action === 0) {
+
+    if (bot.supportFeature('playerInfoActionIsBitfield')) {
+      for (const item of packet.data) {
+        let player = bot.uuidToUsername[item.uuid] ? bot.players[bot.uuidToUsername[item.uuid]] : null
         let newPlayer = false
 
-        // New Player
-        if (!player) {
-          player = bot.players[item.name] = {
-            username: item.name,
-            ping: item.ping,
-            uuid: item.UUID,
-            displayName: new ChatMessage({ text: '', extra: [{ text: item.name }] }),
-            profileKeys: item.crypto
-              ? {
-                  publicKey: item.crypto.publicKey, // DER-encoded public key
-                  signature: item.crypto.signature // Signature
-                }
-              : null
-          }
+        const obj = {
+          uuid: item.uuid
+        }
 
-          bot.uuidToUsername[item.UUID] = item.name
-          bot.emit('playerJoined', player)
-          newPlayer = true
-        } else {
-          // Just an Update
-          player.gamemode = item.gamemode
-          player.ping = item.ping
-          if (item.crypto) {
-            player.profileKeys = {
-              publicKey: item.crypto.publicKey,
-              signature: item.crypto.signature
-            }
-          }
+        if (!player) newPlayer = true
+
+        player = player || obj
+
+        if (packet.action & 1) {
+          obj.username = item.player.name
+          obj.displayName = player.displayName || new ChatMessage({ text: '', extra: [{ text: item.player.name }] })
+        }
+
+        if (packet.action & 4) {
+          obj.gamemode = item.gamemode
+        }
+
+        if (packet.action & 16) {
+          obj.ping = item.latency
         }
 
         if (item.displayName) {
-          player.displayName = new ChatMessage(JSON.parse(item.displayName))
+          obj.displayName = new ChatMessage(JSON.parse(item.displayName))
+        } else if (packet.action & 32) obj.displayName = new ChatMessage({ text: '', extra: [{ text: player.username || obj.username }] })
+
+        if (newPlayer) {
+          if (!obj.username) continue // Should be unreachable
+          player = bot.players[obj.username] = obj
+          bot.uuidToUsername[obj.uuid] = obj.username
+        } else {
+          Object.assign(player, obj)
         }
 
-        const playerEntity = Object.values(bot.entities).find(e => e.type === 'player' && e.username === item.name)
+        const playerEntity = Object.values(bot.entities).find(e => e.type === 'player' && e.username === player.username)
         player.entity = playerEntity
 
         if (playerEntity === bot.entity) {
           bot.player = player
         }
 
-        if (!newPlayer) {
-          bot.emit('playerUpdated', player)
-        }
-      } else if (player) {
-        if (packet.action === 1) {
-          player.gamemode = item.gamemode
-        } else if (packet.action === 2) {
-          player.ping = item.ping
-        } else if (packet.action === 3 && !item.displayName) {
-          player.displayName = new ChatMessage({ text: '', extra: [{ text: player.username }] })
-        } else if (packet.action === 3 && item.displayName) {
-          player.displayName = new ChatMessage(JSON.parse(item.displayName))
-        } else if (packet.action === 4) {
-          if (player.entity === bot.entity) continue
-
-          player.entity = null
-          delete bot.players[player.username]
-          delete bot.uuidToUsername[item.UUID]
-          bot.emit('playerLeft', player)
-          continue
+        if (newPlayer) {
+          bot.emit('playerJoined', player)
         } else {
-          continue
+          bot.emit('playerUpdated', player)
         }
+      }
+    } else {
+      for (const item of packet.data) {
+        let player = bot.uuidToUsername[item.UUID] ? bot.players[bot.uuidToUsername[item.UUID]] : null
+        if (packet.action === 0) {
+          let newPlayer = false
+
+          // New Player
+          if (!player) {
+            player = bot.players[item.name] = {
+              username: item.name,
+              ping: item.ping,
+              uuid: item.UUID,
+              displayName: new ChatMessage({ text: '', extra: [{ text: item.name }] }),
+              profileKeys: item.crypto
+                ? {
+                    publicKey: item.crypto.publicKey, // DER-encoded public key
+                    signature: item.crypto.signature // Signature
+                  }
+                : null
+            }
+
+            bot.uuidToUsername[item.UUID] = item.name
+            bot.emit('playerJoined', player)
+            newPlayer = true
+          } else {
+            // Just an Update
+            player.gamemode = item.gamemode
+            player.ping = item.ping
+            if (item.crypto) {
+              player.profileKeys = {
+                publicKey: item.crypto.publicKey,
+                signature: item.crypto.signature
+              }
+            }
+          }
+
+          if (item.displayName) {
+            player.displayName = new ChatMessage(JSON.parse(item.displayName))
+          }
+
+          const playerEntity = Object.values(bot.entities).find(e => e.type === 'player' && e.username === item.name)
+          player.entity = playerEntity
+
+          if (playerEntity === bot.entity) {
+            bot.player = player
+          }
 
-        bot.emit('playerUpdated', player)
+          if (!newPlayer) {
+            bot.emit('playerUpdated', player)
+          }
+        } else if (player) {
+          if (packet.action === 1) {
+            player.gamemode = item.gamemode
+          } else if (packet.action === 2) {
+            player.ping = item.ping
+          } else if (packet.action === 3 && !item.displayName) {
+            player.displayName = new ChatMessage({ text: '', extra: [{ text: player.username }] })
+          } else if (packet.action === 3 && item.displayName) {
+            player.displayName = new ChatMessage(JSON.parse(item.displayName))
+          } else if (packet.action === 4) {
+            if (player.entity === bot.entity) continue
+
+            player.entity = null
+            delete bot.players[player.username]
+            delete bot.uuidToUsername[item.UUID]
+            bot.emit('playerLeft', player)
+            continue
+          } else {
+            continue
+          }
+
+          bot.emit('playerUpdated', player)
+        }
       }
     }
   })
 
+  // (1.19.3) player(s) leave the game
+  bot._client.on('player_remove', (packet) => {
+    for (const uuid of packet.players) {
+      const player = bot.uuidToUsername[uuid] ? bot.players[bot.uuidToUsername[uuid]] : null
+
+      if (!player || player.entity === bot.entity) continue
+
+      player.entity = null
+      delete bot.players[player.username]
+      delete bot.uuidToUsername[uuid]
+      bot.emit('playerLeft', player)
+    }
+  })
+
   // attaching to a vehicle
   bot._client.on('attach_entity', (packet) => {
     if (packet.entityId !== bot.entity.id) return

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/lib/version.js

@@ -1,4 +1,4 @@
 module.exports = {
   supportedVersions: ['1.8', '1.9', '1.10', '1.11', '1.12', '1.13', '1.14', '1.15', '1.16', '1.17', '1.18', '1.19'],
-  testedVersions: ['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', '1.17.1', '1.18.2', '1.19', '1.19.2']
+  testedVersions: ['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', '1.17.1', '1.18.2', '1.19', '1.19.2', '1.19.3']
 } // when updating testedVersions, make sure to update CI.yml

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mineflayer",
-  "version": "4.7.0",
+  "version": "4.8.1",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",
@@ -21,8 +21,8 @@
   },
   "license": "MIT",
   "dependencies": {
-    "minecraft-data": "^3.15.2",
-    "minecraft-protocol": "^1.38.1",
+    "minecraft-data": "^3.26.0",
+    "minecraft-protocol": "^1.40.3",
     "prismarine-biome": "^1.1.1",
     "prismarine-block": "^1.13.1",
     "prismarine-chat": "^1.7.1",