mineflayer 4.6.0 → 4.7.0

package/.github/workflows/ci.yml

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

package/README.md

@@ -189,8 +189,9 @@ The most updated and useful are :
  * [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
+ * [GUI](https://github.com/firejoust/mineflayer-GUI) - Interact with nested GUI windows using async/await
+ * [Projectile](https://github.com/firejoust/mineflayer-projectile) - Get the required launch angle for projectiles
+* [Movement](https://github.com/firejoust/mineflayer-movement) - Smooth and realistic player movement, best suited for PvP
 
 
  But also check out :

package/docs/README.md

@@ -189,8 +189,9 @@ The most updated and useful are :
  * [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
+ * [GUI](https://github.com/firejoust/mineflayer-GUI) - Interact with nested GUI windows using async/await
+ * [Projectile](https://github.com/firejoust/mineflayer-projectile) - Get the required launch angle for projectiles
+* [Movement](https://github.com/firejoust/mineflayer-movement) - Smooth and realistic player movement, best suited for PvP
 
 
  But also check out :

package/docs/api.md

@@ -1156,7 +1156,8 @@ Emitted for every server message which appears on the Action Bar.
 
 Emitted for every server message, including chats.
 
- * `jsonMsg` - unmodified JSON message from the server
+ * `jsonMsg` - [ChatMessage](https://github.com/PrismarineJS/prismarine-chat) object containing the formatted chat message. Might additionally have the following properties:
+   * unsigned - Unsigned ChatMessage object. Only present in 1.19.2+, and only when the server allows insecure chat and the server modified the chat message without the user's signature
 
  * `position` - (>= 1.8.1): position of Chat message can be
    * chat
@@ -1169,7 +1170,7 @@ Emitted for every server message, including chats.
 
 #### "messagestr" (message, messagePosition, jsonMsg, sender, verified)
 
-Alias for the "message" event but it calls .toString() on the message object to get a string for the message before emitting.
+Alias for the "message" event but it calls .toString() on the prismarine-message object to get a string for the message before emitting.
 
  * `sender` - UUID of sender if known (1.16+), else null
 

package/docs/history.md

@@ -1,4 +1,8 @@
-4.6.0
+## 4.7.0
+
+* 1.19.2 support (@frej4189)
+
+## 4.6.0
 
 * Fix unhandled promise rejection in onceWithCleanup (@IceTank) [#2833](https://github.com/PrismarineJS/mineflayer/pull/2833)
 * Extend every window that is opened with mineflayer specific window functions (@IceTank) [#2768][https://github.com/PrismarineJS/mineflayer/pull/2768]

package/examples/discord.js

@@ -1,57 +1,64 @@
 /*
  * This example is a very simple way how to connect a discord bot with a mineflayer bot.
  * For this example you will need discord.js installed. You can install with: npm install discord.js
- * This example uses discord.js v13
+ * This example uses discord.js v14
  * You need to do this before running this example:
- * - You need to get a discord token
+ * - You need to get a discord bot token
  * - You need to get the id of the channel you want to use
- */
+ *
+ * Original credit to U9G, updated by Jovan04 12/19/2022
+*/
 
 if (process.argv.length < 6 || process.argv.length > 8) {
-  console.log('Usage : node discord.js <discord bot token> <channel id> <host> <port> [<name>] [<password>]')
+  console.log('Usage : node discord.js <discord bot token> <channel id> <host> <port> [<name>] [<auth>]')
   process.exit(1)
 }
 
-// Load discord.js
-const {
-  Client,
-  Intents
-} = require('discord.js')
-// Create Discord intentions, required in v13
-const intents = new Intents(['GUILDS', 'GUILD_MESSAGES'])
-// Create Discord client
-const client = new Client({
-  intents
-})
+// load discord.js
+const { Client, GatewayIntentBits } = require('discord.js')
+const { MessageContent, GuildMessages, Guilds } = GatewayIntentBits
 
 let channel = process.argv[3]
+const token = process.argv[2]
+
+// create new discord client that can see what servers the bot is in, as well as the messages in those servers
+const client = new Client({ intents: [Guilds, GuildMessages, MessageContent] })
+client.login(token)
 
-// Load mineflayer
+// load mineflayer
 const mineflayer = require('mineflayer')
-const bot = mineflayer.createBot({
+
+// bot options
+const options = {
   host: process.argv[4],
   port: parseInt(process.argv[5]),
   username: process.argv[6] || 'discord',
-  password: process.argv[7]
+  auth: process.argv[7] || 'offline'
+}
+
+// join server
+const bot = mineflayer.createBot(options)
+bot.on('spawn', () => {
+  console.log(`Mineflayer bot logged in as ${bot.username}`)
 })
 
-client.on('ready', () => {
-  console.log(`The discord bot logged in! Username: ${client.user.username}!`)
-  // Find the Discord channel messages will be sent to
+// when discord client is ready, send login message
+client.once('ready', (c) => {
+  console.log(`Discord bot logged in as ${c.user.tag}`)
   channel = client.channels.cache.get(channel)
   if (!channel) {
-    console.log(`I could not find the channel (${process.argv[3]})!\nUsage : node discord.js <discord bot token> <channel id> <host> <port> [<name>] [<password>]`)
+    console.log(`I could not find the channel (${process.argv[3]})!`)
+    console.log('Usage : node discord.js <discord bot token> <channel id> <host> <port> [<name>] [<auth>]')
     process.exit(1)
   }
 })
 
-// Redirect Discord messages to in-game chat
-client.on('messageCreate', message => {
+client.on('messageCreate', (message) => {
   // Only handle messages in specified channel
   if (message.channel.id !== channel.id) return
   // Ignore messages from the bot itself
   if (message.author.id === client.user.id) return
-
+  // console.log(message)
   bot.chat(`${message.author.username}: ${message.content}`)
 })
 
@@ -62,6 +69,3 @@ bot.on('chat', (username, message) => {
 
   channel.send(`${username}: ${message}`)
 })
-
-// Login Discord bot
-client.login(process.argv[2])

package/examples/telegram.js

@@ -0,0 +1,43 @@
+/*
+* This example is a very simple way of connecting to a telegram group
+* For this example you'll need Telegraf installed. This can be done with `npm install telegraf`
+* You need to do this before running this example:
+* - You need to get a telegram bot token from @botfather
+* - You need to get the id of the group you want to use
+*/
+
+if (process.argv.length < 6 || process.argv.length > 8) {
+  console.log('Usage : node telegram.js <telegram bot token> <group id> <host> <port> [<name>] [<password>]')
+  process.exit(1)
+}
+
+// Load Telegraf
+const { Telegraf } = require('telegraf')
+const telegram = new Telegraf(process.argv[2])
+
+// Load mineflayer
+const mineflayer = require('mineflayer')
+const bot = mineflayer.createBot({
+  host: process.argv[4],
+  port: parseInt(process.argv[5]),
+  username: process.argv[6] || 'telegram',
+  password: process.argv[7]
+})
+
+telegram.on('text', async (ctx) => {
+  // check if message was reveived from chosen group
+  if (ctx.update.message.chat.id.toString() === process.argv[3]) {
+    // send message to mc server
+    bot.chat(`${ctx.update.message.from.first_name} ${ctx.update.message.from.last_name}: ${ctx.update.message.text}`)
+  }
+})
+
+// Redirect in-game messages to telegram group
+bot.on('chat', (username, message) => {
+  // Ignore messages from the bot itself
+  if (username === bot.username) return
+  telegram.telegram.sendMessage(process.argv[3], username + ': ' + message)
+})
+
+// Login telegram bot
+telegram.launch()

package/index.d.ts

@@ -8,6 +8,7 @@ import { Recipe } from 'prismarine-recipe'
 import { Block } from 'prismarine-block'
 import { Entity } from 'prismarine-entity'
 import { ChatMessage } from 'prismarine-chat'
+import { Registry } from 'prismarine-registry'
 
 export function createBot (options: { client: Client } & Partial<BotOptions>): Bot
 export function createBot (options: BotOptions): Bot
@@ -192,6 +193,7 @@ export interface Bot extends TypedEmitter<BotEvents> {
   currentWindow: Window | null
   simpleClick: simpleClick
   tablist: Tablist
+  registry: Registry
 
   connect: (options: BotOptions) => void
 

package/lib/plugins/blocks.js

@@ -20,7 +20,7 @@ const dimensionNames = {
   1: 'minecraft:end'
 }
 
-function inject (bot, { version, storageBuilder }) {
+function inject (bot, { version, storageBuilder, hideErrors }) {
   const Block = require('prismarine-block')(bot.registry)
   const Chunk = require('prismarine-chunk')(bot.registry)
   const World = require('prismarine-world')(bot.registry)
@@ -289,6 +289,10 @@ function inject (bot, { version, storageBuilder }) {
 
     if (typeof packet.blockEntities !== 'undefined') {
       const column = bot.world.getColumn(packet.x, packet.z)
+      if (!column) {
+        if (!hideErrors) console.warn('Ignoring block entities as chunk failed to load at', packet.x, packet.z)
+        return
+      }
       for (const blockEntity of packet.blockEntities) {
         if (blockEntity.x !== undefined) { // 1.17+
           column.setBlockEntity(blockEntity, blockEntity.nbtData)

package/lib/plugins/chat.js

@@ -108,43 +108,49 @@ function inject (bot, options) {
 
   addDefaultPatterns()
 
-  // Pre 1.19
-  bot._client.on('chat', (packet) => {
-    const msg = ChatMessage.fromNotch(packet.message)
-    const chatPositions = {
-      0: 'chat',
-      1: 'system',
-      2: 'game_info'
-    }
-    bot.emit('message', msg, chatPositions[packet.position], packet.sender, /* verified */ null)
-    bot.emit('messagestr', msg.toString(), chatPositions[packet.position], msg, packet.sender, /* verified */ null)
-    // Position 2 is the action bar
-    if (packet.position === 2) bot.emit('actionBar', msg, null)
-  })
+  bot._client.on('playerChat', (data) => {
+    const message = data.formattedMessage
+    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
+        }
+      }
 
-  // 1.19+
-  bot._client.on('player_chat', (packet) => {
-    const message = packet.unsignedChatContent || packet.signedChatContent
-    let verified = false
-    const sender = bot.uuidToUsername[packet.senderUuid]
-    if (sender) {
-      const { profileKeys } = bot.players[sender]
-      if (profileKeys) verified = bot._client.verifyMessage(profileKeys.publicKey, packet)
-    }
-    const parameters = {
-      sender: JSON.parse(packet.senderName),
-      content: JSON.parse(message)
+      const parameters = {
+        sender,
+        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) })
+      }
+    } else {
+      msg = ChatMessage.fromNotch(data.formattedMessage)
     }
-    const msg = ChatMessage.fromNetwork(packet.type, parameters)
-    Object.assign(msg, parameters)
-    bot.emit('message', msg, 'chat', packet.senderUuid, verified)
-    bot.emit('messagestr', msg.toString(), 'chat', msg, packet.senderUuid, verified)
+    bot.emit('message', msg, 'chat', data.sender, verified)
+    bot.emit('messagestr', msg.toString(), 'chat', msg, data.sender, verified)
   })
 
-  bot._client.on('system_chat', (packet) => {
-    const msg = ChatMessage.fromNotch(packet.content)
-    bot.emit('message', msg, 'system', null)
-    bot.emit('messagestr', msg.toString(), 'system', msg, null)
+  bot._client.on('systemChat', (data) => {
+    const msg = ChatMessage.fromNotch(data.formattedMessage)
+    const chatPositions = {
+      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)
   })
 
   function chatWithHeader (header, message) {
@@ -163,7 +169,9 @@ function inject (bot, options) {
           timestamp,
           salt: 0n,
           argumentSignatures: [],
-          signedPreview: false
+          signedPreview: false,
+          // 1.19.2 Chat Command packet also includes an array of last seen messages
+          previousMessages: []
         })
         return
       }
@@ -176,17 +184,7 @@ function inject (bot, options) {
       let smallMsg
       for (i = 0; i < subMessage.length; i += lengthLimit) {
         smallMsg = header + subMessage.substring(i, i + lengthLimit)
-        if (bot.supportFeature('signedChat')) {
-          const timestamp = BigInt(Date.now())
-          bot._client.write('chat_message', {
-            message: smallMsg,
-            timestamp,
-            salt: 0,
-            signature: bot._client.profileKeys ? bot._client.signMessage(smallMsg, timestamp) : Buffer.alloc(0)
-          })
-        } else {
-          bot._client.write('chat', { message: smallMsg })
-        }
+        bot._client.chat(smallMsg)
       }
     })
   }

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']
+  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']
 } // when updating testedVersions, make sure to update CI.yml

package/package.json

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