mineflayer 4.31.0 → 4.33.0

package/.github/helper/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "gh-helpers": "^1.0.0"
+  }
+}

package/.github/helper/updator.js

@@ -0,0 +1,85 @@
+#!/usr/bin/env node
+/**
+ * Updator script triggered from minecraft-data repository to auto generate PR
+ */
+const fs = require('fs')
+const cp = require('child_process')
+const assert = require('assert')
+const github = require('gh-helpers')()
+const { join } = require('path')
+const exec = (cmd) => github.mock ? console.log('> ', cmd) : (console.log('> ', cmd), cp.execSync(cmd, { stdio: 'inherit' }))
+
+console.log('Starting update process...')
+// Sanitize and validate environment variables all non alpha numeric / underscore / dot
+const newVersion = process.env.NEW_MC_VERSION?.replace(/[^a-zA-Z0-9_.]/g, '_')
+const triggerBranch = process.env.MCDATA_BRANCH?.replace(/[^a-zA-Z0-9_.]/g, '_')
+const mcdataPrURL = process.env.MCDATA_PR_URL
+console.log({ newVersion, triggerBranch, mcdataPrURL })
+
+assert(newVersion)
+assert(triggerBranch)
+
+async function main () {
+  const currentSupportedPath = require.resolve('../../lib/version.js')
+  const readmePath = join(__dirname, '../../docs/README.md')
+  const ciPath = join(__dirname, '../../.github/workflows/ci.yml')
+
+  // Update the version.js
+  const currentSupportedVersion = require('../../lib/version.js')
+  const currentContents = fs.readFileSync(currentSupportedPath, 'utf8')
+  console.log('Current supported version:', currentContents)
+  const latestV = currentSupportedVersion.testedVersions.at(-1)
+  const newContents = currentContents.includes(newVersion)
+    ? currentContents
+    : currentContents
+      .replace(`, '${latestV}'`, `, '${latestV}', '${newVersion}'`)
+
+  // Update the README.md
+  const currentContentsReadme = fs.readFileSync(readmePath, 'utf8')
+  if (!currentContentsReadme.includes(newVersion)) {
+    const newReadmeContents = currentContentsReadme
+      .replace(/Minecraft 1\.8 to [0-9A-Za-z._-]+ \(/, `Minecraft 1.8 to ${newVersion} (`)
+      .replace(') <!--version-->', `, ${newVersion}) <!--version-->`)
+    fs.writeFileSync(readmePath, newReadmeContents)
+    console.log('Updated README with new version:', newVersion)
+  }
+  fs.writeFileSync(currentSupportedPath, newContents)
+
+  // Update the CI workflow
+  const currentContentsCI = fs.readFileSync(ciPath, 'utf8')
+  if (!currentContentsCI.includes(newVersion)) {
+    const newCIContents = currentContentsCI.replace(
+      'run: npm install', `run: npm install
+      - run: cd node_modules && cd minecraft-data && mv minecraft-data minecraft-data-old && git clone -b ${triggerBranch} https://github.com/PrismarineJS/minecraft-data --depth 1 && node bin/generate_data.js
+      - run: curl -o node_modules/protodef/src/serializer.js https://raw.githubusercontent.com/extremeheat/node-protodef/refs/heads/dlog/src/serializer.js && curl -o node_modules/protodef/src/compiler.js https://raw.githubusercontent.com/extremeheat/node-protodef/refs/heads/dlog/src/compiler.js
+`)
+    fs.writeFileSync(ciPath, newCIContents)
+    console.log('Updated CI workflow with new version:', newVersion)
+  }
+
+  const branchName = 'pc' + newVersion.replace(/[^a-zA-Z0-9_]/g, '_')
+  exec(`git checkout -b ${branchName}`)
+  exec('git config user.name "github-actions[bot]"')
+  exec('git config user.email "41898282+github-actions[bot]@users.noreply.github.com"')
+  exec('git add --all')
+  exec(`git commit -m "Update to version ${newVersion}"`)
+  exec(`git push origin ${branchName} --force`)
+  //     createPullRequest(title: string, body: string, fromBranch: string, intoBranch?: string): Promise<{ number: number, url: string }>;
+  const pr = await github.createPullRequest(
+    `🎈 ${newVersion}`,
+    `This automated PR sets up the relevant boilerplate for Minecraft version ${newVersion}.
+
+Ref: ${mcdataPrURL}
+
+* You can help contribute to this PR by opening a PR against this <code branch>${branchName}</code> branch instead of <code>master</code>.
+    `,
+    branchName,
+    'master'
+  )
+  console.log(`Pull request created`, pr)
+}
+
+main().catch(err => {
+  console.error('Error during update process:', err)
+  process.exit(1)
+})

package/.github/workflows/handle-update.yml

@@ -0,0 +1,54 @@
+name: Update from minecraft-data
+
+on:
+  workflow_dispatch:
+    inputs:
+      new_mc_version:
+        description: New minecraft version number
+        required: true
+        type: string
+      mcdata_branch:
+        description: minecraft-data branch for this version
+        required: true
+        type: string
+      mcdata_pr_url:
+        description: minecraft-data PR number to open a PR here against
+        required: false
+        default: ''
+        type: string
+      nmp_branch:
+        description: minecraft-protocol branch for this version
+        required: true
+        type: string
+      nmp_pr_url:
+        description: minecraft-protocol PR number to open a PR here against
+        required: false
+        default: ''
+        type: string
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        token: ${{ secrets.PAT_PASSWORD }}
+
+    - name: Use Node.js 22.x
+      uses: actions/setup-node@v1.4.4
+      with:
+        node-version: 22.x
+
+    - run: npm install PrismarineJS/node-minecraft-protocol#${{ github.event.inputs.nmp_branch }}
+
+    - name: Run updator script
+      run: cd .github/helper && npm install && node updator.js
+      env:
+        GITHUB_TOKEN: ${{ secrets.PAT_PASSWORD }}
+        NEW_MC_VERSION: ${{ github.event.inputs.new_mc_version }}
+        MCDATA_BRANCH: ${{ github.event.inputs.mcdata_branch }}
+        MCDATA_PR_URL: ${{ github.event.inputs.mcdata_pr_url }}
+        NMP_BRANCH: ${{ github.event.inputs.nmp_branch }}
+        NMP_PR_URL: ${{ github.event.inputs.nmp_pr_url }}

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.21 (1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, and 1.21)
+ * Supports Minecraft 1.8 to 1.21 (1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, 1.21) <!--version-->
  * 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.21 (1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, and 1.21)
+ * Supports Minecraft 1.8 to 1.21 (1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, 1.21) <!--version-->
  * 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/history.md

@@ -1,3 +1,11 @@
+## 4.33.0
+* [Add update workflow (#3727)](https://github.com/PrismarineJS/mineflayer/commit/9c335366d435b58cfe45bbfbbc534b99ee669dc2) (thanks @extremeheat)
+* [Add support for Minecraft 1.21.8 (#3732)](https://github.com/PrismarineJS/mineflayer/commit/ec8220d7c63b72acb4bf16f30cdf4ba346b83f98) (thanks @rom1504)
+
+## 4.32.0
+* [1.21.6 (#3713)](https://github.com/PrismarineJS/mineflayer/commit/01f537c394fc78bf2e765b28a8b24a30c1d1fd2e) (thanks @extremeheat)
+* [Fix knockback physics crash (#3715)](https://github.com/PrismarineJS/mineflayer/commit/e3f89d17418ece9e9fac4b111d8243dfe1a5d376) (thanks @Omena0)
+
 ## 4.31.0
 * [Cursor 1 21 5 (#3701)](https://github.com/PrismarineJS/mineflayer/commit/8770129d26a85f9b077d2a8969d45436fa09c3f3) (thanks @rom1504)
 

package/lib/loader.js

@@ -74,6 +74,10 @@ function createBot (options = {}) {
   const bot = new EventEmitter()
   bot._client = options.client
   bot.end = (reason) => bot._client.end(reason)
+  bot._warn = function (...message) {
+    if (options.hideErrors) return
+    console.warn('[mineflayer]', ...message)
+  }
   if (options.logErrors) {
     bot.on('error', err => {
       if (!options.hideErrors) {

package/lib/plugins/bed.js

@@ -167,7 +167,7 @@ function inject (bot) {
   }
 
   bot._client.on('game_state_change', (packet) => {
-    if (packet.reason === 0) {
+    if (packet.reason === 0 || packet.reason === 'no_respawn_block_available') {
       // occurs when you can't spawn in your bed and your spawn point gets reset
       bot.emit('spawnReset')
     }

package/lib/plugins/game.js

@@ -116,10 +116,10 @@ function inject (bot, options) {
   })
 
   bot._client.on('game_state_change', (packet) => {
-    if (packet?.reason === 4 && packet?.gameMode === 1) {
+    if ((packet.reason === 4 || packet.reason === 'win_game') && packet.gameMode === 1) {
       bot._client.write('client_command', { action: 0 })
     }
-    if (packet.reason === 3) {
+    if ((packet.reason === 3) || (packet.reason === 'change_game_mode')) {
       bot.game.gameMode = parseGameMode(packet.gameMode)
       bot.emit('game')
     }

package/lib/plugins/physics.js

@@ -232,7 +232,7 @@ function inject (bot, { physicsEnabled, maxCatchupTicks }) {
     }
     bot._client.write('entity_action', {
       entityId: bot.entity.id,
-      actionId: 8,
+      actionId: bot.supportFeature('entityActionUsesStringMapper') ? 'start_elytra_flying' : 8,
       jumpBoost: 0
     })
   }
@@ -247,15 +247,27 @@ function inject (bot, { physicsEnabled, maxCatchupTicks }) {
     } else if (control === 'sprint') {
       bot._client.write('entity_action', {
         entityId: bot.entity.id,
-        actionId: state ? 3 : 4,
+        actionId: bot.supportFeature('entityActionUsesStringMapper')
+          ? (state ? 'start_sprinting' : 'stop_sprinting')
+          : (state ? 3 : 4),
         jumpBoost: 0
       })
     } else if (control === 'sneak') {
-      bot._client.write('entity_action', {
-        entityId: bot.entity.id,
-        actionId: state ? 0 : 1,
-        jumpBoost: 0
-      })
+      if (bot.supportFeature('newPlayerInputPacket')) {
+        // In 1.21.6+, sneak is handled via player_input packet
+        bot._client.write('player_input', {
+          inputs: {
+            shift: state
+          }
+        })
+      } else {
+        // Legacy entity_action approach for older versions
+        bot._client.write('entity_action', {
+          entityId: bot.entity.id,
+          actionId: state ? 0 : 1,
+          jumpBoost: 0
+        })
+      }
     }
   }
 
@@ -296,7 +308,10 @@ function inject (bot, { physicsEnabled, maxCatchupTicks }) {
     // TODO: emit an explosion event with more info
     if (bot.physicsEnabled && bot.game.gameMode !== 'creative') {
       if (explosion.playerKnockback) { // 1.21.3+
-        bot.entity.velocity.add(explosion.playerMotionX, explosion.playerMotionY, explosion.playerMotionZ)
+        // Fixes issue #3635
+        bot.entity.velocity.x += explosion.playerKnockback.x
+        bot.entity.velocity.y += explosion.playerKnockback.y
+        bot.entity.velocity.z += explosion.playerKnockback.z
       }
       if ('playerMotionX' in explosion) {
         bot.entity.velocity.x += explosion.playerMotionX

package/lib/plugins/rain.js

@@ -1,20 +1,22 @@
 module.exports = inject
+const states = ['no_respawn_block_available', 'start_raining', 'stop_raining', 'change_game_mode', 'win_game', 'demo_event', 'play_arrow_hit_sound', 'rain_level_change', 'thunder_level_change', 'puffer_fish_sting', 'guardian_elder_effect', 'immediate_respawn', 'limited_crafting', 'level_chunks_load_start']
 
 function inject (bot) {
   bot.isRaining = false
   bot.thunderState = 0
   bot.rainState = 0
   bot._client.on('game_state_change', (packet) => {
-    if (packet.reason === 1) {
+    const reason = states[packet.reason] ?? packet.reason
+    if (reason === 'start_raining') {
       bot.isRaining = true
       bot.emit('rain')
-    } else if (packet.reason === 2) {
+    } else if (reason === 'stop_raining') {
       bot.isRaining = false
       bot.emit('rain')
-    } else if (packet.reason === 7) {
+    } else if (reason === 'rain_level_change') {
       bot.rainState = packet.gameMode
       bot.emit('weatherUpdate')
-    } else if (packet.reason === 8) {
+    } else if (reason === 'thunder_level_change') {
       bot.thunderState = packet.gameMode
       bot.emit('weatherUpdate')
     }

package/lib/plugins/team.js

@@ -1,41 +1,49 @@
 module.exports = inject
 
+// TODO: apply this to all versions and rename scoreboard_team -> teams in minecraft-data
+const TEAM_MODES = ['add', 'remove', 'change', 'join', 'leave']
+
 function inject (bot) {
   const Team = require('../team')(bot.registry)
   const teams = {}
 
   function teamHandler (packet) {
-    const { team: teamName, mode } = packet
+    const { team: teamName, players = [] } = packet
+    const mode = typeof packet.mode === 'number' ? TEAM_MODES[packet.mode] : packet.mode
+
     let team = teams[teamName]
-    if (mode === 0) {
-      team = new Team(
-        packet.team,
-        packet.name,
-        packet.friendlyFire,
-        packet.nameTagVisibility,
-        packet.collisionRule,
-        packet.formatting,
-        packet.prefix,
-        packet.suffix
-      )
-      if (Array.isArray(packet.players)) {
-        packet.players.forEach(player => {
+
+    switch (mode) {
+      case 'add':
+        team = new Team(
+          teamName,
+          packet.name,
+          packet.friendlyFire,
+          packet.nameTagVisibility,
+          packet.collisionRule,
+          packet.formatting,
+          packet.prefix,
+          packet.suffix
+        )
+        for (const player of players) {
           team.add(player)
           bot.teamMap[player] = team
-        })
-      }
-      teams[teamName] = team
-      bot.emit('teamCreated', teams[teamName])
-    }
-    if (team !== undefined) {
-      if (mode === 1) {
-        team.members.forEach(member => {
+        }
+        teams[teamName] = team
+        bot.emit('teamCreated', teams[teamName])
+        break
+
+      case 'remove':
+        if (!team) break
+        team.members.forEach((member) => {
           delete bot.teamMap[member]
         })
         delete teams[teamName]
         bot.emit('teamRemoved', teams[teamName])
-      }
-      if (mode === 2) {
+        break
+
+      case 'change':
+        if (!team) break
         team.update(
           packet.name,
           packet.friendlyFire,
@@ -46,23 +54,28 @@ function inject (bot) {
           packet.suffix
         )
         bot.emit('teamUpdated', teams[teamName])
-      }
-      if (Array.isArray(packet.players)) {
-        if (mode === 3) {
-          packet.players.forEach((player) => {
-            team.add(player)
-            bot.teamMap[player] = team
-          })
-          bot.emit('teamMemberAdded', teams[teamName])
+        break
+
+      case 'join':
+        if (!team) break
+        for (const player of players) {
+          team.add(player)
+          bot.teamMap[player] = team
         }
-        if (mode === 4) {
-          packet.players.forEach((player) => {
-            team.remove(player)
-            delete bot.teamMap[player]
-          })
-          bot.emit('teamMemberRemoved', teams[teamName])
+        bot.emit('teamMemberAdded', teams[teamName])
+        break
+
+      case 'leave':
+        if (!team) break
+        for (const player of players) {
+          team.remove(player)
+          delete bot.teamMap[player]
         }
-      }
+        bot.emit('teamMemberRemoved', teams[teamName])
+        break
+
+      default:
+        bot._warn(`Unknown team mode handling team update: ${mode}`)
     }
   }
 

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', '1.20.4', '1.20.6', '1.21.1', '1.21.3', '1.21.4', '1.21.5']
+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', '1.20.6', '1.21.1', '1.21.3', '1.21.4', '1.21.5', '1.21.6', '1.21.8']
 module.exports = {
 
   testedVersions,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mineflayer",
-  "version": "4.31.0",
+  "version": "4.33.0",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",
@@ -21,8 +21,8 @@
   },
   "license": "MIT",
   "dependencies": {
-    "minecraft-data": "^3.76.0",
-    "minecraft-protocol": "^1.60.0",
+    "minecraft-data": "^3.98.0",
+    "minecraft-protocol": "^1.61.0",
     "prismarine-biome": "^1.1.1",
     "prismarine-block": "^1.22.0",
     "prismarine-chat": "^1.7.1",