Merge branch 'master' into switchworld

Author: rom1504

.github/workflows/ci.yml

@@ -52,7 +52,7 @@ jobs:
       - name: Setup Java JDK
         uses: actions/[email protected]
         with:
-          java-version: 17
+          java-version: 21
           java-package: jre
       - name: Install Dependencies
         run: npm install

.gitignore

@@ -10,3 +10,4 @@ test/server_*
 .vscode
 .DS_Store
 launcher_accounts.json
+data

.gitpod.yml

@@ -1,2 +1,2 @@
 tasks:
-- command: npm install
+- command: npm install && sdk install java

docs/CONTRIBUTING.md

@@ -22,6 +22,22 @@ Mineflayer has two kind of tests :
 
 The objective of these tests is to know automatically what works and what doesn't in mineflayer, so it's easier to make mineflayer work.
 
+
+## Running tests
+You can run tests for Different Minecraft versions using the `-g` flag with npm run mocha_test. For example:
+
+```bash
+# Run all tests in all supported versions
+npm run test
+
+# Run a specific test in Minecraft 1.20.4
+npm run mocha_test -- -g "mineflayer_external 1.20.4v.*exampleBee"
+
+# Run all tests in just version 1.20.4
+npm run mocha_test -- -g "mineflayer_external 1.20.4v"
+```
+
+
 ### Creating an external test
 
 In order to add an external test now you only need to create a file in [test/externalTests](test/externalTests)

docs/FAQ.md

@@ -2,6 +2,10 @@
 
 This Frequently Asked Question document is meant to help people for the most common things.
 
+### I get an error (ie. protocol/data) when bot is trying to connect to minecraft server
+
+Make sure the Minecraft server version is supported (cf. root readme), else you should retry using one of the [mineflayer tested versions](../lib/version.js).
+
 ### I get an error when trying to login with a microsoft account.
 
 Make sure the email you entered into the username option in createBot can be used to login to `minecraft.net` using the 'Login with Microsoft' button.

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.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)
+ * 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)
  * 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
@@ -43,7 +43,7 @@ npm install mineflayer
 
 To update mineflayer (or any Node.js) package and its dependencies, use 
 ```bash
-npm update --depth 9999
+npm update
 ```
 
 ## Documentation
@@ -234,6 +234,7 @@ The most updated and useful are :
 ## Projects Using Mineflayer
 
  * [Voyager](https://github.com/MineDojo/Voyager) An Open-Ended Embodied Agent with Large Language Models
+ * [mindcraft](https://github.com/kolbytn/mindcraft) Lib for using mineflayer with LLMs
  * [rom1504/rbot](https://github.com/rom1504/rbot)
    - [YouTube - building a spiral staircase](https://www.youtube.com/watch?v=UM1ZV5200S0)
    - [YouTube - replicating a building](https://www.youtube.com/watch?v=0cQxg9uDnzA)

docs/api.md

@@ -169,7 +169,7 @@
       - ["respawn"](#respawn)
       - ["game"](#game)
       - ["resourcePack" (url, hash)](#resourcepack-url-hash)
-      - ["title"](#title)
+      - ["title" (title, type)](#title-title-type)
       - ["rain"](#rain)
       - ["weatherUpdate"](#weatherupdate)
       - ["time"](#time)
@@ -1238,11 +1238,12 @@ Emitted when the server changes any of the game properties.
 
 Emitted when the server sends a resource pack.
 
-#### "title"
+#### "title" (title, type)
 
 Emitted when the server sends a title
 
- * `text` - title's text
+ * `title` - title's text
+ * `type` - title's type "subtitle" or "title"
 
 #### "rain"
 
@@ -1777,7 +1778,7 @@ Checks if the given plugin is loaded (or scheduled to be loaded) on this bot.
 
 This function returns a `Promise`, with `void` as its argument upon completion.
 
-Sleep in a bed. `bedBlock` should be a `Block` instance which is a bed. 
+Sleep in a bed. `bedBlock` should be a `Block` instance which is a bed.
 
 #### bot.isABed(bedBlock)
 
@@ -1787,7 +1788,7 @@ Return true if `bedBlock` is a bed
 
 This function returns a `Promise`, with `void` as its argument upon completion.
 
-Get out of bed. 
+Get out of bed.
 
 #### bot.setControlState(control, state)
 
@@ -2126,7 +2127,7 @@ These are lower level methods for the inventory, they can be useful sometimes bu
 #### bot.clickWindow(slot, mouseButton, mode)
 
 This function returns a `Promise`, with `void` as its argument upon completion.
-  
+
 The only valid mode option at the moment is 0. Shift clicking or mouse dragging is not implemented.
 
 Click on the current window. See details at https://wiki.vg/Protocol#Click_Container

docs/br/api_br.md

@@ -141,7 +141,7 @@
       - ["respawn"](#respawn)
       - ["game"](#game)
       - ["resourcePack" (url, hash)](#resourcepack-url-hash)
-      - ["title"](#title)
+      - ["title" (title, type)](#title-title-type)
       - ["rain"](#rain)
       - ["weatherUpdate"](#weatherupdate)
       - ["time"](#time)
@@ -1060,11 +1060,12 @@ Este evento é emitido quando o arquivo index é carregado. Você pode carregar
 
 É emitido quando o servidor envia um pacote de recursos.
 
-#### "title"
+#### "title" (title, type)
 
 É emitido quando o servidor exibe um título.
 
- * `text` - texto do título
+ * `title` - texto do título
+ * `type` - tipo do título "subtitle" ou "title"
 
 #### "rain"
 
@@ -2035,4 +2036,4 @@ Observação: enquanto você voa, `bot.entity.velocity` não é preciso.
 
 #### bot.creative.stopFlying()
 
-Restaura `bot.physics.gravity` ao seu valor original.
+Restaura `bot.physics.gravity` ao seu valor original.

docs/es/api_es.md

@@ -141,7 +141,7 @@
       - ["respawn"](#respawn)
       - ["game"](#game)
       - ["resourcePack" (url, hash)](#resourcepack-url-hash)
-      - ["title"](#title)
+      - ["title" (title, type)](#title-title-type)
       - ["rain"](#rain)
       - ["weatherUpdate"](#weatherupdate)
       - ["time"](#time)
@@ -1071,11 +1071,12 @@ Se emite cuando el servidor cambia cualquiera de sus propiedades
 
 Se emite cuando el servidor manda un paquete de recursos
 
-#### "title"
+#### "title" (title, type)
 
 Se emite cuando el servidor manda/muestra un título
 
- * `text` - texto del título
+ * `title` - texto del título
+ * `type` - tipo del título "subtitle" o "title"
 
 #### "rain"
 

docs/history.md

@@ -1,3 +1,44 @@
+## 4.25.0
+* [1.21.4 (#3546)](https://github.com/PrismarineJS/mineflayer/commit/8bbf5669f5ff3ea8a708633e51b47c312dc7a26b) (thanks @extremeheat)
+
+## 4.24.0
+* [Support 1.21.3. (#3489)](https://github.com/PrismarineJS/mineflayer/commit/58ae9e5b5abf75139f4ba93fe4f34ef7ed3936e8) (thanks @rom1504)
+* [Fix out of bounds access leading to crash at spawn (#3535)](https://github.com/PrismarineJS/mineflayer/commit/3187368397e880ba8b32bb03affa18203cbcbb42) (thanks @wAIfu-DEV)
+* [fix: use dimension data on 1.16.2 (#3397)](https://github.com/PrismarineJS/mineflayer/commit/f6187f66c16dd122165287be7864c78b2fe7c32c) (thanks @zardoy)
+* [update contribution docs to show test running commands (#3511)](https://github.com/PrismarineJS/mineflayer/commit/71a3a262681a173db86b8911aec82402a6993d21) (thanks @Madlykeanu)
+* [Update inventory.js (#3507)](https://github.com/PrismarineJS/mineflayer/commit/a0e92cad5887181bf7e235f69378c8ede14a350c) (thanks @Pix3lPirat3)
+* [Update FAQ.md - add mineflayer tested versions : lib/version.js (#3517)](https://github.com/PrismarineJS/mineflayer/commit/f2dd3a37505b374bf63119633659e35ec2ce3542) (thanks @boly38)
+* [Bump protodef from 1.17.0 to 1.18.0 (#3523)](https://github.com/PrismarineJS/mineflayer/commit/06faa36c2da3da399bd5370869700aea6c65c9b0) (thanks @dependabot[bot])
+* [Bump mocha from 10.8.2 to 11.0.1 (#3516)](https://github.com/PrismarineJS/mineflayer/commit/166971d317db3ec68cf3eebeda37f509152628fd) (thanks @dependabot[bot])
+* [Fix chatterbox example (#3506)](https://github.com/PrismarineJS/mineflayer/commit/386200759556aa261fa212f26c43992a66cfa8ac) (thanks @ShiftSad)
+* [Proper title event (#3498)](https://github.com/PrismarineJS/mineflayer/commit/3829a25150eec782bc045a222476865af7b0ac72) (thanks @SMEDjs)
+* [Set `sequence` field correctly in activateItem (#3445)](https://github.com/PrismarineJS/mineflayer/commit/fdba03737ecdeaaf419e3175b9be33291db4e085) (thanks @GenerelSchwerz)
+* [increase timeout in external test common](https://github.com/PrismarineJS/mineflayer/commit/3d6e2344751c38428701dc52e9f29dda73f7f782) (thanks @rom1504)
+
+## 4.23.0
+* [1.21 (#3480)](https://github.com/PrismarineJS/mineflayer/commit/4aa10fb45431940504c7809f078f1f410e7fa7a3) (thanks @Madlykeanu)
+* [Adding mindcraft to mineflayer readme](https://github.com/PrismarineJS/mineflayer/commit/dd00db42ba20682418d8fbd5629e1033dfb0ff20) (thanks @rom1504)
+
+## 4.22.0
+* [Remove debug logging (#3478)](https://github.com/PrismarineJS/mineflayer/commit/eb29d350ede0590fce17e04bf21071807a87e3a1) (thanks @extremeheat)
+
+## 4.21.0
+* [1.20.6 (#3412)](https://github.com/PrismarineJS/mineflayer/commit/44fad41c18be5024564e24e1cdee624d35d4d387) (thanks @extremeheat)
+* [Update README.md (#3420)](https://github.com/PrismarineJS/mineflayer/commit/1c2a5c0fa78f74a63fabd7edde85c4a74db32dee) (thanks @SilkePilon)
+* [types: add pitchSpeed as an option in typings (#3446)](https://github.com/PrismarineJS/mineflayer/commit/05b48ad0dad4cf64a1c11660bac256d7b4015841) (thanks @GenerelSchwerz)
+* [Fixed a bug with not closing the window when changing the subserver (#3424)](https://github.com/PrismarineJS/mineflayer/commit/d00c386cfe51cefc361c0ff4d30b100aee9f114a) (thanks @DenisKvak1)
+* [Bump @types/node from 20.14.14 to 22.1.0 (#3431)](https://github.com/PrismarineJS/mineflayer/commit/1d461616b514969fdece38e49bfbec747ab8d76a) (thanks @dependabot[bot])
+* [Fix updateSlot event type (#3425)](https://github.com/PrismarineJS/mineflayer/commit/5d39db26a6ab17baac38b68af8ccd3eeb4af3def) (thanks @DenisKvak1)
+* [Player hitbox fixes (#3382)](https://github.com/PrismarineJS/mineflayer/commit/78b4eccb4572a821b11c3124b7a593f3b91f1180) (thanks @AreaDenial)
+* [Typo fixes (#3418)](https://github.com/PrismarineJS/mineflayer/commit/ef042a242ca9f5fc5820fe4dc2e1d997ef1db202) (thanks @kgurchiek)
+* [Added support for 1.18+ edit book packet #3204 (#3373)](https://github.com/PrismarineJS/mineflayer/commit/eb9982aa04973b0086aac68a2847005d77f01a3d) (thanks @unlimitedcoder2)
+* [Fix typos (#3381)](https://github.com/PrismarineJS/mineflayer/commit/d581ea7cee4d5b7df9606f671656bb0be0fdbf91) (thanks @data-miner00)
+* [Fix typescript types syntax for setCommandBlock (#3366)](https://github.com/PrismarineJS/mineflayer/commit/315cdfc4b1fc2760e4a8a36feb718626a66d5056) (thanks @undefined)
+* [Remove invalid sign check (#3328)](https://github.com/PrismarineJS/mineflayer/commit/ec76468c8ac4c6232bad3c2b66d4160f95f58396) (thanks @zardoy)
+* [refactor: simplifying the code of blockAtCursor (#3337)](https://github.com/PrismarineJS/mineflayer/commit/dc70f932ac9aaab6e6cdb15057b409b15c3232dd) (thanks @SnowRunescape)
+* [Updated setCommandBlock's 3rd argument (#3356)](https://github.com/PrismarineJS/mineflayer/commit/04ad6db404f0da779004b3ddd0e049bf2c6be0a3) (thanks @FlooferLand)
+* [Added the serverBrand property to index.d.ts (#3355)](https://github.com/PrismarineJS/mineflayer/commit/0bb2707d2f6d0d64a467d4e0d6ddc52adf526127) (thanks @Khaogamermain01)
+
 ## 4.20.1
 * [Add bossBarCreated event in index.d.ts (#3340)](https://github.com/PrismarineJS/mineflayer/commit/8299288526cd7ff24bcd87511814221f8ad62507) (thanks @gguio)
 * [Update scoreboard.js (#3318)](https://github.com/PrismarineJS/mineflayer/commit/195b3cbd70a110080af9b77a4659991c5d9e484a) (thanks @vicdum)

docs/ru/api_ru.md

@@ -169,7 +169,7 @@
       - ["respawn"](#respawn)
       - ["game"](#game)
       - ["resourcePack" (url, hash)](#resourcepack-url-hash)
-      - ["title"](#title)
+      - ["title" (title, type)](#title-title-type)
       - ["rain"](#rain)
       - ["weatherUpdate"](#weatherupdate)
       - ["time"](#time)
@@ -1264,11 +1264,12 @@ UUID существа, который определяется боссом.
 
 Срабатывает, когда сервер отправляет ресурспак.
 
-#### "title"
+#### "title" (title, type)
 
 Срабатывает, когда сервер отправляет текст по центру экрана.
 
- * `text` - Текст на экране.
+ * `title` - Текст на экране.
+ * `type` - Тип текста "subtitle" или "title"
 
 #### "rain"
 
@@ -1634,7 +1635,7 @@ UUID существа, который определяется боссом.
 
 #### bot.recipesFor(itemType, metadata, minResultCount, craftingTable)
 
-Возвращает список рецептов(`Recipe`), которые вы можете использовать для крафта 
+Возвращает список рецептов(`Recipe`), которые вы можете использовать для крафта
 предмета(`itemType`) с мета-данными(`metadata`).
 
  * `itemType` - Числовой ID предмета, который вы хотите создать.
@@ -2116,7 +2117,7 @@ bot.once('login', () => {
 #### bot.clickWindow(slot, mouseButton, mode)
 
 Эта функция возвращает `Promise` с `void` в качестве аргумента при завершении.
-  
+
 Единственное действительное значение для `mode` - 0. Нажатие с шифтом или перемещение через мышь не реализовано.
 
 Нажимает на текущее окно. Подробнее - https://wiki.vg/Protocol#Click_Container

docs/zh/api.md

@@ -153,7 +153,7 @@
       - ["respawn"](#respawn)
       - ["game"](#game)
       - ["resourcePack" (url, hash)](#resourcepack-url-hash)
-      - ["title"](#title)
+      - ["title" (title, type)](#title-title-type)
       - ["rain"](#rain)
       - ["weatherUpdate"](#weatherupdate)
       - ["time"](#time)
@@ -1127,11 +1127,12 @@ Emitted for every server message, including chats.
 
 当服务器发送资源包时触发
 
-#### "title"
+#### "title" (title, type)
 
 当服务器发送标题时触发
 
- * `text` - 标题文本
+ * `title` - 标题文本
+ * `type` - 标题类型 "subtitle" 或 "title"
 
 #### "rain"
 
@@ -1150,11 +1151,11 @@ If you join a server where it is already raining, this event will fire.
 
 当bot从服务器被踢出时触发
 
- `reason`是一条解释你被踢的原因的聊天信息. 
+ `reason`是一条解释你被踢的原因的聊天信息.
 
 `loggedIn`
  如果客户端在成功登录后被踢出则为`true`
-如果kick发生在登录阶段则为 `false` 
+如果kick发生在登录阶段则为 `false`
 
 #### "end" (reason)
 

examples/echo.js

@@ -9,18 +9,22 @@
 const mineflayer = require('mineflayer')
 
 if (process.argv.length < 4 || process.argv.length > 6) {
-  console.log('Usage : node echo.js <host> <port> [<name>] [<password>]')
+  console.log('Usage : node echo.js <host> <port> [<name>] [online?]')
   process.exit(1)
 }
 
 const bot = mineflayer.createBot({
   host: process.argv[2],
   port: parseInt(process.argv[3]),
   username: process.argv[4] ? process.argv[4] : 'echo',
-  password: process.argv[5]
+  auth: process.argv[5] ? 'microsoft' : 'offline'
 })
 
 bot.on('chat', (username, message) => {
   if (username === bot.username) return
   bot.chat(message)
 })
+
+bot.on('kicked', (reason) => {
+  console.log('I was kicked from the server: ' + reason)
+})

examples/python/chatterbox.py

@@ -30,8 +30,7 @@
 bot = mineflayer.createBot({
     "host": host,
     "port": port,
-    "username": username,
-    "port": port
+    "username": username
 })
 
 Item = require("prismarine-item")(bot.registry)
@@ -300,4 +299,4 @@ def entityEffect(this, entity, effect):
 
 @On(bot, "entityEffectEnd")
 def entityEffectEnd(this, entity, effect):
-    print("entityEffectEnd", entity, effect)
+    print("entityEffectEnd", entity, effect)

examples/titles.js

@@ -0,0 +1,22 @@
+/*
+ * An example of how to handle title events from the server.
+ */
+const mineflayer = require('mineflayer')
+
+if (process.argv.length < 4 || process.argv.length > 6) {
+  console.log('Usage : node titles.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] : 'titles',
+  password: process.argv[5]
+})
+
+// This event is triggered when the server sends a title to the client.
+bot.on('title', (text, type) => {
+  // type is either "title" or "subtitle"
+  console.log(`Received ${type}: ${text}`)
+})

index.d.ts

@@ -71,7 +71,7 @@ export interface BotEvents {
   spawn: () => Promise<void> | void
   respawn: () => Promise<void> | void
   game: () => Promise<void> | void
-  title: (text: string) => Promise<void> | void
+  title: (text: string, type: "subtitle" | "title") => Promise<void> | void
   rain: () => Promise<void> | void
   time: () => Promise<void> | void
   kicked: (reason: string, loggedIn: boolean) => Promise<void> | void
@@ -542,6 +542,7 @@ export interface PhysicsOptions {
   playerHeight: number
   jumpSpeed: number
   yawSpeed: number
+  pitchSpeed: number
   sprintSpeed: number
   maxGroundSpeedSoulSand: number
   maxGroundSpeedWater: number

lib/loader.js

@@ -95,6 +95,7 @@ function createBot (options = {}) {
     }).map(key => options.plugins[key])
   bot.loadPlugins([...internalPlugins, ...externalPlugins])
 
+  options.validateChannelProtocol = false
   bot._client = bot._client ?? mc.createClient(options)
   bot._client.on('connect', () => {
     bot.emit('connect')