mineflayer 3.12.0 → 3.14.1

package/README.md

@@ -1,6 +1,6 @@
 # Mineflayer
 
-[![NPM version](https://badge.fury.io/js/mineflayer.svg)](http://badge.fury.io/js/mineflayer)
+[![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)
 [![Issue Hunt](https://github.com/BoostIO/issuehunt-materials/blob/master/v1/issuehunt-shield-v1.svg)](https://issuehunt.io/r/PrismarineJS/mineflayer)

package/docs/README.md

@@ -1,6 +1,6 @@
 # Mineflayer
 
-[![NPM version](https://badge.fury.io/js/mineflayer.svg)](http://badge.fury.io/js/mineflayer)
+[![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)
 [![Issue Hunt](https://github.com/BoostIO/issuehunt-materials/blob/master/v1/issuehunt-shield-v1.svg)](https://issuehunt.io/r/PrismarineJS/mineflayer)

package/docs/history.md

@@ -1,3 +1,23 @@
+## 3.14.1
+
+* Fix arm_animation and use_entity (@amorashi)
+
+## 3.14.0
+
+* Make prismarine-entity versioned (@u9g)
+* fix(typings): Added OpenContainer (@SaubereSache)
+
+## 3.13.1
+
+* Fix bug with force lastSentPitch in bot.look (@KadaverBrutalo10)
+* Fix typo harming type safety (@Eagle-Anne)
+
+## 3.13.0
+
+* compute scoreboard displayName dynamically (@U9G)
+* SkinsRestorer fix (@U5B)
+* Fix bot not swinging arm on block place (@IceTank)
+
 ## 3.12.0
 
 * Bypass anticheats that detect sensitivity (@mat-1)

package/examples/attack.js

@@ -0,0 +1,45 @@
+/*
+ *
+ * A bot that attacks the player that sends a message or the nearest entity (excluding players)
+ *
+ */
+const mineflayer = require('mineflayer')
+
+if (process.argv.length < 4 || process.argv.length > 6) {
+  console.log('Usage : node attack.js <host> <port> [<name>] [<password>]')
+  process.exit(1)
+}
+
+const bot = mineflayer.createBot({
+  host: process.argv[2],
+  port: parseInt(process.argv[3]),
+  username: process.argv[4] ? process.argv[4] : 'attack',
+  password: process.argv[5]
+})
+
+bot.on('spawn', () => {
+  bot.on('chat', (username, message) => {
+    if (message === 'attack me') attackPlayer(username)
+    else if (message === 'attack') attackEntity()
+  })
+})
+
+function attackPlayer (username) {
+  const player = bot.players[username]
+  if (!player || !player.entity) {
+    bot.chat('I can\'t see you')
+  } else {
+    bot.chat(`Attacking ${player.username}`)
+    bot.attack(player.entity)
+  }
+}
+
+function attackEntity () {
+  const entity = bot.nearestEntity()
+  if (!entity) {
+    bot.chat('No nearby entities')
+  } else {
+    bot.chat(`Attacking ${entity.name ?? entity.username}`)
+    bot.attack(entity)
+  }
+}

package/index.d.ts

@@ -201,7 +201,7 @@ export interface Bot extends TypedEmitter<BotEvents> {
   blockInSight: (maxSteps: number, vectorLength: number) => Block | null
 
   blockAtCursor: (maxDistance?: number, matcher?: Function) => Block | null
-  blockAtEntityCursor: (entity?: entity, maxDistance?: number, matcher?: Function) => Block | null
+  blockAtEntityCursor: (entity?: Entity, maxDistance?: number, matcher?: Function) => Block | null
 
   canSeeBlock: (block: Block) => boolean
 
@@ -343,6 +343,8 @@ export interface Bot extends TypedEmitter<BotEvents> {
     callback?: (err?: Error) => void
   ) => Promise<void>
 
+  openContainer: (chest: Block | Entity) => Promise<Chest | Furnace | Dispenser>
+
   openChest: (chest: Block | Entity) => Promise<Chest>
 
   openFurnace: (furnace: Block) => Promise<Furnace>

package/lib/features.json

@@ -318,5 +318,10 @@
     "name": "setSlotAsTransaction",
     "description": "use setslot as transaction instead of just hoping it'll work",
     "versions": ["1.17", "1.17.1"]
+  },
+  {
+    "name": "armAnimationBeforeUse",
+    "description": "arm animation packet sent before use entity packet",
+    "versions": ["1.8", "1.8.9"]
   }
 ]

package/lib/plugins/blocks.js

@@ -476,6 +476,7 @@ function inject (bot, { version, storageBuilder }) {
   // if we get a respawn packet and the dimension is changed,
   // unload all chunks from memory.
   let dimension
+  let worldName
   function dimensionToFolderName (dimension) {
     if (bot.supportFeature('dimensionIsAnInt')) {
       return dimensionNames[dimension]
@@ -511,13 +512,26 @@ function inject (bot, { version, storageBuilder }) {
   }
 
   bot._client.on('login', (packet) => {
-    dimension = packet.dimension
+    if (bot.supportFeature('dimensionIsAnInt')) {
+      dimension = packet.dimension
+    } else {
+      dimension = packet.dimension
+      worldName = packet.worldName
+    }
     switchWorld()
   })
 
   bot._client.on('respawn', (packet) => {
-    if (dimension === packet.dimension) return
-    dimension = packet.dimension
+    if (bot.supportFeature('dimensionIsAnInt')) { // <=1.15.2
+      if (dimension === packet.dimension) return
+      dimension = packet.dimension
+    } else { // >= 1.15.2
+      if (dimension === packet.dimension) return
+      if (worldName === packet.worldName && packet.copyMetadata === true) return // don't unload chunks if in same world and metaData is true
+      // Metadata is true when switching dimensions however, then the world name is different
+      dimension = packet.dimension
+      worldName = packet.worldName
+    }
     switchWorld()
   })
 

package/lib/plugins/entities.js

@@ -1,5 +1,4 @@
 const { Vec3 } = require('vec3')
-const Entity = require('prismarine-entity')
 const conv = require('../conversions')
 const NAMED_ENTITY_HEIGHT = 1.62
 const NAMED_ENTITY_WIDTH = 0.6
@@ -26,6 +25,7 @@ const entityStatusEvents = {
 }
 
 function inject (bot, { version }) {
+  const Entity = require('prismarine-entity')(version)
   const objects = require('minecraft-data')(version).objects
   const mobs = require('minecraft-data')(version).mobs
   const entitiesArray = require('minecraft-data')(version).entitiesArray
@@ -89,7 +89,11 @@ function inject (bot, { version }) {
     return best
   }
 
-  bot._client.once('login', (packet) => {
+  // Reset list of players and entities on login
+  bot._client.on('login', (packet) => {
+    bot.players = {}
+    bot.uuidToUsername = {}
+    bot.entities = {}
     // login
     bot.entity = fetchEntity(packet.entityId)
     bot.username = bot._client.username
@@ -544,11 +548,18 @@ function inject (bot, { version }) {
   }
 
   function attack (target, swing = true) {
-    // arm animation comes before the use_entity packet
-    if (swing) {
-      swingArm()
+    // arm animation comes before the use_entity packet on 1.8
+    if (bot.supportFeature('armAnimationBeforeUse')) {
+      if (swing) {
+        swingArm()
+      }
+      useEntity(target, 1)
+    } else {
+      useEntity(target, 1)
+      if (swing) {
+        swingArm()
+      }
     }
-    useEntity(target, 1)
   }
 
   function mount (target) {

package/lib/plugins/generic_place.js

@@ -7,7 +7,7 @@ function inject (bot, { version }) {
    *
    * @param {import('prismarine-block').Block} referenceBlock
    * @param {import('vec3').Vec3} faceVector
-   * @param {{half?: 'top'|'bottom', delta?: import('vec3').Vec3, forceLook?: boolean | 'ignore', offhand?: boolean}} options
+   * @param {{half?: 'top'|'bottom', delta?: import('vec3').Vec3, forceLook?: boolean | 'ignore', offhand?: boolean, swingArm?: 'right' | 'left', showHand?: boolean}} options
    */
   async function _genericPlace (referenceBlock, faceVector, options) {
     let handToPlaceWith = 0
@@ -39,6 +39,10 @@ function inject (bot, { version }) {
     // TODO: tell the server that we are sneaking while doing this
     const pos = referenceBlock.position
 
+    if (options.swingArm) {
+      bot.swingArm(options.swingArm, options.showHand)
+    }
+
     if (bot.supportFeature('blockPlaceHasHeldItem')) {
       const packet = {
         location: pos,

package/lib/plugins/physics.js

@@ -240,6 +240,7 @@ function inject (bot, { physicsEnabled }) {
 
     if (force) {
       lastSentYaw = yaw
+      lastSentPitch = pitch
       return
     }
 

package/lib/plugins/place_block.js

@@ -21,7 +21,7 @@ function inject (bot) {
   }
 
   async function placeBlock (referenceBlock, faceVector) {
-    await placeBlockWithOptions(referenceBlock, faceVector, {})
+    await placeBlockWithOptions(referenceBlock, faceVector, { swingArm: 'right' })
   }
 
   bot.placeBlock = callbackify(placeBlock)

package/lib/plugins/place_entity.js

@@ -5,6 +5,12 @@ module.exports = inject
 function inject (bot, { version }) {
   const Item = require('prismarine-item')(version)
 
+  /**
+   *
+   * @param {import('prismarine-block').Block} referenceBlock
+   * @param {import('vec3').Vec3} faceVector
+   * @param {{forceLook?: boolean | 'ignore', offhand?: boolean, swingArm?: 'right' | 'left', showHand?: boolean}} options
+   */
   async function placeEntityWithOptions (referenceBlock, faceVector, options) {
     if (!bot.heldItem) throw new Error('must be holding an item to place an entity')
 
@@ -20,14 +26,14 @@ function inject (bot, { version }) {
       name = bot.heldItem.spawnEggMobName
     }
 
-    const pos = await bot._genericPlace(referenceBlock, faceVector, options)
-
     if (type === 'spawn_egg') {
-      bot.swingArm(undefined, false)
-    } else {
-      bot.swingArm()
+      options.showHand = false
     }
 
+    if (!options.swingArm) options.swingArm = options.offhand ? 'left' : 'right'
+
+    const pos = await bot._genericPlace(referenceBlock, faceVector, options)
+
     if (type === 'boat') {
       if (bot.supportFeature('useItemWithOwnPacket')) {
         bot._client.write('use_item', {

package/lib/plugins/scoreboard.js

@@ -1,9 +1,7 @@
-const ScoreBoard = require('../scoreboard')
-
 module.exports = inject
 
 function inject (bot) {
-  const ChatMessage = require('prismarine-chat')(bot.version)
+  const ScoreBoard = require('../scoreboard')(bot)
   const scoreboards = {}
 
   bot._client.on('scoreboard_objective', (packet) => {
@@ -29,12 +27,7 @@ function inject (bot) {
   bot._client.on('scoreboard_score', (packet) => {
     const scoreboard = scoreboards[packet.scoreName]
     if (scoreboard !== undefined && packet.action === 0) {
-      const { itemName, value } = packet
-      let displayName = new ChatMessage(itemName)
-      if (itemName in bot.teamMap) {
-        displayName = bot.teamMap[itemName].displayName(itemName)
-      }
-      const updated = scoreboard.add(itemName, value, displayName)
+      const updated = scoreboard.add(packet.itemName, packet.value)
       bot.emit('scoreUpdated', scoreboard, updated)
     }
 

package/lib/scoreboard.js

@@ -4,49 +4,62 @@ const sortItems = (a, b) => {
   return 1
 }
 
-class ScoreBoard {
-  constructor (packet) {
-    this.name = packet.name
-    this.setTitle(packet.displayText)
-    this.itemsMap = {}
-  }
+module.exports = (bot) => {
+  const ChatMessage = require('prismarine-chat')(bot.version)
 
-  setTitle (title) {
-    try {
-      this.title = JSON.parse(title).text // version>1.13
-    } catch {
-      this.title = title
+  class ScoreBoard {
+    constructor (packet) {
+      this.name = packet.name
+      this.setTitle(packet.displayText)
+      this.itemsMap = {}
     }
-  }
 
-  add (name, value, displayName) {
-    this.itemsMap[name] = { name, value, displayName }
-    return this.itemsMap[name]
-  }
+    setTitle (title) {
+      try {
+        this.title = JSON.parse(title).text // version>1.13
+      } catch {
+        this.title = title
+      }
+    }
 
-  remove (name) {
-    const removed = this.itemsMap[name]
-    delete this.itemsMap[name]
-    return removed
-  }
+    add (name, value) {
+      this.itemsMap[name] = { name, value }
+      this.itemsMap[name] = {
+        name,
+        value,
+        get displayName () {
+          if (name in bot.teamMap) {
+            return bot.teamMap[name].displayName(name)
+          }
+          return new ChatMessage(name)
+        }
+      }
+      return this.itemsMap[name]
+    }
 
-  get items () {
-    return Object.values(this.itemsMap).sort(sortItems)
+    remove (name) {
+      const removed = this.itemsMap[name]
+      delete this.itemsMap[name]
+      return removed
+    }
+
+    get items () {
+      return Object.values(this.itemsMap).sort(sortItems)
+    }
   }
-}
 
-ScoreBoard.positions = {
-  get list () {
-    return this[0]
-  },
+  ScoreBoard.positions = {
+    get list () {
+      return this[0]
+    },
 
-  get sidebar () {
-    return this[1]
-  },
+    get sidebar () {
+      return this[1]
+    },
 
-  get belowName () {
-    return this[2]
+    get belowName () {
+      return this[2]
+    }
   }
+  return ScoreBoard
 }
-
-module.exports = ScoreBoard

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mineflayer",
-  "version": "3.12.0",
+  "version": "3.14.1",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",
@@ -27,7 +27,7 @@
     "prismarine-block": "^1.10.3",
     "prismarine-chat": "^1.3.3",
     "prismarine-chunk": "^1.26.0",
-    "prismarine-entity": "^1.2.0",
+    "prismarine-entity": "^2.0.0",
     "prismarine-item": "^1.11.0",
     "prismarine-nbt": "^2.0.0",
     "prismarine-physics": "^1.3.1",