mineflayer 3.14.0 → 3.17.0

package/examples/anvil.js

@@ -63,24 +63,22 @@ bot.on('chat', async (username, message) => {
   }
 })
 
-function tossItem (name, amount) {
+async function tossItem (name, amount) {
   amount = parseInt(amount, 10)
   const item = itemByName(name)
   if (!item) {
     bot.chat(`I have no ${name}`)
-  } else if (amount) {
-    bot.toss(item.type, null, amount, checkIfTossed)
   } else {
-    bot.tossStack(item, checkIfTossed)
-  }
-
-  function checkIfTossed (err) {
-    if (err) {
+    try {
+      if (amount) {
+        await bot.toss(item.type, null, amount)
+        bot.chat(`tossed ${amount} x ${name}`)
+      } else {
+        await bot.tossStack(item)
+        bot.chat(`tossed ${name}`)
+      }
+    } catch (err) {
       bot.chat(`unable to toss: ${err.message}`)
-    } else if (amount) {
-      bot.chat(`tossed ${amount} x ${name}`)
-    } else {
-      bot.chat(`tossed ${name}`)
     }
   }
 }

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/examples/chest.js

@@ -220,38 +220,36 @@ async function watchFurnace () {
       bot.removeListener('chat', onChat)
     }
 
-    function putInFurnace (where, name, amount) {
+    async function putInFurnace (where, name, amount) {
       const item = itemByName(furnace.items(), name)
       if (item) {
         const fn = {
           input: furnace.putInput,
           fuel: furnace.putFuel
         }[where]
-        fn.call(furnace, item.type, null, amount, (err) => {
-          if (err) {
-            bot.chat(`unable to put ${amount} ${item.name}`)
-          } else {
-            bot.chat(`put ${amount} ${item.name}`)
-          }
-        })
+        try {
+          await fn.call(furnace, item.type, null, amount)
+          bot.chat(`put ${amount} ${item.name}`)
+        } catch (err) {
+          bot.chat(`unable to put ${amount} ${item.name}`)
+        }
       } else {
         bot.chat(`unknown item ${name}`)
       }
     }
 
-    function takeFromFurnace (what) {
+    async function takeFromFurnace (what) {
       const fn = {
         input: furnace.takeInput,
         fuel: furnace.takeFuel,
         output: furnace.takeOutput
       }[what]
-      fn.call(furnace, (err, item) => {
-        if (err) {
-          bot.chat(`unable to take ${item.name}`)
-        } else {
-          bot.chat(`took ${item.name}`)
-        }
-      })
+      try {
+        const item = await fn.call(furnace)
+        bot.chat(`took ${item.name}`)
+      } catch (err) {
+        bot.chat('unable to take')
+      }
     }
   }
 }

package/examples/digger.js

@@ -56,7 +56,7 @@ function sayItems (items = bot.inventory.items()) {
   }
 }
 
-function dig () {
+async function dig () {
   let target
   if (bot.targetDigBlock) {
     bot.chat(`already digging ${bot.targetDigBlock.name}`)
@@ -64,19 +64,16 @@ function dig () {
     target = bot.blockAt(bot.entity.position.offset(0, -1, 0))
     if (target && bot.canDigBlock(target)) {
       bot.chat(`starting to dig ${target.name}`)
-      bot.dig(target, onDiggingCompleted)
+      try {
+        await bot.dig(target)
+        bot.chat(`finished digging ${target.name}`)
+      } catch (err) {
+        console.log(err.stack)
+      }
     } else {
       bot.chat('cannot dig')
     }
   }
-
-  function onDiggingCompleted (err) {
-    if (err) {
-      console.log(err.stack)
-      return
-    }
-    bot.chat(`finished digging ${target.name}`)
-  }
 }
 
 function build () {
@@ -87,28 +84,26 @@ function build () {
 
   let tryCount = 0
 
-  function placeIfHighEnough () {
+  async function placeIfHighEnough () {
     if (bot.entity.position.y > jumpY) {
-      bot.placeBlock(referenceBlock, vec3(0, 1, 0), (err) => {
-        if (err) {
-          tryCount++
-          if (tryCount > 10) {
-            bot.chat(err.message)
-            bot.setControlState('jump', false)
-            bot.removeListener('move', placeIfHighEnough)
-            return
-          }
-          return
-        }
+      try {
+        await bot.placeBlock(referenceBlock, vec3(0, 1, 0))
         bot.setControlState('jump', false)
         bot.removeListener('move', placeIfHighEnough)
         bot.chat('Placing a block was successful')
-      })
+      } catch (err) {
+        tryCount++
+        if (tryCount > 10) {
+          bot.chat(err.message)
+          bot.setControlState('jump', false)
+          bot.removeListener('move', placeIfHighEnough)
+        }
+      }
     }
   }
 }
 
-function equipDirt () {
+async function equipDirt () {
   const mcData = require('minecraft-data')(bot.version)
   let itemsByName
   if (bot.supportFeature('itemsAreNotBlocks')) {
@@ -116,13 +111,12 @@ function equipDirt () {
   } else if (bot.supportFeature('itemsAreAlsoBlocks')) {
     itemsByName = 'blocksByName'
   }
-  bot.equip(mcData[itemsByName].dirt.id, 'hand', (err) => {
-    if (err) {
-      bot.chat(`unable to equip dirt: ${err.message}`)
-    } else {
-      bot.chat('equipped dirt')
-    }
-  })
+  try {
+    await bot.equip(mcData[itemsByName].dirt.id, 'hand')
+    bot.chat('equipped dirt')
+  } catch (err) {
+    bot.chat(`unable to equip dirt: ${err.message}`)
+  }
 }
 
 function itemToString (item) {

package/examples/inventory.js

@@ -77,24 +77,22 @@ function sayItems (items = null) {
   }
 }
 
-function tossItem (name, amount) {
+async function tossItem (name, amount) {
   amount = parseInt(amount, 10)
   const item = itemByName(name)
   if (!item) {
     bot.chat(`I have no ${name}`)
-  } else if (amount) {
-    bot.toss(item.type, null, amount, checkIfTossed)
   } else {
-    bot.tossStack(item, checkIfTossed)
-  }
-
-  function checkIfTossed (err) {
-    if (err) {
+    try {
+      if (amount) {
+        await bot.toss(item.type, null, amount)
+        bot.chat(`tossed ${amount} x ${name}`)
+      } else {
+        await bot.tossStack(item)
+        bot.chat(`tossed ${name}`)
+      }
+    } catch (err) {
       bot.chat(`unable to toss: ${err.message}`)
-    } else if (amount) {
-      bot.chat(`tossed ${amount} x ${name}`)
-    } else {
-      bot.chat(`tossed ${name}`)
     }
   }
 }

package/index.d.ts

@@ -189,6 +189,7 @@ export interface Bot extends TypedEmitter<BotEvents> {
   heldItem: Item | null
   currentWindow: Window | null
   simpleClick: simpleClick
+  tablist: Tablist
 
   connect: (options: BotOptions) => void
 
@@ -427,6 +428,11 @@ export interface simpleClick {
   rightMouse: (slot: number) => Promise<void>
 }
 
+export interface Tablist {
+  header: ChatMessage
+  footer: ChatMessage
+}
+
 export interface chatPatternOptions {
   repeat: boolean
   parse: boolean
@@ -742,13 +748,18 @@ export class Villager extends (EventEmitter as new () => TypedEmitter<Conditiona
 }
 
 export interface VillagerTrade {
-  firstInput: Item
-  output: Item
-  hasSecondItem: boolean
-  secondaryInput: Item | null
-  disabled: boolean
-  tooluses: number
-  maxTradeuses: number
+  inputItem1: Item
+  outputItem: Item
+  inputItem2: Item | null
+  hasItem2: boolean
+  tradeDisabled: boolean
+  nbTradeUses: number
+  maximumNbTradeUses: number
+  xp?: number
+  specialPrice?: number
+  priceMultiplier?: number
+  demand?: number
+  realPrice?: number
 }
 
 export class ScoreBoard {
@@ -791,7 +802,7 @@ export class Team {
 
   update (name: string, friendlyFire: boolean, nameTagVisibility: string, collisionRule: string, formatting: number, prefix: string, suffix: string): void;
 
-  displayName (member: string);
+  displayName (member: string): ChatMessage;
 }
 
 export type DisplaySlot =

package/lib/features.json

@@ -7,7 +7,7 @@
   {
     "name": "spawner",
     "description": "spawner is called spawner",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "blockMetadata",
@@ -17,12 +17,12 @@
   {
     "name": "blockStateId",
     "description": "block metadata is encoded as state id",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "creativeSleepNearMobs",
     "description": "can sleep near mobs in creative",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "fixedPointPosition",
@@ -32,7 +32,7 @@
   {
     "name": "doublePosition",
     "description": "Entity positions are represented with double",
-    "versions": ["1.9", "1.17.1"]
+    "versions": ["1.9", "1.18.1"]
   },
   {
     "name": "fixedPointDelta",
@@ -42,7 +42,7 @@
   {
     "name": "fixedPointDelta128",
     "description": "Delta of position are represented with fixed point numbers times 128",
-    "versions": ["1.9", "1.17.1"]
+    "versions": ["1.9", "1.18.1"]
   },
   {
     "name": "customChannelMCPrefixed",
@@ -52,12 +52,12 @@
   {
     "name": "customChannelIdentifier",
     "description": "custom channel is an identifier starting in minecraft namespace",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "dimensionDataIsAvailable",
     "description": "dimensionData is available, providing an additional information about the current dimension",
-    "versions": ["1.17", "1.17.1"]
+    "versions": ["1.17", "1.18.1"]
   },
   {
     "name": "useItemWithBlockPlace",
@@ -67,7 +67,7 @@
   {
     "name": "useItemWithOwnPacket",
     "description": "use item is done with its own packet",
-    "versions": ["1.9", "1.17.1"]
+    "versions": ["1.9", "1.18.1"]
   },
   {
     "name": "blockPlaceHasHeldItem",
@@ -87,7 +87,7 @@
   {
     "name": "blockPlaceHasInsideBlock",
     "description": "block_place packet has inside block",
-    "versions": ["1.14", "1.17.1"]
+    "versions": ["1.14", "1.18.1"]
   },
   {
     "name": "teleportUsesPositionPacket",
@@ -102,7 +102,7 @@
   {
     "name": "teleportUsesOwnPacket",
     "description": "teleport is done using its own packet",
-    "versions": ["1.9", "1.17.1"]
+    "versions": ["1.9", "1.18.1"]
   },
   {
     "name": "oneBlockForSeveralVariations",
@@ -112,7 +112,7 @@
   {
     "name": "blockSchemeIsFlat",
     "description": "all variations of a packet have their own id",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "tabCompleteHasNoToolTip",
@@ -122,7 +122,7 @@
   {
     "name": "tabCompleteHasAToolTip",
     "description": "tab complete has a tool tip",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "effectAreMinecraftPrefixed",
@@ -132,7 +132,7 @@
   {
     "name": "effectAreNotPrefixed",
     "description": "effect are not prefixed",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "itemsAreAlsoBlocks",
@@ -142,12 +142,12 @@
   {
     "name": "itemsAreNotBlocks",
     "description": "items are not block",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "fishingBobberCorrectlyNamed",
     "description": "the fishing hook entity is named fishing_bobber",
-    "versions": ["1.14", "1.17.1"]
+    "versions": ["1.14", "1.18.1"]
   },
   {
     "name": "editBookIsPluginChannel",
@@ -157,7 +157,7 @@
   {
     "name": "hasEditBookPacket",
     "description": "book editing is handled through a packet",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "clientUpdateBookIdWhenSign",
@@ -197,12 +197,12 @@
   {
     "name": "dimensionIsAWorld",
     "description": "description is a world name (string)",
-    "versions": ["1.16.2", "1.17.1"]
+    "versions": ["1.16.2", "1.18.1"]
   },
   {
     "name": "dimensionDataIsAvailable",
     "description": "dimensionData is available, describing additional dimension information",
-    "versions": ["1.17", "1.17.1"]
+    "versions": ["1.17", "1.18.1"]
   },
   {
     "name": "doesntHaveChestType",
@@ -227,22 +227,22 @@
   {
     "name": "hasAttackCooldown",
     "description": "if there is a cooldown after attacks to deal full damage",
-    "versions": ["1.9", "1.17.1"]
+    "versions": ["1.9", "1.18.1"]
   },
   {
     "name": "usesLoginPacket",
     "description": "uses the login packet as defined in mcData",
-    "versions": ["1.16", "1.17.1"]
+    "versions": ["1.16", "1.18.1"]
   },
   {
     "name": "usesMultiblockSingleLong",
     "description": "in the multi_block_change packet is stored as a single number",
-    "versions": ["1.16.2", "1.17.1"]
+    "versions": ["1.16.2", "1.18.1"]
   },
   {
     "name": "usesMultiblock3DChunkCoords",
     "description": "in the multi_block_change packet, all 3 axis coords are defined",
-    "versions": ["1.16.2", "1.17.1"]
+    "versions": ["1.16.2", "1.18.1"]
   },
   {
     "name": "setBlockUsesMetadataNumber",
@@ -257,7 +257,7 @@
   {
     "name": "selectingTradeMovesItems",
     "description": "selecting a trade automatically puts the required items into trading slots",
-    "versions": ["1.14", "1.17.1"]
+    "versions": ["1.14", "1.18.1"]
   },
   {
     "name": "resourcePackUsesHash",
@@ -272,7 +272,7 @@
   {
     "name": "teamUsesChatComponents",
     "description": "teams use chatcomponents for formatting",
-    "versions": ["1.13", "1.17.1"]
+    "versions": ["1.13", "1.18.1"]
   },
   {
     "name": "teamUsesScoreboard",
@@ -287,7 +287,7 @@
   {
     "name": "enderCrystalNameNoCapsWithUnderscore",
     "description": "this is when the end_crystal's entity name is end_crystal",
-    "versions": ["1.14", "1.17.1"]
+    "versions": ["1.14", "1.18.1"]
   },
   {
     "name": "entityNameUpperCaseNoUnderscore",
@@ -307,7 +307,7 @@
   {
     "name": "stateIdUsed",
     "description": "starting in 1.17.1, actionId has been replaced with stateId",
-    "versions": ["1.17.1", "1.17.1"]
+    "versions": ["1.17.1", "1.18.1"]
   },
   {
     "name": "actionIdUsed",
@@ -317,6 +317,21 @@
   {
     "name": "setSlotAsTransaction",
     "description": "use setslot as transaction instead of just hoping it'll work",
-    "versions": ["1.17", "1.17.1"]
+    "versions": ["1.17", "1.18.1"]
+  },
+  {
+    "name": "armAnimationBeforeUse",
+    "description": "arm animation packet sent before use entity packet",
+    "versions": ["1.8", "1.8.9"]
+  },
+  {
+    "name": "tallWorld",
+    "description": "world starts at -64 and ends at 384",
+    "versions": ["1.18", "1.18.1"]
+  },
+  {
+    "name": "sendStringifiedSignText",
+    "description": "sign text send when updating signs is send as stringified strings",
+    "versions": ["1.8", "1.8.9"]
   }
 ]

package/lib/loader.js

@@ -63,7 +63,7 @@ function createBot (options = {}) {
   options.username = options.username ?? 'Player'
   options.version = options.version ?? false
   options.plugins = options.plugins ?? {}
-  options.hideErrors = options.hideErrors ?? true
+  options.hideErrors = options.hideErrors ?? false
   options.logErrors = options.logErrors ?? true
   options.loadInternalPlugins = options.loadInternalPlugins ?? true
   options.client = options.client ?? null