mineflayer 4.12.0 → 4.14.0

package/.github/workflows/ci.yml

@@ -12,10 +12,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Use Node.js 14.x
+    - name: Use Node.js 18.x
       uses: actions/setup-node@v1.4.4
       with:
-        node-version: 14.x
+        node-version: 18.x
     - run: npm i && npm run lint
 
   MinecraftServer:
@@ -46,7 +46,7 @@ jobs:
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v1.4.4
         with:
-          node-version: 14.x
+          node-version: 18.x
       - name: Setup Java JDK
         uses: actions/setup-java@v1.4.3
         with:

package/.github/workflows/npm-publish.yml

@@ -13,7 +13,7 @@ jobs:
     - name: Set up Node.js
       uses: actions/setup-node@master
       with:
-        node-version: 14.0.0
+        node-version: 18.0.0
     - id: publish
       uses: JS-DevTools/npm-publish@v1
       with:

package/.gitpod.yml

@@ -1,4 +1,2 @@
-image:
-  file: .gitpod.DockerFile
 tasks:
 - command: npm install

package/README.md

@@ -80,11 +80,11 @@ const mineflayer = require('mineflayer')
 
 const bot = mineflayer.createBot({
   host: 'localhost', // minecraft server ip
-  username: 'email@example.com', // minecraft username
+  username: 'Bot', // username or email, switch if you want to change accounts
   auth: 'microsoft' // for offline mode servers, you can set this to 'offline'
   // port: 25565,                // only set if you need a port that isn't 25565
   // version: false,             // only set if you need a specific version or snapshot (ie: "1.8.9" or "1.16.5"), otherwise it's set automatically
-  // password: '12345678'        // set if you want to use password-based auth (may be unreliable)
+  // password: '12345678'        // set if you want to use password-based auth (may be unreliable). If specified, the `username` must be an email
 })
 
 bot.on('chat', (username, message) => {
@@ -97,6 +97,26 @@ bot.on('kicked', console.log)
 bot.on('error', console.log)
 ```
 
+If `auth` is set to `microsoft`, you will be prompted to login to microsoft.com with a code in your browser. After signing in on your browser, 
+the bot will automatically obtain and cache authentication tokens in the local file system so you don't have to sign-in again. 
+To switch the account, update the supplied `username`. By default, cached tokens will be stored in your user's .minecraft folder.
+For more information on these options and others, see node-minecraft-protocol's [API doc](https://github.com/PrismarineJS/node-minecraft-protocol/blob/master/docs/API.md#mccreateclientoptions).
+
+#### Connecting to a Realm
+
+To join a Realm that your Minecraft account has been invited to, you can pass a `realms` object with a selector function like below.
+
+```js
+const client = mineflayer.createBot({
+  username: 'email@example.com', // minecraft username
+  realms: {
+    // This function is called with an array of Realms the account can join. It should return the one it wants to join.
+    pickRealm: (realms) => realms[0]
+  },
+  auth: 'microsoft'
+})
+```
+
 ### See what your bot is doing
 
 Thanks to the [prismarine-viewer](https://github.com/PrismarineJS/prismarine-viewer) project, it's possible to display in a browser window what your bot is doing.
@@ -220,6 +240,7 @@ The most updated and useful are :
  * [Chaoscraft](https://github.com/schematical/chaoscraft) - Minecraft bot using genetic algorithms, see [its youtube videos](https://www.youtube.com/playlist?list=PLLkpLgU9B5xJ7Qy4kOyBJl5J6zsDIMceH)
  * [hexatester/minetelegram](https://github.com/hexatester/minetelegram) -  Minecraft - Telegram bridge, build on top of mineflayer & telegraf.
  * [PrismarineJS/mineflayer-builder](https://github.com/PrismarineJS/mineflayer-builder) - Prints minecraft schematics in survival, keeping orientation
+ * [SilkePilon/OpenDeliveryBot](https://github.com/SilkePilon/OpenDeliveryBot) - Minecraft bot in python to deliver items from place to place.
  * [and hundreds more](https://github.com/PrismarineJS/mineflayer/network/dependents) - All the projects that github detected are using mineflayer
 
 

package/docs/README.md

@@ -80,11 +80,11 @@ const mineflayer = require('mineflayer')
 
 const bot = mineflayer.createBot({
   host: 'localhost', // minecraft server ip
-  username: 'email@example.com', // minecraft username
+  username: 'Bot', // username or email, switch if you want to change accounts
   auth: 'microsoft' // for offline mode servers, you can set this to 'offline'
   // port: 25565,                // only set if you need a port that isn't 25565
   // version: false,             // only set if you need a specific version or snapshot (ie: "1.8.9" or "1.16.5"), otherwise it's set automatically
-  // password: '12345678'        // set if you want to use password-based auth (may be unreliable)
+  // password: '12345678'        // set if you want to use password-based auth (may be unreliable). If specified, the `username` must be an email
 })
 
 bot.on('chat', (username, message) => {
@@ -97,6 +97,26 @@ bot.on('kicked', console.log)
 bot.on('error', console.log)
 ```
 
+If `auth` is set to `microsoft`, you will be prompted to login to microsoft.com with a code in your browser. After signing in on your browser, 
+the bot will automatically obtain and cache authentication tokens in the local file system so you don't have to sign-in again. 
+To switch the account, update the supplied `username`. By default, cached tokens will be stored in your user's .minecraft folder.
+For more information on these options and others, see node-minecraft-protocol's [API doc](https://github.com/PrismarineJS/node-minecraft-protocol/blob/master/docs/API.md#mccreateclientoptions).
+
+#### Connecting to a Realm
+
+To join a Realm that your Minecraft account has been invited to, you can pass a `realms` object with a selector function like below.
+
+```js
+const client = mineflayer.createBot({
+  username: 'email@example.com', // minecraft username
+  realms: {
+    // This function is called with an array of Realms the account can join. It should return the one it wants to join.
+    pickRealm: (realms) => realms[0]
+  },
+  auth: 'microsoft'
+})
+```
+
 ### See what your bot is doing
 
 Thanks to the [prismarine-viewer](https://github.com/PrismarineJS/prismarine-viewer) project, it's possible to display in a browser window what your bot is doing.
@@ -220,6 +240,7 @@ The most updated and useful are :
  * [Chaoscraft](https://github.com/schematical/chaoscraft) - Minecraft bot using genetic algorithms, see [its youtube videos](https://www.youtube.com/playlist?list=PLLkpLgU9B5xJ7Qy4kOyBJl5J6zsDIMceH)
  * [hexatester/minetelegram](https://github.com/hexatester/minetelegram) -  Minecraft - Telegram bridge, build on top of mineflayer & telegraf.
  * [PrismarineJS/mineflayer-builder](https://github.com/PrismarineJS/mineflayer-builder) - Prints minecraft schematics in survival, keeping orientation
+ * [SilkePilon/OpenDeliveryBot](https://github.com/SilkePilon/OpenDeliveryBot) - Minecraft bot in python to deliver items from place to place.
  * [and hundreds more](https://github.com/PrismarineJS/mineflayer/network/dependents) - All the projects that github detected are using mineflayer
 
 

package/docs/api.md

@@ -136,6 +136,7 @@
       - [bot.foodSaturation](#botfoodsaturation)
       - [bot.oxygenLevel](#botoxygenlevel)
       - [bot.physics](#botphysics)
+      - [bot.fireworkRocketDuration](#botfireworkrocketduration)
       - [bot.simpleClick.leftMouse (slot)](#botsimpleclickleftmouse-slot)
       - [bot.simpleClick.rightMouse (slot)](#botsimpleclickrightmouse-slot)
       - [bot.time.doDaylightCycle](#bottimedodaylightcycle)
@@ -197,6 +198,7 @@
       - ["entityEquip" (entity)](#entityequip-entity)
       - ["entitySleep" (entity)](#entitysleep-entity)
       - ["entitySpawn" (entity)](#entityspawn-entity)
+      - ["entityElytraFlew" (entity)](#entityelytraflew-entity)
       - ["itemDrop" (entity)](#itemdrop-entity)
       - ["playerCollect" (collector, collected)](#playercollect-collector-collected)
       - ["entityGone" (entity)](#entitygone-entity)
@@ -223,6 +225,7 @@
       - ["blockBreakProgressEnd" (block, entity)](#blockbreakprogressend-block-entity)
       - ["diggingCompleted" (block)](#diggingcompleted-block)
       - ["diggingAborted" (block)](#diggingaborted-block)
+      - ["usedFirework"](#usedfirework)
       - ["move"](#move)
       - ["forcedMove"](#forcedmove)
       - ["mount"](#mount)
@@ -293,6 +296,7 @@
       - [bot.unequip(destination)](#botunequipdestination)
       - [bot.tossStack(item)](#bottossstackitem)
       - [bot.toss(itemType, metadata, count)](#bottossitemtype-metadata-count)
+      - [bot.elytraFly()](#botelytrafly)
       - [bot.dig(block, [forceLook = true], [digFace])](#botdigblock-forcelook--true-digface)
       - [bot.stopDigging()](#botstopdigging)
       - [bot.digTime(block)](#botdigtimeblock)
@@ -1037,6 +1041,10 @@ Number in the range [0, 20] respresenting the number of water-icons known as oxy
 Edit these numbers to tweak gravity, jump speed, terminal velocity, etc.
 Do this at your own risk.
 
+#### bot.fireworkRocketDuration
+
+How many physics ticks worth of firework rocket boost are left.
+
 #### bot.simpleClick.leftMouse (slot)
 
 abstraction over `bot.clickWindow(slot, 0, 0)`
@@ -1301,6 +1309,10 @@ Fires when an attribute of an entity changes.
 #### "entityEquip" (entity)
 #### "entitySleep" (entity)
 #### "entitySpawn" (entity)
+#### "entityElytraFlew" (entity)
+
+An entity started elytra flying.
+
 #### "itemDrop" (entity)
 #### "playerCollect" (collector, collected)
 
@@ -1417,6 +1429,10 @@ This occurs whether the process was completed or aborted.
 
  * `block` - the block that still exists
 
+#### "usedfirework"
+
+Fires when the bot uses a firework while elytra flying.
+
 #### "move"
 
 Fires when the bot moves. If you want the current position, use
@@ -1851,6 +1867,11 @@ This function returns a `Promise`, with `void` as its argument once tossing is c
    to match any metadata
  * `count` - how many you want to toss. `null` is an alias for `1`.
 
+#### bot.elytraFly()
+
+This function returns a `Promise`, with `void` as its argument once activating
+elytra flight is complete. It will throw an Error if it fails.
+
 #### bot.dig(block, [forceLook = true], [digFace])
 
 This function returns a `Promise`, with `void` as its argument when the block is broken or you are interrupted.
@@ -1946,7 +1967,9 @@ Use fishing rod
 
 #### bot.activateItem(offHand=false)
 
-Activates the currently held item. This is how you eat, shoot bows, throw an egg, etc.
+Activates the currently held item. This is how you eat, shoot bows, throw an
+egg, activate firework rockets, etc.
+
 Optional parameter is `false` for main hand and `true` for off hand.
 
 #### bot.deactivateItem()

package/docs/history.md

@@ -1,3 +1,15 @@
+## 4.14.0
+* [Update Jupyter notebook to install node 18, update the server in example (#3176)](https://github.com/PrismarineJS/mineflayer/commit/e8a967d4e832f72d665781492c037d26169ae5a0) (thanks @extremeheat)
+* [Update index.d.ts (#3175)](https://github.com/PrismarineJS/mineflayer/commit/d4db3991c135344180937b69621c0ee31daa39f0) (thanks @StayWithMeSenpai)
+* [Add elytra flying support and rocket support (#3163)](https://github.com/PrismarineJS/mineflayer/commit/010460e9dd752a56195d8a48f35a62e704dcf99f) (thanks @lkwilson)
+
+## 4.13.0
+* [Switch to entity.displayName (#3168)](https://github.com/PrismarineJS/mineflayer/commit/2409ad458b952173de669a7d9cfaeb770effe3ae) (thanks @lkwilson)
+* [Update readme auth doc (#3169)](https://github.com/PrismarineJS/mineflayer/commit/f5d4a288a768ca6717fa4d22c72fb0267428c684) (thanks @extremeheat)
+* [Add OpenDeliveryBot to "Projects Using Mineflayer" (#3162)](https://github.com/PrismarineJS/mineflayer/commit/ab3c0cf25d0cc28ccba89640b2ceff6ab6b4dace) (thanks @SilkePilon)
+* [Use node 18 on CI (#3157)](https://github.com/PrismarineJS/mineflayer/commit/d3df34dcaa804a71bf0d8cc50a419990d4a2dce3) (thanks @extremeheat)
+* [Fix ambigious function naming (#3161)](https://github.com/PrismarineJS/mineflayer/commit/9ecdf201794bfa350486839a01e318dfd94b3bfb) (thanks @frej4189)
+
 ## 4.12.0
 * [Mineflayer physics refactor (#2492)](https://github.com/PrismarineJS/mineflayer/commit/d0eb3a1afe6cda7b04ae2f88052cd868ba0c0c4f) (thanks @U5B)
 

package/docs/mineflayer.ipynb

@@ -36,7 +36,7 @@
       "source": [
         "# Using mineflayer in Python\n",
         "\n",
-        "This is a tutorial on how to use mineflayer in Python. This example will connect you to the PrismarineJS test server. You can join it with prismarine-viewer or your Minecraft client at server IP **95.111.249.143:10000**.\n",
+        "This is a tutorial on how to use mineflayer in Python. This example will connect you to the PrismarineJS test server. You can join it with prismarine-viewer or your Minecraft client at server IP **pjs.deptofcraft.com:25565**.\n",
         "\n",
         "If you're new to Jupyter Notebooks, you can press the \"Play\" button at the left of each code block to run it. Make sure that you run the blocks in a correct order."
       ]
@@ -56,32 +56,35 @@
         "id": "K2ol06QOhL6s"
       },
       "source": [
-        "First, make sure you have Python version 3.7 and Node.js version 14 or newer installed"
+        "First, make sure you have Python version 3.10 and Node.js version 18 or newer installed. You can get Node.js 18 it from https://nodejs.org/en/download or use [Node.js version managers](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-version-manager-to-install-nodejs-and-npm) like [`nvm`](https://github.com/creationix/nvm) or [`n`](https://github.com/tj/n) to install via the command line. Here we'll use `n` to install Node.js v18, then check our Node and Python versions:"
       ]
     },
     {
       "cell_type": "code",
+      "execution_count": 1,
       "metadata": {
         "colab": {
           "base_uri": "https://localhost:8080/"
         },
         "id": "8zCSpx8Bif5m",
-        "outputId": "f8888a33-03e7-4497-9776-ef6c34d9d337"
+        "outputId": "90ebac14-fc75-4136-f81d-34c5b2033da0"
       },
-      "source": [
-        "!python --version\n",
-        "!node --version"
-      ],
-      "execution_count": null,
       "outputs": [
         {
+          "name": "stdout",
           "output_type": "stream",
           "text": [
-            "Python 3.7.11\n",
-            "v14.16.0\n"
-          ],
-          "name": "stdout"
+            "v18.17.1\n",
+            "Python 3.10.12\n"
+          ]
         }
+      ],
+      "source": [
+        "# Use `n` to install nodejs 18, if it's not already installed:\n",
+        "!curl -fsSL https://raw.githubusercontent.com/tj/n/master/bin/n | bash -s lts > /dev/null\n",
+        "# Now write the Node.js and Python version to the console\n",
+        "!node --version\n",
+        "!python --version"
       ]
     },
     {
@@ -121,7 +124,7 @@
       "source": [
         "If all is well, we can import the `javascript` library. We can then import the `require` function which works similarly to the `require` function in Node.js, but does the dependency management for us.\n",
         "\n",
-        "You may notice the extra imports : On, Once, off and AsyncTask. These will be discussed later on. \n",
+        "You may notice the extra imports : On, Once, off and AsyncTask. These will be discussed later on.\n",
         "\n",
         "\n"
       ]
@@ -170,21 +173,21 @@
     },
     {
       "cell_type": "code",
+      "execution_count": null,
       "metadata": {
         "id": "1gfZSAUCDVMg"
       },
+      "outputs": [],
       "source": [
         "random_number = id([]) % 1000 # Give us a random number upto 1000\n",
         "BOT_USERNAME = f'colab_{random_number}'\n",
         "\n",
-        "bot = mineflayer.createBot({ 'host': '95.111.249.143', 'port': 10000, 'username': BOT_USERNAME, 'hideErrors': False })\n",
+        "bot = mineflayer.createBot({ 'host': 'pjs.deptofcraft.com', 'port': 25565, 'username': BOT_USERNAME, 'hideErrors': False })\n",
         "\n",
-        "# The spawn event \n",
+        "# The spawn event\n",
         "once(bot, 'login')\n",
         "bot.chat('I spawned')"
-      ],
-      "execution_count": null,
-      "outputs": []
+      ]
     },
     {
       "cell_type": "markdown",

package/examples/armor_stand.js

@@ -26,7 +26,7 @@ bot.on('chat', async (username, message) => {
   const [mainCommand, subCommand] = message.split(' ')
   if (mainCommand !== 'equip' && mainCommand !== 'unequip') return
 
-  const armorStand = bot.nearestEntity(e => e.mobType === 'Armor Stand' && bot.entity.position.distanceTo(e.position) < 4)
+  const armorStand = bot.nearestEntity(e => e.displayName === 'Armor Stand' && bot.entity.position.distanceTo(e.position) < 4)
   if (!armorStand) {
     bot.chat('No armor stands nearby!')
     return

package/examples/chatterbox.js

@@ -176,11 +176,11 @@ bot.on('playerCollect', (collector, collected) => {
 
 bot.on('entitySpawn', (entity) => {
   if (entity.type === 'mob') {
-    console.log(`Look out! A ${entity.mobType} spawned at ${entity.position}`)
+    console.log(`Look out! A ${entity.displayName} spawned at ${entity.position}`)
   } else if (entity.type === 'player') {
     bot.chat(`Look who decided to show up: ${entity.username}`)
   } else if (entity.type === 'object') {
-    console.log(`There's a ${entity.objectType} at ${entity.position}`)
+    console.log(`There's a ${entity.displayName} at ${entity.position}`)
   } else if (entity.type === 'global') {
     bot.chat('Ooh lightning!')
   } else if (entity.type === 'orb') {
@@ -189,7 +189,7 @@ bot.on('entitySpawn', (entity) => {
 })
 bot.on('entityHurt', (entity) => {
   if (entity.type === 'mob') {
-    bot.chat(`Haha! The ${entity.mobType} got hurt!`)
+    bot.chat(`Haha! The ${entity.displayName} got hurt!`)
   } else if (entity.type === 'player') {
     bot.chat(`Aww, poor ${entity.username} got hurt. Maybe you shouldn't have a ping of ${bot.players[entity.username].ping}`)
   }
@@ -214,12 +214,12 @@ bot.on('entityEat', (entity) => {
 })
 bot.on('entityAttach', (entity, vehicle) => {
   if (entity.type === 'player' && vehicle.type === 'object') {
-    bot.chat(`Sweet, ${entity.username} is riding that ${vehicle.objectType}`)
+    bot.chat(`Sweet, ${entity.username} is riding that ${vehicle.displayName}`)
   }
 })
 bot.on('entityDetach', (entity, vehicle) => {
   if (entity.type === 'player' && vehicle.type === 'object') {
-    bot.chat(`Lame, ${entity.username} stopped riding the ${vehicle.objectType}`)
+    bot.chat(`Lame, ${entity.username} stopped riding the ${vehicle.displayName}`)
   }
 })
 bot.on('entityEquipmentChange', (entity) => {

package/examples/elytra.js

@@ -0,0 +1,66 @@
+// This example will shoot the player that said "fire" in chat, when it is said in chat.
+const mineflayer = require('mineflayer')
+
+if (process.argv.length < 4 || process.argv.length > 6) {
+  console.log('Usage : node elytra.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] : 'elytraer',
+  password: process.argv[5]
+})
+
+bot.on('error', err => {
+  console.log(err)
+})
+
+bot.on('kicked', err => {
+  console.log(err)
+})
+
+bot.on('spawn', async function () {
+  bot.chat(`/give ${bot.username} minecraft:elytra`)
+  bot.chat(`/give ${bot.username} minecraft:firework_rocket 64`)
+
+  await sleep(1000)
+  const elytraItem = bot.inventory.slots.find(item => item?.name === 'elytra')
+  if (elytraItem == null) {
+    console.log('no elytra')
+    return
+  }
+  await bot.equip(elytraItem, 'torso')
+  const fireworkItem = bot.inventory.slots.find(item => item?.name === 'firework_rocket')
+  if (fireworkItem == null) {
+    console.log('no fireworks')
+    return
+  }
+  await bot.equip(fireworkItem, 'hand')
+})
+
+bot.on('chat', async (username, message) => {
+  if (message === 'fly') {
+    await bot.look(bot.entity.yaw, 50 * Math.PI / 180)
+    bot.setControlState('jump', true)
+    bot.setControlState('jump', false)
+    await sleep(50)
+
+    // try to fly
+    try {
+      await bot.elytraFly()
+    } catch (err) {
+      bot.chat(`Failed to fly: ${err}`)
+      return
+    }
+    await sleep(50)
+
+    // use rocket
+    bot.activateItem()
+  }
+})
+
+function sleep (ms) {
+  return new Promise(resolve => setTimeout(resolve, ms))
+}

package/examples/guard.js

@@ -59,7 +59,7 @@ bot.on('physicsTick', () => {
 
   // Only look for mobs within 16 blocks
   const filter = e => e.type === 'mob' && e.position.distanceTo(bot.entity.position) < 16 &&
-                    e.mobType !== 'Armor Stand' // Mojang classifies armor stands as mobs for some reason?
+                    e.displayName !== 'Armor Stand' // Mojang classifies armor stands as mobs for some reason?
 
   const entity = bot.nearestEntity(filter)
   if (entity) {

package/examples/jumper.js

@@ -108,9 +108,9 @@ bot.once('spawn', () => {
 })
 
 bot.on('mount', () => {
-  bot.chat(`mounted ${bot.vehicle.objectType}`)
+  bot.chat(`mounted ${bot.vehicle.displayName}`)
 })
 
 bot.on('dismount', (vehicle) => {
-  bot.chat(`dismounted ${vehicle.objectType}`)
+  bot.chat(`dismounted ${vehicle.displayName}`)
 })

package/examples/python/chatterbox.py

@@ -224,12 +224,12 @@ def playerCollect(this, collector, collected):
 def entitySpawn(this, entity):
     if entity.type == "mob":
         p = entity.position
-        console.log(f"Look out! A {entity.mobType} spawned at {p.toString()}")
+        console.log(f"Look out! A {entity.displayName} spawned at {p.toString()}")
     elif entity.type == "player":
         bot.chat(f"Look who decided to show up: {entity.username}")
     elif entity.type == "object":
         p = entity.position
-        console.log(f"There's a {entity.objectType} at {p.toString()}")
+        console.log(f"There's a {entity.displayName} at {p.toString()}")
     elif entity.type == "global":
         bot.chat("Ooh lightning!")
     elif entity.type == "orb":
@@ -239,7 +239,7 @@ def entitySpawn(this, entity):
 @On(bot, "entityHurt")
 def entityHurt(this, entity):
     if entity.type == "mob":
-        bot.chat(f"Haha! The ${entity.mobType} got hurt!")
+        bot.chat(f"Haha! The ${entity.displayName} got hurt!")
     elif entity.type == "player":
         if entity.username in bot.players:
             ping = bot.players[entity.username].ping
@@ -279,13 +279,13 @@ def entityEat(this, entity):
 @On(bot, "entityAttach")
 def entityAttach(this, entity, vehicle):
     if entity.type == "player" and vehicle.type == "object":
-        print(f"Sweet, {entity.username} is riding that {vehicle.objectType}")
+        print(f"Sweet, {entity.username} is riding that {vehicle.displayName}")
 
 
 @On(bot, "entityDetach")
 def entityDetach(this, entity, vehicle):
     if entity.type == "player" and vehicle.type == "object":
-        print(f"Lame, {entity.username} stopped riding the {vehicle.objectType}")
+        print(f"Lame, {entity.username} stopped riding the {vehicle.displayName}")
 
 
 @On(bot, "entityEquipmentChange")

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 { world } from 'prismarine-world'
 import { Registry } from 'prismarine-registry'
 
 export function createBot (options: { client: Client } & Partial<BotOptions>): Bot
@@ -92,6 +93,8 @@ export interface BotEvents {
   entityEquip: (entity: Entity) => Promise<void> | void
   entitySleep: (entity: Entity) => Promise<void> | void
   entitySpawn: (entity: Entity) => Promise<void> | void
+  entityElytraFlew: (entity: Entity) => Promise<void> | void
+  usedFirework: () => Promise<void> | void
   itemDrop: (entity: Entity) => Promise<void> | void
   playerCollect: (collector: Entity, collected: Entity) => Promise<void> | void
   entityAttributes: (entity: Entity) => Promise<void> | void
@@ -164,6 +167,7 @@ export interface Bot extends TypedEmitter<BotEvents> {
   version: string
   entity: Entity
   entities: { [id: string]: Entity }
+  fireworkRocketDuration: number
   spawnPoint: Vec3
   game: GameState
   player: Player
@@ -189,7 +193,7 @@ export interface Bot extends TypedEmitter<BotEvents> {
   teamMap: { [name: string]: Team }
   controlState: ControlStateStatus
   creative: creativeMethods
-  world: any
+  world: world.World
   _client: Client
   heldItem: Item | null
   usingHeldItem: boolean
@@ -260,6 +264,8 @@ export interface Bot extends TypedEmitter<BotEvents> {
 
   wake: () => Promise<void>
 
+  elytraFly: () => Promise<void>
+
   setControlState: (control: ControlState, state: boolean) => void
 
   getControlState: (control: ControlState) => boolean

package/index.js

@@ -1,6 +1,6 @@
-if (typeof process !== 'undefined' && parseInt(process.versions.node.split('.')[0]) < 14) {
+if (typeof process !== 'undefined' && parseInt(process.versions.node.split('.')[0]) < 18) {
   console.error('Your node version is currently', process.versions.node)
-  console.error('Please update it to a version >= 14.x.x from https://nodejs.org/')
+  console.error('Please update it to a version >= 18.x.x from https://nodejs.org/')
   process.exit(1)
 }
 

package/lib/plugins/entities.js

@@ -176,8 +176,6 @@ function inject (bot) {
       entityData = entitiesArray.find(entity => entity.internalId === type)
     }
     if (entityData) {
-      entity.mobType = entityData.displayName
-      entity.objectType = entityData.displayName
       entity.displayName = entityData.displayName
       entity.entityType = entityData.id
       entity.name = entityData.name
@@ -188,7 +186,6 @@ function inject (bot) {
       // unknown entity
       entity.type = 'other'
       entity.entityType = type
-      entity.mobType = 'unknown'
       entity.displayName = 'unknown'
       entity.name = 'unknown'
       entity.kind = 'unknown'
@@ -361,6 +358,70 @@ function inject (bot) {
     }
   })
 
+  bot.fireworkRocketDuration = 0
+  function setElytraFlyingState (entity, elytraFlying) {
+    let startedFlying = false
+    if (elytraFlying) {
+      startedFlying = !entity.elytraFlying
+      entity.elytraFlying = true
+    } else if (entity.elytraFlying) {
+      entity.elytraFlying = false
+    }
+    if (bot.fireworkRocketDuration !== 0 && entity.id === bot.entity?.id && !elytraFlying) {
+      bot.fireworkRocketDuration = 0
+      knownFireworks.splice(0, knownFireworks.length)
+    }
+
+    if (startedFlying) {
+      bot.emit('entityElytraFlew', entity)
+    }
+  }
+
+  const knownFireworks = []
+  function handleBotUsedFireworkRocket (fireworkEntityId, fireworkInfo) {
+    if (knownFireworks.includes(fireworkEntityId)) return
+    knownFireworks.push(fireworkEntityId)
+    let flightDur = 1
+    if (fireworkInfo?.nbtData != null) {
+      let nbt = fireworkInfo.nbtData
+      if (nbt.type === 'compound' && nbt.value.Fireworks != null) {
+        nbt = nbt.value.Fireworks
+        if (nbt.type === 'compound' && nbt.value.Flight != null) {
+          nbt = nbt.value.Flight
+          if (nbt.type === 'int') {
+            flightDur += nbt.value
+          }
+        }
+      }
+    }
+    const baseDuration = 10 * flightDur
+    const randomDuration = Math.floor(Math.random() * 6) + Math.floor(Math.random() * 7)
+    bot.fireworkRocketDuration = baseDuration + randomDuration
+
+    bot.emit('usedFirework')
+  }
+
+  let fireworkEntityName
+  if (bot.supportFeature('fireworkNamePlural')) {
+    fireworkEntityName = 'fireworks_rocket'
+  } else if (bot.supportFeature('fireworkNameSingular')) {
+    fireworkEntityName = 'firework_rocket'
+  }
+
+  let fireworkMetadataIdx
+  let fireworkMetadataIsOpt
+  if (bot.supportFeature('fireworkMetadataVarInt7')) {
+    fireworkMetadataIdx = 7
+    fireworkMetadataIsOpt = false
+  } else if (bot.supportFeature('fireworkMetadataOptVarInt8')) {
+    fireworkMetadataIdx = 8
+    fireworkMetadataIsOpt = true
+  } else if (bot.supportFeature('fireworkMetadataOptVarInt9')) {
+    fireworkMetadataIdx = 9
+    fireworkMetadataIsOpt = true
+  }
+  const hasFireworkSupport = fireworkEntityName !== undefined && fireworkMetadataIdx !== undefined && fireworkMetadataIsOpt !== undefined
+
   bot._client.on('entity_metadata', (packet) => {
     // entity metadata
     const entity = fetchEntity(packet.entityId)
@@ -377,7 +438,25 @@ function inject (bot) {
       if (metas.sleeping_pos || metas.pose === 2) {
         bot.emit('entitySleep', entity)
       }
+
+      if (hasFireworkSupport && fireworkEntityName === entity.name && metas.attached_to_target !== undefined) {
+        // fireworkMetadataOptVarInt9 and later is implied by
+        // mcDataHasEntityMetadata, so no need to check metadata index and type
+        // (eg fireworkMetadataOptVarInt8)
+        if (metas.attached_to_target !== 0) {
+          const entityId = metas.attached_to_target - 1
+          if (entityId === bot.entity?.id) {
+            handleBotUsedFireworkRocket(entity.id, metas.fireworks_item)
+          }
+        }
+      }
+
       if (metas.shared_flags != null) {
+        if (bot.supportFeature('hasElytraFlying')) {
+          const elytraFlying = metas.shared_flags & 0x80
+          setElytraFlyingState(entity, Boolean(elytraFlying))
+        }
+
         if (metas.shared_flags & 2) {
           entity.crouching = true
           bot.emit('entityCrouch', entity)
@@ -399,16 +478,38 @@ function inject (bot) {
         bot.emit('entitySleep', entity)
       }
 
-      const bitField = packet.metadata.find(p => p.key === 0)
-      if (bitField === undefined) {
-        return
+      if (hasFireworkSupport && fireworkEntityName === entity.name) {
+        const attachedToTarget = packet.metadata.find(e => e.key === fireworkMetadataIdx)
+        if (attachedToTarget !== undefined) {
+          let entityId
+          if (fireworkMetadataIsOpt) {
+            if (attachedToTarget.value !== 0) {
+              entityId = attachedToTarget.value - 1
+            } // else, not attached to an entity
+          } else {
+            entityId = attachedToTarget.value
+          }
+          if (entityId !== undefined && entityId === bot.entity?.id) {
+            const fireworksItem = packet.metadata.find(e => e.key === (fireworkMetadataIdx - 1))
+            handleBotUsedFireworkRocket(entity.id, fireworksItem?.value)
+          }
+        }
       }
-      if ((bitField.value & 2) !== 0) {
-        entity.crouching = true
-        bot.emit('entityCrouch', entity)
-      } else if (entity.crouching) { // prevent the initial entity_metadata packet from firing off an uncrouch event
-        entity.crouching = false
-        bot.emit('entityUncrouch', entity)
+
+      const bitField = packet.metadata.find(p => p.key === 0)
+      if (bitField !== undefined) {
+        if (bot.supportFeature('hasElytraFlying')) {
+          const elytraFlying = bitField.value & 0x80
+          setElytraFlyingState(entity, Boolean(elytraFlying))
+        }
+
+        if ((bitField.value & 2) !== 0) {
+          entity.crouching = true
+          bot.emit('entityCrouch', entity)
+        } else if (entity.crouching) { // prevent the initial entity_metadata packet from firing off an uncrouch event
+          entity.crouching = false
+          bot.emit('entityUncrouch', entity)
+        }
       }
     }
   })

package/lib/plugins/physics.js

@@ -138,8 +138,8 @@ function inject (bot, { physicsEnabled, maxCatchupTicks }) {
     return dYaw
   }
 
-  // returns false if packet should be sent, true if not
-  function sendPositionPacketInDeath () {
+  // returns false if bot should send position packets
+  function isEntityRemoved () {
     if (bot.isAlive === true) deadTicks = 0
     if (bot.isAlive === false && deadTicks <= 20) deadTicks++
     if (deadTicks >= 20) return true
@@ -148,7 +148,7 @@ function inject (bot, { physicsEnabled, maxCatchupTicks }) {
 
   function updatePosition (now) {
     // Only send updates for 20 ticks after death
-    if (sendPositionPacketInDeath()) return
+    if (isEntityRemoved()) return
 
     // Increment the yaw in baby steps so that notchian clients (not the server) can keep up.
     const dYaw = deltaYaw(bot.entity.yaw, lastSentYaw)
@@ -192,6 +192,44 @@ function inject (bot, { physicsEnabled, maxCatchupTicks }) {
 
   bot.physics = physics
 
+  function getEffectLevel (mcData, effectName, effects) {
+    const effectDescriptor = mcData.effectsByName[effectName]
+    if (!effectDescriptor) {
+      return 0
+    }
+    const effectInfo = effects[effectDescriptor.id]
+    if (!effectInfo) {
+      return 0
+    }
+    return effectInfo.amplifier + 1
+  }
+
+  bot.elytraFly = async () => {
+    if (bot.entity.elytraFlying) {
+      throw new Error('Already elytra flying')
+    } else if (bot.entity.onGround) {
+      throw new Error('Unable to fly from ground')
+    } else if (bot.entity.isInWater) {
+      throw new Error('Unable to elytra fly while in water')
+    }
+
+    const mcData = require('minecraft-data')(bot.version)
+    if (getEffectLevel(mcData, 'Levitation', bot.entity.effects) > 0) {
+      throw new Error('Unable to elytra fly with levitation effect')
+    }
+
+    const torsoSlot = bot.getEquipmentDestSlot('torso')
+    const item = bot.inventory.slots[torsoSlot]
+    if (item == null || item.name !== 'elytra') {
+      throw new Error('Elytra must be equip to start flying')
+    }
+    bot._client.write('entity_action', {
+      entityId: bot.entity.id,
+      actionId: 8,
+      jumpBoost: 0
+    })
+  }
+
   bot.setControlState = (control, state) => {
     assert.ok(control in controlState, `invalid control: ${control}`)
     assert.ok(typeof state === 'boolean', `invalid state: ${state}`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mineflayer",
-  "version": "4.12.0",
+  "version": "4.14.0",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",
@@ -21,16 +21,16 @@
   },
   "license": "MIT",
   "dependencies": {
-    "minecraft-data": "^3.37.0",
+    "minecraft-data": "^3.44.0",
     "minecraft-protocol": "^1.44.0",
     "prismarine-biome": "^1.1.1",
     "prismarine-block": "^1.17.0",
     "prismarine-chat": "^1.7.1",
     "prismarine-chunk": "^1.34.0",
-    "prismarine-entity": "^2.2.0",
+    "prismarine-entity": "^2.3.0",
     "prismarine-item": "^1.14.0",
     "prismarine-nbt": "^2.0.0",
-    "prismarine-physics": "^1.7.0",
+    "prismarine-physics": "^1.8.0",
     "prismarine-recipe": "^1.3.0",
     "prismarine-registry": "^1.5.0",
     "prismarine-windows": "^2.8.0",

package/.gitpod.DockerFile

@@ -1,11 +0,0 @@
-FROM gitpod/workspace-full:latest
-
-RUN bash -c ". /home/gitpod/.sdkman/bin/sdkman-init.sh \
-             && sdk install java"
-
-RUN bash -c ". .nvm/nvm.sh \
-    && nvm install 14 \
-    && nvm use 14 \
-    && nvm alias default 14"
-
-RUN echo "nvm use default &>/dev/null" >> ~/.bashrc.d/51-nvm-fix