mineflayer 4.19.0 → 4.20.0

package/README.md

@@ -17,7 +17,7 @@ First time using Node.js? You may want to start with the [tutorial](tutorial.md)
 
 ## Features
 
- * Supports Minecraft 1.8 to 1.20.2 (1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19 and 1.20)
+ * Supports Minecraft 1.8 to 1.20.4 (1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19 and 1.20)
  * Entity knowledge and tracking.
  * Block knowledge. You can query the world around you. Milliseconds to find any block.
  * Physics and movement - handle all bounding boxes

package/docs/README.md

@@ -17,7 +17,7 @@ First time using Node.js? You may want to start with the [tutorial](tutorial.md)
 
 ## Features
 
- * Supports Minecraft 1.8 to 1.20.2 (1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19 and 1.20)
+ * Supports Minecraft 1.8 to 1.20.4 (1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19 and 1.20)
  * Entity knowledge and tracking.
  * Block knowledge. You can query the world around you. Milliseconds to find any block.
  * Physics and movement - handle all bounding boxes

package/docs/api.md

@@ -1691,6 +1691,8 @@ the event will be called `"chat:name"`, with name being the name passed
 
 returns a number which can be used with bot.removeChatPattern() to only delete this pattern
 
+- :eyes: cf. [examples/chat_parsing](https://github.com/PrismarineJS/mineflayer/blob/master/examples/chat_parsing.js#L17-L36)
+
 #### bot.addChatPatternSet(name, patterns, chatPatternOptions)
 
 make an event that is called every time all patterns havee been matched to messages,
@@ -1703,6 +1705,8 @@ the event will be called `"chat:name"`, with name being the name passed
 
 returns a number which can be used with bot.removeChatPattern() to only delete this patternset
 
+- :eyes: cf. [examples/chat_parsing](https://github.com/PrismarineJS/mineflayer/blob/master/examples/chat_parsing.js#L17-L36)
+
 #### bot.removeChatPattern(name)
 
 removes a chat pattern(s)

package/docs/history.md

@@ -1,3 +1,8 @@
+## 4.20.0
+* [Update api.md - addChatPattern[Set] link to example of usage (#3304)](https://github.com/PrismarineJS/mineflayer/commit/bb3e5877b7b3b8ab063b39a5b47d103b819da1c2) (thanks @boly38)
+* [Fixed deleted scoreboards not being removed from ScoreBoard.positions (#3306)](https://github.com/PrismarineJS/mineflayer/commit/643023df91bf428d3e7d30e8f2eab97e3238b0b2) (thanks @Ynfuien)
+* [Support 1.20.4 (#3310)](https://github.com/PrismarineJS/mineflayer/commit/aa99daa7d63ee9549f2dda5a79c140e30e19a89b) (thanks @rom1504)
+
 ## 4.19.0
 * [Clarify readme createBot username handling (#3300)](https://github.com/PrismarineJS/mineflayer/commit/7a2680bc07f53d16626679537ea1f07aae180549) (thanks @extremeheat)
 * [fix world typing (#3302)](https://github.com/PrismarineJS/mineflayer/commit/5dc36d6cdeaf4be72ea023827d45b9d78e575f66) (thanks @GenerelSchwerz)

package/lib/bossbar.js

@@ -1,101 +1,98 @@
-let ChatMessage
 const colors = ['pink', 'blue', 'red', 'green', 'yellow', 'purple', 'white']
 const divisions = [0, 6, 10, 12, 20]
 
-module.exports = loader
-
 function loader (registry) {
-  ChatMessage = require('prismarine-chat')(registry)
-  return BossBar
-}
-
-class BossBar {
-  constructor (uuid, title, health, dividers, color, flags) {
-    this._entityUUID = uuid
-    this._title = new ChatMessage(JSON.parse(title))
-    this._health = health
-    this._dividers = divisions[dividers]
-    this._color = colors[color]
-    this._shouldDarkenSky = flags & 0x1
-    this._isDragonBar = flags & 0x2
-    this._createFog = flags & 0x4
-  }
-
-  set entityUUID (uuid) {
-    this._entityUUID = uuid
-  }
-
-  set title (title) {
-    this._title = new ChatMessage(JSON.parse(title))
-  }
-
-  set health (health) {
-    this._health = health
-  }
-
-  set dividers (dividers) {
-    this._dividers = divisions[dividers]
-  }
-
-  set color (color) {
-    this._color = colors[color]
-  }
-
-  set flags (flags) {
-    this._shouldDarkenSky = flags & 0x1
-    this._isDragonBar = flags & 0x2
-    this._createFog = flags & 0x4
-  }
-
-  get flags () {
-    return (this._shouldDarkenSky) | (this._isDragonBar << 1) | (this._createFog << 2)
-  }
-
-  set shouldDarkenSky (darkenSky) {
-    this._shouldDarkenSky = darkenSky
-  }
-
-  set isDragonBar (dragonBar) {
-    this._isDragonBar = dragonBar
-  }
-
-  get createFog () {
-    return this._createFog
-  }
-
-  set createFog (createFog) {
-    this._createFog = createFog
-  }
-
-  get entityUUID () {
-    return this._entityUUID
-  }
-
-  get title () {
-    return this._title
-  }
-
-  get health () {
-    return this._health
-  }
-
-  get dividers () {
-    return this._dividers
-  }
-
-  get color () {
-    return this._color
-  }
-
-  get shouldDarkenSky () {
-    return this._shouldDarkenSky
-  }
-
-  get isDragonBar () {
-    return this._isDragonBar
-  }
-
-  get shouldCreateFog () {
-    return this._createFog
+  const ChatMessage = require('prismarine-chat')(registry)
+  return class BossBar {
+    constructor (uuid, title, health, dividers, color, flags) {
+      this._entityUUID = uuid
+      this._title = ChatMessage.fromNotch(title)
+      this._health = health
+      this._dividers = divisions[dividers]
+      this._color = colors[color]
+      this._shouldDarkenSky = flags & 0x1
+      this._isDragonBar = flags & 0x2
+      this._createFog = flags & 0x4
+    }
+
+    set entityUUID (uuid) {
+      this._entityUUID = uuid
+    }
+
+    set title (title) {
+      this._title = ChatMessage.fromNotch(title)
+    }
+
+    set health (health) {
+      this._health = health
+    }
+
+    set dividers (dividers) {
+      this._dividers = divisions[dividers]
+    }
+
+    set color (color) {
+      this._color = colors[color]
+    }
+
+    set flags (flags) {
+      this._shouldDarkenSky = flags & 0x1
+      this._isDragonBar = flags & 0x2
+      this._createFog = flags & 0x4
+    }
+
+    get flags () {
+      return (this._shouldDarkenSky) | (this._isDragonBar << 1) | (this._createFog << 2)
+    }
+
+    set shouldDarkenSky (darkenSky) {
+      this._shouldDarkenSky = darkenSky
+    }
+
+    set isDragonBar (dragonBar) {
+      this._isDragonBar = dragonBar
+    }
+
+    get createFog () {
+      return this._createFog
+    }
+
+    set createFog (createFog) {
+      this._createFog = createFog
+    }
+
+    get entityUUID () {
+      return this._entityUUID
+    }
+
+    get title () {
+      return this._title
+    }
+
+    get health () {
+      return this._health
+    }
+
+    get dividers () {
+      return this._dividers
+    }
+
+    get color () {
+      return this._color
+    }
+
+    get shouldDarkenSky () {
+      return this._shouldDarkenSky
+    }
+
+    get isDragonBar () {
+      return this._isDragonBar
+    }
+
+    get shouldCreateFog () {
+      return this._createFog
+    }
   }
 }
+
+module.exports = loader

package/lib/plugins/anvil.js

@@ -1,6 +1,6 @@
 const assert = require('assert')
 const { sleep } = require('../promise_utils')
-const { once } = require('events')
+const { once } = require('../promise_utils')
 
 module.exports = inject
 
@@ -12,7 +12,7 @@ function inject (bot) {
   async function openAnvil (anvilBlock) {
     const anvil = await bot.openBlock(anvilBlock)
     if (!matchWindowType(anvil)) {
-      throw new Error('This is not a anvil-like window')
+      throw new Error('Not a anvil-like window: ' + JSON.stringify(anvil))
     }
 
     function err (name) {

package/lib/plugins/book.js

@@ -1,5 +1,5 @@
 const assert = require('assert')
-const { once } = require('events')
+const { once } = require('../promise_utils')
 
 module.exports = inject
 

package/lib/plugins/chat.js

@@ -144,7 +144,7 @@ function inject (bot, options) {
   function chatWithHeader (header, message) {
     if (typeof message === 'number') message = message.toString()
     if (typeof message !== 'string') {
-      throw new Error('Incorrect type! Should be a string or number.')
+      throw new Error('Chat message type must be a string or number: ' + typeof message)
     }
 
     if (!header && message.startsWith('/')) {

package/lib/plugins/chest.js

@@ -23,7 +23,7 @@ function inject (bot) {
       throw new Error('containerToOpen is neither a block nor an entity')
     }
 
-    if (!matchWindowType(chest)) { throw new Error('Non-container window used as a container') }
+    if (!matchWindowType(chest)) { throw new Error('Non-container window used as a container: ' + JSON.stringify(chest)) }
     return chest
   }
 

package/lib/plugins/craft.js

@@ -1,5 +1,5 @@
 const assert = require('assert')
-const { once } = require('events')
+const { once } = require('../promise_utils')
 
 module.exports = inject
 
@@ -12,7 +12,7 @@ function inject (bot) {
     assert.ok(recipe)
     count = parseInt(count ?? 1, 10)
     if (recipe.requiresTable && !craftingTable) {
-      throw new Error('recipe requires craftingTable')
+      throw new Error('Recipe requires craftingTable, but one was not supplied: ' + JSON.stringify(recipe))
     }
 
     try {
@@ -41,7 +41,7 @@ function inject (bot) {
         windowCraftingTable = window
       }
       if (!windowCraftingTable.type.startsWith('minecraft:crafting')) {
-        throw new Error('crafting: non craftingTable used as craftingTable')
+        throw new Error('crafting: non craftingTable used as craftingTable: ' + windowCraftingTable.type)
       }
       await startClicking(windowCraftingTable, 3, 3)
     } else {

package/lib/plugins/creative.js

@@ -1,7 +1,7 @@
 const assert = require('assert')
 const { Vec3 } = require('vec3')
 const { sleep, onceWithCleanup } = require('../promise_utils')
-const { once } = require('events')
+const { once } = require('../promise_utils')
 
 module.exports = inject
 
@@ -70,7 +70,7 @@ function inject (bot) {
 
     // last step
     bot.entity.position = destination
-    await once(bot, 'move')
+    await once(bot, 'move', /* no timeout */ 0)
   }
 
   function startFlying () {

package/lib/plugins/enchantment_table.js

@@ -1,5 +1,5 @@
 const assert = require('assert')
-const { once } = require('events')
+const { once } = require('../promise_utils')
 
 module.exports = inject
 
@@ -9,7 +9,7 @@ function inject (bot) {
     let ready = false
     const enchantmentTable = await bot.openBlock(enchantmentTableBlock)
     if (!enchantmentTable.type.startsWith('minecraft:enchant')) {
-      throw new Error('This is not an enchantment table')
+      throw new Error('Expected minecraft:enchant when opening table but got ' + enchantmentTable.type)
     }
 
     resetEnchantmentOptions()

package/lib/plugins/entities.js

@@ -597,7 +597,7 @@ function inject (bot) {
         }
 
         if (item.displayName) {
-          obj.displayName = new ChatMessage(JSON.parse(item.displayName))
+          obj.displayName = ChatMessage.fromNotch(item.displayName)
         } else if (packet.action & 32) obj.displayName = new ChatMessage({ text: '', extra: [{ text: player.username || obj.username }] })
 
         if (newPlayer) {
@@ -660,7 +660,7 @@ function inject (bot) {
           }
 
           if (item.displayName) {
-            player.displayName = new ChatMessage(JSON.parse(item.displayName))
+            player.displayName = ChatMessage.fromNotch(item.displayName)
           }
 
           const playerEntity = Object.values(bot.entities).find(e => e.type === 'player' && e.username === item.name)
@@ -681,7 +681,7 @@ function inject (bot) {
           } 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))
+            player.displayName = ChatMessage.fromNotch(item.displayName)
           } else if (packet.action === 4) {
             if (player.entity === bot.entity) continue
 

package/lib/plugins/inventory.js

@@ -1,7 +1,6 @@
 const assert = require('assert')
 const { Vec3 } = require('vec3')
-const { once } = require('events')
-const { sleep, createDoneTask, createTask, withTimeout } = require('../promise_utils')
+const { once, sleep, createDoneTask, createTask, withTimeout } = require('../promise_utils')
 
 module.exports = inject
 

package/lib/plugins/scoreboard.js

@@ -16,6 +16,14 @@ function inject (bot) {
     if (packet.action === 1) {
       bot.emit('scoreboardDeleted', scoreboards[packet.name])
       delete scoreboards[packet.name]
+
+      for (const position in ScoreBoard.positions) {
+        const scoreboard = ScoreBoard.positions[position]
+        if (scoreboard.name === packet.name) {
+          delete ScoreBoard.positions[position]
+          break
+        }
+      }
     }
 
     if (packet.action === 2) {

package/lib/plugins/tablist.js

@@ -13,14 +13,19 @@ function inject (bot) {
   }
 
   bot._client.on('playerlist_header', (packet) => {
-    if (packet.header) {
-      const header = escapeValueNewlines(packet.header)
-      bot.tablist.header = new ChatMessage(JSON.parse(header))
-    }
+    if (bot.supportFeature('chatPacketsUseNbtComponents')) { // 1.20.3+
+      bot.tablist.header = ChatMessage.fromNotch(packet.header)
+      bot.tablist.footer = ChatMessage.fromNotch(packet.footer)
+    } else {
+      if (packet.header) {
+        const header = escapeValueNewlines(packet.header)
+        bot.tablist.header = ChatMessage.fromNotch(header)
+      }
 
-    if (packet.footer) {
-      const footer = escapeValueNewlines(packet.footer)
-      bot.tablist.footer = new ChatMessage(JSON.parse(footer))
+      if (packet.footer) {
+        const footer = escapeValueNewlines(packet.footer)
+        bot.tablist.footer = ChatMessage.fromNotch(footer)
+      }
     }
   })
 }

package/lib/plugins/villager.js

@@ -1,5 +1,5 @@
 const assert = require('assert')
-const { once } = require('events')
+const { once } = require('../promise_utils')
 
 module.exports = inject
 
@@ -78,7 +78,7 @@ function inject (bot, { version }) {
     bot._client.on(tradeListPacket, gotTrades)
     const villager = await villagerPromise
     if (villager.type !== 'minecraft:villager' && villager.type !== 'minecraft:merchant') {
-      throw new Error('This is not a villager')
+      throw new Error('Expected minecraft:villager or minecraft:mechant type, but got ' + villager.type)
     }
 
     villager.trades = null

package/lib/promise_utils.js

@@ -72,6 +72,10 @@ function onceWithCleanup (emitter, event, { timeout = 0, checkCondition = undefi
   return task.promise
 }
 
+function once (emitter, event, timeout = 20000) {
+  return onceWithCleanup(emitter, event, { timeout })
+}
+
 function withTimeout (promise, timeout) {
   return Promise.race([
     promise,
@@ -82,6 +86,7 @@ function withTimeout (promise, timeout) {
 }
 
 module.exports = {
+  once,
   sleep,
   createTask,
   createDoneTask,

package/lib/team.js

@@ -1,14 +1,3 @@
-let ChatMessage
-let MessageBuilder
-
-module.exports = loader
-
-function loader (registry) {
-  ChatMessage = require('prismarine-chat')(registry)
-  MessageBuilder = ChatMessage.MessageBuilder
-  return Team
-}
-
 function colorString (color) {
   const formatting = [
     'black',
@@ -38,56 +27,60 @@ function colorString (color) {
   return formatting[color]
 }
 
-class Team {
-  constructor (team, name, friendlyFire, nameTagVisibility, collisionRule, formatting, prefix, suffix) {
-    this.team = team
-    this.update(name, friendlyFire, nameTagVisibility, collisionRule, formatting, prefix, suffix)
-    this.membersMap = {}
-  }
+function loader (registry) {
+  const ChatMessage = require('prismarine-chat')(registry)
+  const MessageBuilder = ChatMessage.MessageBuilder
+  return class Team {
+    constructor (team, name, friendlyFire, nameTagVisibility, collisionRule, formatting, prefix, suffix) {
+      this.team = team
+      this.update(name, friendlyFire, nameTagVisibility, collisionRule, formatting, prefix, suffix)
+      this.membersMap = {}
+    }
 
-  parseMessage (value) {
-    let result
-    try {
-      result = new ChatMessage(JSON.parse(value)) // version>1.13-pre7
-    } catch {
-      result = MessageBuilder.fromString(value, { colorSeparator: '§' })
-      if (result === null) {
-        return new ChatMessage('')
+    parseMessage (value) {
+      if (registry.supportFeature('teamUsesChatComponents')) { // 1.13+
+        return ChatMessage.fromNotch(value)
+      } else {
+        const result = MessageBuilder.fromString(value, { colorSeparator: '§' })
+        if (result === null) {
+          return new ChatMessage('')
+        }
+        return new ChatMessage(result.toJSON())
       }
-      return new ChatMessage(result.toJSON())
     }
-    return result
-  }
 
-  add (name) {
-    this.membersMap[name] = ''
-    return this.membersMap[name]
-  }
+    add (name) {
+      this.membersMap[name] = ''
+      return this.membersMap[name]
+    }
 
-  remove (name) {
-    const removed = this.membersMap[name]
-    delete this.membersMap[name]
-    return removed
-  }
+    remove (name) {
+      const removed = this.membersMap[name]
+      delete this.membersMap[name]
+      return removed
+    }
 
-  update (name, friendlyFire, nameTagVisibility, collisionRule, formatting, prefix, suffix) {
-    this.name = this.parseMessage(name)
-    this.friendlyFire = friendlyFire
-    this.nameTagVisibility = nameTagVisibility
-    this.collisionRule = collisionRule
-    this.color = colorString(formatting)
-    this.prefix = this.parseMessage(prefix)
-    this.suffix = this.parseMessage(suffix)
-  }
+    update (name, friendlyFire, nameTagVisibility, collisionRule, formatting, prefix, suffix) {
+      this.name = this.parseMessage(name)
+      this.friendlyFire = friendlyFire
+      this.nameTagVisibility = nameTagVisibility
+      this.collisionRule = collisionRule
+      this.color = colorString(formatting)
+      this.prefix = this.parseMessage(prefix)
+      this.suffix = this.parseMessage(suffix)
+    }
 
-  // Return a chat component with prefix + color + name + suffix
-  displayName (member) {
-    const name = this.prefix.clone()
-    name.append(new ChatMessage({ text: member, color: this.color }), this.suffix)
-    return name
-  }
+    // Return a chat component with prefix + color + name + suffix
+    displayName (member) {
+      const name = this.prefix.clone()
+      name.append(new ChatMessage({ text: member, color: this.color }), this.suffix)
+      return name
+    }
 
-  get members () {
-    return Object.keys(this.membersMap)
+    get members () {
+      return Object.keys(this.membersMap)
+    }
   }
 }
+
+module.exports = loader

package/lib/version.js

@@ -1,4 +1,4 @@
-const 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', '1.19.4', '1.20.1', '1.20.2']
+const 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', '1.19.4', '1.20.1', '1.20.2', '1.20.4']
 module.exports = {
 
   testedVersions,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mineflayer",
-  "version": "4.19.0",
+  "version": "4.20.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.56.0",
-    "minecraft-protocol": "^1.44.0",
+    "minecraft-protocol": "^1.47.0",
     "prismarine-biome": "^1.1.1",
     "prismarine-block": "^1.17.0",
     "prismarine-chat": "^1.7.1",
@@ -33,7 +33,7 @@
     "prismarine-physics": "^1.8.0",
     "prismarine-recipe": "^1.3.0",
     "prismarine-registry": "^1.5.0",
-    "prismarine-windows": "^2.8.0",
+    "prismarine-windows": "^2.9.0",
     "prismarine-world": "^3.6.0",
     "protodef": "^1.14.0",
     "typed-emitter": "^1.0.0",