mineflayer 3.11.2 → 3.12.0

package/.github/FUNDING.yml

@@ -1,3 +1 @@
 # These are supported funding model platforms
-
-issuehunt: PrismarineJS/mineflayer

package/README.md

@@ -188,6 +188,8 @@ 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
 
 
  But also check out :
@@ -202,6 +204,7 @@ The most updated and useful are :
  * [Bloodhound](https://github.com/Nixes/mineflayer-bloodhound) - determine who and what is responsible for damage to another entity
  * [tps](https://github.com/SiebeDW/mineflayer-tps) - get the current tps (processed tps)
  * [panorama](https://github.com/IceTank/mineflayer-panorama) - take Panorama Images of your world
+ * [player-death-event](https://github.com/tuanzisama/mineflayer-death-event) - emit player death event in Mineflayer.
 
 ## Projects Using Mineflayer
 

package/docs/README.md

@@ -188,6 +188,8 @@ 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
 
 
  But also check out :
@@ -202,6 +204,7 @@ The most updated and useful are :
  * [Bloodhound](https://github.com/Nixes/mineflayer-bloodhound) - determine who and what is responsible for damage to another entity
  * [tps](https://github.com/SiebeDW/mineflayer-tps) - get the current tps (processed tps)
  * [panorama](https://github.com/IceTank/mineflayer-panorama) - take Panorama Images of your world
+ * [player-death-event](https://github.com/tuanzisama/mineflayer-death-event) - emit player death event in Mineflayer.
 
 ## Projects Using Mineflayer
 

package/docs/api.md

@@ -158,7 +158,7 @@
       - ["weatherUpdate"](#weatherupdate)
       - ["time"](#time)
       - ["kicked" (reason, loggedIn)](#kicked-reason-loggedin)
-      - ["end"](#end)
+      - ["end" (reason)](#end-reason)
       - ["error" (err)](#error-err)
       - ["spawnReset"](#spawnreset)
       - ["death"](#death)
@@ -238,6 +238,7 @@
       - [bot.waitForChunksToLoad(cb)](#botwaitforchunkstoloadcb)
       - [bot.blockInSight(maxSteps, vectorLength)](#botblockinsightmaxsteps-vectorlength)
       - [bot.blockAtCursor(maxDistance=256)](#botblockatcursormaxdistance256)
+      - [bot.blockAtEntityCursor(entity=bot.entity, maxDistance=256)](#botblockatentitycursorentitybotentity-maxdistance256)
       - [bot.canSeeBlock(block)](#botcanseeblockblock)
       - [bot.findBlocks(options)](#botfindblocksoptions)
       - [bot.findBlock(options)](#botfindblockoptions)
@@ -246,7 +247,7 @@
       - [bot.recipesAll(itemType, metadata, craftingTable)](#botrecipesallitemtype-metadata-craftingtable)
       - [bot.nearestEntity(match = (entity) => { return true })](#botnearestentitymatch--entity---return-true-)
     - [Methods](#methods)
-      - [bot.end()](#botend)
+      - [bot.end(reason)](#botendreason)
       - [bot.quit(reason)](#botquitreason)
       - [bot.tabComplete(str, cb, [assumeCommand], [sendBlockInSight])](#bottabcompletestr-cb-assumecommand-sendblockinsight)
       - [bot.chat(message)](#botchatmessage)
@@ -289,7 +290,7 @@
       - [bot.activateItem(offHand=false)](#botactivateitemoffhandfalse)
       - [bot.deactivateItem()](#botdeactivateitem)
       - [bot.useOn(targetEntity)](#botuseontargetentity)
-      - [bot.attack(entity)](#botattackentity)
+      - [bot.attack(entity, swing = true)](#botattackentity-swing--true)
       - [bot.swingArm([hand], showHand)](#botswingarmhand-showhand)
       - [bot.mount(entity)](#botmountentity)
       - [bot.dismount()](#botdismount)
@@ -756,6 +757,7 @@ Create and return an instance of the class bot.
  * [difficulty](#bot.settings.difficulty)
  * [skinParts](#bot.settings.skinParts)
  * chatLengthLimit : the maximum amount of characters that can be sent in a single message. If this is not set, it will be 100 in < 1.11 and 256 in >= 1.11.
+ * defaultChatPatterns: defaults to true, set to false to not add the patterns such as chat and whisper
 
 ### Properties
 
@@ -1154,9 +1156,10 @@ is a chat message explaining why you were kicked. `loggedIn`
 is `true` if the client was kicked after successfully logging in,
 or `false` if the kick occurred in the login phase.
 
-#### "end"
+#### "end" (reason)
 
 Emitted when you are no longer connected to the server.
+`reason` is a string explaining why the client was disconnected. (defaults to 'socketClosed')
 
 #### "error" (err)
 
@@ -1448,6 +1451,12 @@ Returns the block at which bot is looking at or `null`
 Returns the block at which bot is looking at or `null`
  * `maxDistance` - The maximum distance the block can be from the eye, defaults to 256.
 
+#### bot.blockAtEntityCursor(entity=bot.entity, maxDistance=256)
+
+Returns the block at which specific entity is looking at or `null`
+ * `entity` - Entity data as `Object`
+ * `maxDistance` - The maximum distance the block can be from the eye, defaults to 256.
+
 #### bot.canSeeBlock(block)
 
 Returns true or false depending on whether the bot can see the specified `block`.
@@ -1503,9 +1512,10 @@ const cow = bot.nearestEntity(entity => entity.name.toLowerCase() === 'cow') //
 
 ### Methods
 
-#### bot.end()
+#### bot.end(reason)
 
 End the connection with the server.
+* `reason` - Optional string that states the reason of the end.
 
 #### bot.quit(reason)
 
@@ -1853,10 +1863,13 @@ Deactivates the currently held item. This is how you release an arrow, stop eati
 Use the currently held item on an `Entity` instance. This is how you apply a saddle and
 use shears.
 
-#### bot.attack(entity)
+#### bot.attack(entity, swing = true)
 
 Attack a player or a mob.
 
+ * `entity` is a type of entity. To get a specific entity use [bot.nearestEntity()](#botnearestentitymatch--entity---return-true-) or [bot.entities](#botentities).
+ * `swing` Default `true`. If false the bot does not swing is arm when attacking.
+
 #### bot.swingArm([hand], showHand)
 
 Play an arm swing animation.

package/docs/history.md

@@ -1,3 +1,17 @@
+## 3.12.0
+
+* Bypass anticheats that detect sensitivity (@mat-1)
+* Fix removing many players at once from tab list (@mat-1)
+* Added blockAtEntityCursor function (@DatArnoGuy)
+* add option to disable default chat patterns (@U5B)
+* Fixed wrong arm swinging (@IceTank)
+* Add pitch speed to look (@IceTank)
+* Console spam fix (@IceTank)
+* Update openVillager function to return a promise (@amoraschi)
+* Send arm_animation before use_entity (@aesthetic0001)
+* Add reason for the end of a mineflayer bot (@U5B)
+* added rejection of invalid transaction packets (anticheat fix) (@U5B)
+
 ## 3.11.2
 * Remove unnecessary and buggy inventory check in place block (@Karang)
 * Make all events allow async cb typings (@u9g)

package/examples/discord.js

@@ -1,7 +1,7 @@
 /*
  * 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
- * Note that discord.js v12 or newer is required.
+ * This example uses discord.js v13
  * You need to do this before running this example:
  * - You need to get a discord token
  * - You need to get the id of the channel you want to use
@@ -12,9 +12,18 @@ if (process.argv.length < 6 || process.argv.length > 8) {
   process.exit(1)
 }
 
-// Load discord
-const Discord = require('discord.js')
-const client = new Discord.Client()
+// 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: intents
+})
+
 let channel = process.argv[3]
 
 // Load mineflayer
@@ -28,6 +37,7 @@ const bot = mineflayer.createBot({
 
 client.on('ready', () => {
   console.log(`The discord bot logged in! Username: ${client.user.username}!`)
+  // Find the Discord channel messages will be sent to
   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>]`)
@@ -36,7 +46,7 @@ client.on('ready', () => {
 })
 
 // Redirect Discord messages to in-game chat
-client.on('message', message => {
+client.on('messageCreate', message => {
   // Only handle messages in specified channel
   if (message.channel.id !== channel.id) return
   // Ignore messages from the bot itself

package/examples/python/basic.py

@@ -21,7 +21,7 @@ def handle(*args):
   movements = pathfinder.Movements(bot, mcData)
 
   @On(bot, 'chat')
-  def handleMsg(sender, message, *args):
+  def handleMsg(this, sender, message, *args):
     print("Got message", sender, message)
     if sender and (sender != BOT_USERNAME):
       bot.chat('Hi, you said ' + message)
@@ -39,4 +39,4 @@ def handle(*args):
 
 @On(bot, "end")
 def handle(*args):
-  print("Bot ended!", args)
+  print("Bot ended!", args)

package/examples/python/chatterbox.py

@@ -13,7 +13,7 @@
 # a few informations while you are in game.
 # ===========================================================================
 import sys, re
-from javascript import require, On, Once
+from javascript import require, On, Once, console
 
 mineflayer = require("mineflayer", "latest")
 Vec3 = require("vec3").Vec3

package/index.d.ts

@@ -26,6 +26,7 @@ export interface BotOptions extends ClientOptions {
   physicsEnabled?: boolean
   client?: Client
   brand?: string
+  defaultChatPatterns?: boolean
 }
 
 export type ChatLevel = 'enabled' | 'commandsOnly' | 'disabled'
@@ -67,7 +68,7 @@ interface BotEvents {
   rain: () => Promise<void> | void
   time: () => Promise<void> | void
   kicked: (reason: string, loggedIn: boolean) => Promise<void> | void
-  end: () => Promise<void> | void
+  end: (reason: string) => Promise<void> | void
   spawnReset: () => Promise<void> | void
   death: () => Promise<void> | void
   health: () => Promise<void> | void
@@ -129,8 +130,8 @@ interface BotEvents {
   forcedMove: () => Promise<void> | void
   mount: () => Promise<void> | void
   dismount: (vehicle: Entity) => Promise<void> | void
-  windowOpen: (vehicle: Window) => Promise<void> | void
-  windowClose: (vehicle: Window) => Promise<void> | void
+  windowOpen: (window: Window) => Promise<void> | void
+  windowClose: (window: Window) => Promise<void> | void
   sleep: () => Promise<void> | void
   wake: () => Promise<void> | void
   experience: () => Promise<void> | void
@@ -193,13 +194,14 @@ export interface Bot extends TypedEmitter<BotEvents> {
 
   supportFeature: (feature: string) => boolean
 
-  end: () => void
+  end: (reason?: string) => void
 
   blockAt: (point: Vec3) => Block | null
 
   blockInSight: (maxSteps: number, vectorLength: number) => Block | null
 
   blockAtCursor: (maxDistance?: number, matcher?: Function) => Block | null
+  blockAtEntityCursor: (entity?: entity, maxDistance?: number, matcher?: Function) => Block | null
 
   canSeeBlock: (block: Block) => boolean
 
@@ -353,7 +355,7 @@ export interface Bot extends TypedEmitter<BotEvents> {
 
   openVillager: (
     villager: Entity
-  ) => Villager
+  ) => Promise<Villager>
 
   trade: (
     villagerInstance: Villager,
@@ -831,7 +833,7 @@ export class BossBar {
   );
 }
 
-export var supportedVersions: string[]
-export var testedVersions: string[]
+export let supportedVersions: string[]
+export let testedVersions: string[]
 
 export function supportFeature (feature: string, version: string): boolean

package/lib/loader.js

@@ -70,7 +70,7 @@ function createBot (options = {}) {
   options.brand = options.brand ?? 'vanilla'
   const bot = new EventEmitter()
   bot._client = options.client
-  bot.end = () => bot._client.end()
+  bot.end = (reason) => bot._client.end(reason)
   if (options.logErrors) {
     bot.on('error', err => {
       if (!options.hideErrors) {
@@ -99,8 +99,8 @@ function createBot (options = {}) {
   bot._client.on('error', (err) => {
     bot.emit('error', err)
   })
-  bot._client.on('end', () => {
-    bot.emit('end')
+  bot._client.on('end', (reason) => {
+    bot.emit('end', reason)
   })
   if (!bot._client.wait_connect) next()
   else bot._client.once('connect_allowed', next)

package/lib/plugins/chat.js

@@ -4,6 +4,7 @@ module.exports = inject
 
 function inject (bot, options) {
   const CHAT_LENGTH_LIMIT = options.chatLengthLimit ?? (bot.supportFeature('lessCharsInChat') ? 100 : 256)
+  const defaultChatPatterns = options.defaultChatPatterns ?? true
 
   const ChatMessage = require('prismarine-chat')(bot.version)
   // chat.pattern.type will emit an event for bot.on() of the same type, eg chatType = whisper will trigger bot.on('whisper')
@@ -171,6 +172,7 @@ function inject (bot, options) {
   bot.tabComplete = callbackify(tabComplete)
 
   function addDefaultPatterns () {
+    if (!defaultChatPatterns) return
     const USERNAME_REGEX = '(?:\\(.+\\)|\\[.+\\]|.)*?(\\w+)'
     bot.addChatPattern('whisper', new RegExp(`^${USERNAME_REGEX} whispers(?: to you)?:? (.*)$`), { deprecated: true })
     bot.addChatPattern('whisper', new RegExp(`^\\[${USERNAME_REGEX} -> \\w+\\s?\\] (.*)$`), { deprecated: true })

package/lib/plugins/entities.js

@@ -483,15 +483,15 @@ function inject (bot, { version }) {
         } 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) return
+          if (player.entity === bot.entity) continue
 
           player.entity = null
           delete bot.players[player.username]
           delete bot.uuidToUsername[item.UUID]
           bot.emit('playerLeft', player)
-          return
+          continue
         } else {
-          return
+          continue
         }
 
         bot.emit('playerUpdated', player)
@@ -531,8 +531,8 @@ function inject (bot, { version }) {
   bot.useOn = useOn
   bot.moveVehicle = moveVehicle
 
-  function swingArm (arm = 'left', showHand = true) {
-    const hand = arm === 'left' ? 0 : 1
+  function swingArm (arm = 'right', showHand = true) {
+    const hand = arm === 'right' ? 0 : 1
     const packet = {}
     if (showHand) packet.hand = hand
     bot._client.write('arm_animation', packet)
@@ -544,11 +544,11 @@ function inject (bot, { version }) {
   }
 
   function attack (target, swing = true) {
-    useEntity(target, 1)
-
+    // arm animation comes before the use_entity packet
     if (swing) {
       swingArm()
     }
+    useEntity(target, 1)
   }
 
   function mount (target) {

package/lib/plugins/game.js

@@ -90,4 +90,11 @@ function inject (bot, options) {
   bot._client.on(brandChannel, (serverBrand) => {
     bot.game.serverBrand = serverBrand
   })
+
+  // mimic the vanilla 1.17 client to prevent anticheat kicks
+  bot._client.on('ping', (data) => {
+    bot._client.write('pong', {
+      id: data.id
+    })
+  })
 }

package/lib/plugins/inventory.js

@@ -427,13 +427,24 @@ function inject (bot, { version, hideErrors }) {
   function confirmTransaction (windowId, actionId, accepted) {
     // drop the queue entries for all the clicks that the server did not send
     // transaction packets for.
-    let click = windowClickQueue.shift()
-    if (click === undefined) {
+    // Also reject transactions that aren't sent from mineflayer
+    let click = windowClickQueue[0]
+    if (click === undefined || !windowClickQueue.some(clicks => clicks.id === actionId)) {
+      // mimic vanilla client and send a rejection for faulty transaction packets
+      bot._client.write('transaction', {
+        windowId: windowId,
+        action: actionId,
+        accepted: true
+        // bot.emit(`confirmTransaction${click.id}`, false)
+      })
       if (!hideErrors) {
         console.log(`WARNING : unknown transaction confirmation for window ${windowId}, action ${actionId} and accepted ${accepted}`)
       }
       return
     }
+    // shift it later if packets are sent out of order
+    click = windowClickQueue.shift()
+
     assert.ok(click.id <= actionId)
     while (actionId > click.id) {
       onAccepted()
@@ -534,7 +545,7 @@ function inject (bot, { version, hideErrors }) {
       }
       const [success] = await response
       if (!success) {
-        throw new Error(`Server rejected transaction for clicking on slot ${slot}, on window ${JSON.stringify(window.slots, null, 2)}.`)
+        throw new Error(`Server rejected transaction for clicking on slot ${slot}, on window with id ${window?.id}.`)
       }
     } else {
       await waitForWindowUpdate(window, slot)
@@ -564,9 +575,6 @@ function inject (bot, { version, hideErrors }) {
 
   bot._client.on('transaction', (packet) => {
     // confirm transaction
-    if (packet.action < 0) {
-      return
-    }
     confirmTransaction(packet.windowId, packet.action, packet.accepted)
   })
 

package/lib/plugins/physics.js

@@ -33,6 +33,7 @@ function inject (bot, { physicsEnabled }) {
     sneak: false
   }
   let lastSentYaw = null
+  let lastSentPitch = null
   let doPhysicsTimer = null
   let lastPhysicsFrameTime = null
   let shouldUsePhysics = false
@@ -122,13 +123,16 @@ function inject (bot, { physicsEnabled }) {
 
     // Increment the yaw in baby steps so that notchian clients (not the server) can keep up.
     const dYaw = deltaYaw(bot.entity.yaw, lastSentYaw)
+    const dPitch = bot.entity.pitch - (lastSentPitch || 0)
 
     // Vanilla doesn't clamp yaw, so we don't want to do it either
     const maxDeltaYaw = dt * physics.yawSpeed
+    const maxDeltaPitch = dt * physics.pitchSpeed
     lastSentYaw += math.clamp(-maxDeltaYaw, dYaw, maxDeltaYaw)
+    lastSentPitch += math.clamp(-maxDeltaPitch, dPitch, maxDeltaPitch)
 
-    const yaw = conv.toNotchianYaw(lastSentYaw)
-    const pitch = conv.toNotchianPitch(bot.entity.pitch)
+    const yaw = Math.fround(conv.toNotchianYaw(lastSentYaw))
+    const pitch = Math.fround(conv.toNotchianPitch(lastSentPitch))
     const position = bot.entity.position
     const onGround = bot.entity.onGround
 
@@ -225,8 +229,15 @@ function inject (bot, { physicsEnabled }) {
     }
     lookingTask = createTask()
 
-    bot.entity.yaw = yaw
-    bot.entity.pitch = pitch
+    // this is done to bypass certain anticheat checks that detect the player's sensitivity
+    // by calculating the gcd of how much they move the mouse each tick
+    const sensitivity = conv.fromNotchianPitch(0.15) // this is equal to 100% sensitivity in vanilla
+    const yawChange = Math.round((yaw - bot.entity.yaw) / sensitivity) * sensitivity
+    const pitchChange = Math.round((pitch - bot.entity.pitch) / sensitivity) * sensitivity
+
+    bot.entity.yaw += yawChange
+    bot.entity.pitch += pitchChange
+
     if (force) {
       lastSentYaw = yaw
       return

package/lib/plugins/ray_trace.js

@@ -23,4 +23,14 @@ module.exports = (bot) => {
 
     return bot.world.raycast(eyePosition, viewDirection, maxDistance, matcher)
   }
+
+  bot.blockAtEntityCursor = (entity = bot.entity, maxDistance = 256, matcher = null) => {
+    if (!entity.position || !entity.height || !entity.pitch || !entity.yaw) return null
+    const { position, height, pitch, yaw } = entity
+
+    const eyePosition = position.offset(0, height, 0)
+    const viewDirection = getViewDirection(pitch, yaw)
+
+    return bot.world.raycast(eyePosition, viewDirection, maxDistance, matcher)
+  }
 }

package/lib/plugins/villager.js

@@ -118,7 +118,6 @@ function inject (bot, { version }) {
       if (!ready) {
         ready = true
         villager.emit('ready')
-        console.log('emit ready')
       }
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mineflayer",
-  "version": "3.11.2",
+  "version": "3.12.0",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",
@@ -21,31 +21,32 @@
   },
   "license": "MIT",
   "dependencies": {
-    "minecraft-data": "^2.79.0",
-    "minecraft-protocol": "^1.17.0",
-    "prismarine-biome": "^1.1.0",
-    "prismarine-block": "^1.6.0",
-    "prismarine-chat": "^1.1.0",
-    "prismarine-chunk": "^1.24.0",
-    "prismarine-entity": "^1.0.0",
-    "prismarine-item": "^1.6.0",
-    "prismarine-physics": "^1.0.4",
+    "minecraft-data": "^2.95.0",
+    "minecraft-protocol": "^1.26.5",
+    "prismarine-biome": "^1.1.1",
+    "prismarine-block": "^1.10.3",
+    "prismarine-chat": "^1.3.3",
+    "prismarine-chunk": "^1.26.0",
+    "prismarine-entity": "^1.2.0",
+    "prismarine-item": "^1.11.0",
+    "prismarine-nbt": "^2.0.0",
+    "prismarine-physics": "^1.3.1",
     "prismarine-recipe": "^1.1.0",
-    "prismarine-windows": "^2.3.0",
+    "prismarine-windows": "^2.4.2",
     "prismarine-world": "^3.6.0",
-    "protodef": "^1.8.0",
-    "typed-emitter": "^1.2.0",
-    "vec3": "^0.1.6"
+    "protodef": "^1.14.0",
+    "typed-emitter": "^1.3.1",
+    "vec3": "^0.1.7"
   },
   "devDependencies": {
-    "@types/node": "^16.0.1",
-    "doctoc": "^2.0.0",
-    "minecraft-wrap": "^1.2.1",
+    "@types/node": "^17.0.0",
+    "doctoc": "^2.0.1",
+    "minecraft-wrap": "^1.3.0",
     "mineflayer": "file:.",
-    "mocha": "^9.0.0",
-    "standard": "^16.0.1",
-    "standard-markdown": "^7.0.0",
-    "ts-standard": "^10.0.0",
-    "typescript": "^4.3.2"
+    "mocha": "^9.1.2",
+    "standard": "^16.0.4",
+    "standard-markdown": "^7.1.0",
+    "ts-standard": "^11.0.0",
+    "typescript": "^4.4.3"
   }
 }