From a13684ae5474a79012783a380438ac6dbe642d8e Mon Sep 17 00:00:00 2001 From: MoeDawn <232063003+MoeDawn@users.noreply.github.com> Date: Mon, 12 Oct 2026 14:33:58 +0800 Subject: [PATCH 1/4] docs(zh): use the English README's badges The Chinese badge block had not been kept in sync with the English one, and some of its badges no longer work. --- docs/zh/README_ZH_CN.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/zh/README_ZH_CN.md b/docs/zh/README_ZH_CN.md index 4afbeba5bc..fb8bc7a68f 100644 --- a/docs/zh/README_ZH_CN.md +++ b/docs/zh/README_ZH_CN.md @@ -1,14 +1,12 @@ # Mineflayer -[![NPM version](https://badge.fury.io/js/mineflayer.svg)](http://badge.fury.io/js/mineflayer) -[![Build Status](https://github.com/PrismarineJS/mineflayer/workflows/CI/badge.svg)](https://github.com/PrismarineJS/mineflayer/actions?query=workflow%3A%22CI%22) -[![Discord](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](https://discord.gg/GsEFRM8) -[![Gitter](https://img.shields.io/badge/chat-on%20gitter-brightgreen.svg)](https://gitter.im/PrismarineJS/general) -[![Irc](https://img.shields.io/badge/chat-on%20irc-brightgreen.svg)](https://irc.gitter.im/) -[![Issue Hunt](https://github.com/BoostIO/issuehunt-materials/blob/master/v1/issuehunt-shield-v1.svg)](https://issuehunt.io/r/PrismarineJS/mineflayer) - -[![Try it on gitpod](https://img.shields.io/badge/try-on%20gitpod-brightgreen.svg)](https://gitpod.io/#https://github.com/PrismarineJS/mineflayer) -[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/PrismarineJS/mineflayer/blob/master/docs/mineflayer.ipynb) +[![NPM version](https://img.shields.io/npm/v/mineflayer.svg?color=success&label=npm%20package&logo=npm)](https://www.npmjs.com/package/mineflayer) +[![Build Status](https://img.shields.io/github/actions/workflow/status/PrismarineJS/mineflayer/ci.yml.svg?label=CI&logo=github&logoColor=lightgrey)](https://github.com/PrismarineJS/mineflayer/actions?query=workflow%3A%22CI%22) +[![Try it on gitpod](https://img.shields.io/static/v1.svg?label=try&message=on%20gitpod&color=brightgreen&logo=gitpod)](https://gitpod.io/#https://github.com/PrismarineJS/mineflayer) +[![Open In Colab](https://img.shields.io/static/v1.svg?label=open&message=on%20colab&color=blue&logo=google-colab)](https://colab.research.google.com/github/PrismarineJS/mineflayer/blob/master/docs/mineflayer.ipynb) +[![GitHub Sponsors](https://img.shields.io/github/sponsors/PrismarineJS)](https://github.com/sponsors/PrismarineJS) + +[![Official Discord](https://img.shields.io/static/v1.svg?label=OFFICIAL&message=DISCORD&color=blue&logo=discord&style=for-the-badge)](https://discord.gg/GsEFRM8) | EN [English](../README.md) | RU [русский](../ru/README_RU.md) | ES [Español](../es/README_ES.md) | FR [Français](../fr/README_FR.md) | TR [Türkçe](../tr/README_TR.md) | ZH [中文](../zh/README_ZH_CN.md) | BR [Portuguese](../br/README_BR.md) | |-------------------------|----------------------------|----------------------------|----------------------------|----------------------------|----------------------------|----------------------------| From f7ee3a0e016ff73aeef55f596fb2d5b9eac28ec3 Mon Sep 17 00:00:00 2001 From: MoeDawn <232063003+MoeDawn@users.noreply.github.com> Date: Mon, 12 Oct 2026 14:33:59 +0800 Subject: [PATCH 2/4] docs(zh): sync with the English README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The Chinese README had fallen behind the English source. Catch it up and fix what regressed along the way. * add the microsoft auth / token-caching paragraph and its API doc link; the paragraph was absent entirely * add minecraft-mcp-server, Movement, Voyager, mindcraft and OpenDeliveryBot; drop blockfinder and scaffold, which the English README no longer lists * point statemachine, Collect Block and PVP at this org (they moved from TheDudeFromCI) and fix the Auto Eat link, whose author was misspelled * describe `username` as node-minecraft-protocol does: the name to join as when `auth` is `offline`, otherwise a per-account identifier * say the viewer's `port` is the minecraft server port * raise the version line to 26.1 and restore the marker * 酿造台 -> 发射器; `npm mocha_test` -> `npm run mocha_test`; `™` had split into `& trade;`; BlockFinder finds blocks, not paths; 数千个 -> 数百个 (hundreds); prismarine-recipe is recipes, not a crafting table * close the first code fence with three backticks, not four * Node.js >= 22, matching engines.node; capitalise Windows and use a full-width colon after it --- docs/zh/README_ZH_CN.md | 165 +++++++++++++++++++++------------------- 1 file changed, 86 insertions(+), 79 deletions(-) diff --git a/docs/zh/README_ZH_CN.md b/docs/zh/README_ZH_CN.md index fb8bc7a68f..b626ecb8c9 100644 --- a/docs/zh/README_ZH_CN.md +++ b/docs/zh/README_ZH_CN.md @@ -13,20 +13,20 @@ 使用强大、稳定、高级的 JavaScript [API](../api.md) 来开发 Minecraft 机器人,同时支持 Python。 -第一次使用 node.js ?你可以先看看 [使用教程](../tutorial.md) 。了解过 Python?这里有一些 [Python 实例](https://github.com/PrismarineJS/mineflayer/tree/master/examples/python),同时你也可以[在谷歌 Colab 中运行 Mineflayer](https://colab.research.google.com/github/PrismarineJS/mineflayer/blob/master/docs/mineflayer.ipynb) 来体验一下。 +第一次使用 node.js ?你可以先来看看 [使用教程](../tutorial.md) 。了解过 Python?可以看看这些 [Python 实例](https://github.com/PrismarineJS/mineflayer/tree/master/examples/python),同时你也可以[在谷歌 Colab 中运行 Mineflayer](https://colab.research.google.com/github/PrismarineJS/mineflayer/blob/master/docs/mineflayer.ipynb) 来体验一下。 ## 特点 - * 支援Minecraft 1.8 至 1.21.11版本(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, 1.21.9, 1.21.11) + * 目前支持 Minecraft 1.8 至 26.1 版本(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, 1.21.9, 1.21.11, 26.1) * 实体感知与追踪 - * 方块感知,你可以在几毫秒内查找到bot周围的任何方块 + * 方块感知,你可以在几毫秒内查找到机器人周围的任何方块 * 物理和运动引擎 - 支持所有的碰撞箱 * 攻击实体,使用交通工具 * 背包管理 - * 使用工作台、箱子、酿造台、附魔台 + * 使用工作台、箱子、发射器、附魔台 * 挖掘和建造 - * 各种各样的的信息接口,比如查看你的血量或是否下雨 - * 激活方块和使用物品 + * 多种信息接口,比如查看自身血量或当前是否下雨 + * 激活方块或使用物品 * 进行聊天 ### 路线图 @@ -35,9 +35,9 @@ ## 安装 -首先,从 [nodejs.org](https://nodejs.org/) 安装 nodejs(版本要求 >= 18), +首先,从 [nodejs.org](https://nodejs.org/) 安装 nodejs(版本要求 >= 22), -然后在你创建的bot项目目录中,使用命令行运行: +然后在你创建的机器人项目目录中,使用命令行运行: ```bash npm install mineflayer @@ -53,8 +53,8 @@ npm update | 链接 | 描述 | |---|---| | [使用教程](../tutorial.md) | node.js 和 mineflayer 入门 | -| [FAQ](../FAQ.md) | 使用中出现问题?先看看这个文档吧 | -| [api](../api.md)、[不稳定的api](../unstable_api.md) | 完整的接口参考文档 | +| [FAQ](../FAQ.md) | 在使用过程中遇到了问题?先看看这个文档 | +| **[api](../api.md)**
[不稳定的api](../unstable_api.md) | 完整的接口参考文档 | | [更新日志](../history.md) | mineflayer 的更新日志 | | [示例/](https://github.com/PrismarineJS/mineflayer/tree/master/examples) | 我们为你准备的 mineflayer 使用实例 | @@ -77,20 +77,20 @@ npm update **开始使用** -如果没有指定特定版本,使用的服务器版本将自动判断并使用。 -如果没有指定登录类型,默认使用 mojang 账户认证登录。 +如果没有指定特定版本,将自动判断服务器使用的版本并使用。 +如果没有指定登录类型,默认使用 mojang 账户认证的方式登录。 -### 例子:复读机 +### 回显示例 ```js const mineflayer = require('mineflayer') const bot = mineflayer.createBot({ host: 'localhost', // minecraft 服务器的 IP 地址 - username: 'Bot', // minecraft 用户名 + username: 'Bot', // 当 auth 为 'offline' 时的加入用户名;否则为该账户的唯一标识符。想更换账户时修改此处 auth: 'microsoft' // 对于离线模式(正版验证关闭)的服务器,你可以将其设置为 'offline' - // port: 25565, // 默认使用 25565,如果你的服务器端口不是这个请取消注释并填写。 - // version: false, // 如果需要指定使用一个版本或快照时,请取消注释并手动填写(如:"1.8.9" 或 "1.16.5"),否则会自动设置。 + // port: 25565, // 默认使用 25565,如果你的服务器端口不是这个,请取消注释并使用服务器开放的端口。 + // version: false, // 如果需要使用指定版本或快照,请取消注释并手动填写(如:"1.8.9" 或 "1.16.5"),否则会自动设置。 // password: '12345678' // 如果想使用基于密码的身份验证则设置(可能不可靠),请取消注释并手动填写。如果指定了此项,username 必须是邮箱。 }) @@ -99,14 +99,19 @@ bot.on('chat', (username, message) => { bot.chat(message) }) -// 记录错误和被踢出服务器的原因: +// 记录错误和被踢出服务器的原因: bot.on('kicked', console.log) bot.on('error', console.log) ``` +如果 `auth` 设置为 `microsoft`,你会在浏览器中看到一个提示,要求登录 microsoft.com 并输入一个验证码。在浏览器中登录后,机器人将自动获取并缓存身份验证令牌(以你指定的用户名为准),因此你无需再次登录。 + +要更换账户,请更新填入的 `username`。默认情况下,缓存的令牌会存储在用户目录下的 .minecraft 文件夹中;如果指定了 `profilesFolder`,则会改为存储在那里。 +有关机器人选项的更多信息,请参阅 node-minecraft-protocol 的 [API 文档](https://github.com/PrismarineJS/node-minecraft-protocol/blob/master/docs/API.md#mccreateclientoptions)。 + #### 连接到 Realm -要加入你的 Minecraft 账号受邀加入的 Realm,你可以传入一个带有选择器函数的 realms 对象,如下所示。 +当你的 Minecraft 账户收到某个 Realm 的邀请后,若要加入该 Realm,可以像下面这样传入一个带有 selector 函数的 realms 对象。 ```js const client = mineflayer.createBot({ @@ -119,15 +124,15 @@ const client = mineflayer.createBot({ }) ``` -### 看看你的 bot 在做什么 +### 看看你的机器人在做什么 感谢 [prismarine-viewer](https://github.com/PrismarineJS/prismarine-viewer)项目,它可以在浏览器窗口显示你的机器人正在做什么。 -只需要运行 `npm install prismarine-viewer` 并将其添加到你的 bot 代码中。 +只需要运行 `npm install prismarine-viewer` 并将其添加到你的机器人代码中。 ```js const { mineflayer: mineflayerViewer } = require('prismarine-viewer') bot.once('spawn', () => { - mineflayerViewer(bot, { port: 3007, firstPerson: true }) // port 是本地网页运行的端口 ,如果 firstPerson: false,那么将会显示鸟瞰图。 + mineflayerViewer(bot, { port: 3007, firstPerson: true }) // port 是 minecraft 服务器端口,如果 firstPerson 为 false,你将得到鸟瞰视角 }) ``` @@ -139,47 +144,47 @@ bot.once('spawn', () => { | 例子 | 描述 | |---|---| -|[viewer](https://github.com/PrismarineJS/mineflayer/tree/master/examples/viewer) | 在浏览器中显示 bot 的视角 | -|[pathfinder](https://github.com/PrismarineJS/mineflayer/tree/master/examples/pathfinder) | 让你的 bot 自动前往任何地点 | -|[chest](https://github.com/PrismarineJS/mineflayer/blob/master/examples/chest.js) | 使用箱子、熔炉、酿造台、附魔台 | -|[digger](https://github.com/PrismarineJS/mineflayer/blob/master/examples/digger.js) | 学习如何创建一个能够挖掘方块的简单bot | -|[discord](https://github.com/PrismarineJS/mineflayer/blob/master/examples/discord.js) | 将 discord bot 与 mineflayer bot 进行消息互通 | +|[viewer](https://github.com/PrismarineJS/mineflayer/tree/master/examples/viewer) | 在浏览器中显示你的机器人世界视图 | +|[pathfinder](https://github.com/PrismarineJS/mineflayer/tree/master/examples/pathfinder) | 让你的机器人自动前往任意位置 | +|[chest](https://github.com/PrismarineJS/mineflayer/blob/master/examples/chest.js) | 使用箱子、熔炉、发射器、附魔台 | +|[digger](https://github.com/PrismarineJS/mineflayer/blob/master/examples/digger.js) | 学习如何创建一个能够挖掘方块的简单机器人 | +|[discord](https://github.com/PrismarineJS/mineflayer/blob/master/examples/discord.js) | 将 Discord 机器人与 mineflayer 机器人连接,消息互通 | |[jumper](https://github.com/PrismarineJS/mineflayer/blob/master/examples/jumper.js) | 学习如何移动、跳跃、骑乘载具、攻击附近的实体 | -|[ansi](https://github.com/PrismarineJS/mineflayer/blob/master/examples/ansi.js) | 使用全彩色在命令行中显示 bot 的聊天记录 | -|[guard](https://github.com/PrismarineJS/mineflayer/blob/master/examples/guard.js) | 让bot守卫一个指定的区域,不让附近的生物进入。 | -|[multiple-from-file](https://github.com/PrismarineJS/mineflayer/blob/master/examples/multiple_from_file.js) | 创建一个包含账户信息的文本文件,让它们全部同时登录 | +|[ansi](https://github.com/PrismarineJS/mineflayer/blob/master/examples/ansi.js) | 在终端中显示机器人聊天,并带有聊天颜色 | +|[guard](https://github.com/PrismarineJS/mineflayer/blob/master/examples/guard.js) | 让机器人在指定区域内守卫,抵御靠近的生物 | +|[multiple-from-file](https://github.com/PrismarineJS/mineflayer/blob/master/examples/multiple_from_file.js) | 添加一个包含多个账号的文本文件,让它们全部登录 | -还有更多的例子在 [examples](https://github.com/PrismarineJS/mineflayer/tree/master/examples) 文件夹中 + [examples](https://github.com/PrismarineJS/mineflayer/tree/master/examples) 文件夹中还有更多示例 ### 模块 -很多活跃的开发都发生在 mineflayer 所使用的小型 npm 包内 +mineflayer 的许多活跃开发,其实都发生在它依赖的那些小型 npm 包里 -#### The Node Way & trade; +#### Node 之道 -> "当你很好的编写了一个应用程序,此时它的价值仅限于这些特定的需求。你要知道,真正好的、可重复使用的优秀组件都会升华到github和npm上,在那里,每个人都可以合作来推进公共事业。" — [《 how I write modules 》 - substack](https://gist.github.com/substack/5075355) +> “当应用程序做得足够好时,它们就只剩下那些真正针对特定应用、难以轻易抽象掉的、带点咸味的残余物。所有漂亮的、可复用的组件都升华到 GitHub 和 npm 上,让每个人都能协作,推动公共资源进步。” — 出自 substack 的 [《how I write modules》](https://web.archive.org/web/20220301041352/https://gist.github.com/substack/5075355) (2013) #### 子模块 -这些是 构成 mineflayer 的主要模块: +这些是构成 mineflayer 的主要模块: | 模块 | 描述 | |---|---| | [minecraft-protocol](https://github.com/PrismarineJS/node-minecraft-protocol) | 解析和序列化 minecraft 数据包,以及身份验证和加密。 | [minecraft-data](https://github.com/PrismarineJS/minecraft-data) | 为 minecraft 客户端、服务器和库提供 minecraft 数据的语言独立模块。 -| [prismarine-physics](https://github.com/PrismarineJS/prismarine-physics) | 为 minecraft 实体提供物理引擎 +| [prismarine-physics](https://github.com/PrismarineJS/prismarine-physics) | 为 minecraft 实体提供物理引擎 | [prismarine-chunk](https://github.com/PrismarineJS/prismarine-chunk) | 一个为 Minecraft 保存区块数据的类 | [node-vec3](https://github.com/PrismarineJS/node-vec3) | 具有强大单元测试的 3d 矢量数学 | [prismarine-block](https://github.com/PrismarineJS/prismarine-block) | 用相关数据表示一个 minecraft 方块 | [prismarine-chat](https://github.com/PrismarineJS/prismarine-chat) | minecraft 聊天消息解析器(从 mineflayer 中提取) -| [node-yggdrasil](https://github.com/PrismarineJS/node-yggdrasil) | Node.js 库与 Mojang 的身份验证系统交互 +| [node-yggdrasil](https://github.com/PrismarineJS/node-yggdrasil) | 与 Mojang 身份验证系统(即 Yggdrasil)交互的 Node.js 库 | [prismarine-world](https://github.com/PrismarineJS/prismarine-world) | prismarine 世界的核心实现 | [prismarine-windows](https://github.com/PrismarineJS/prismarine-windows) | 表示 minecraft 窗口 | [prismarine-item](https://github.com/PrismarineJS/prismarine-item) | 用相关数据表示一个 minecraft 物品 | [prismarine-nbt](https://github.com/PrismarineJS/prismarine-nbt) | node-minecraft-protocol 的 NBT 解析器 -| [prismarine-recipe](https://github.com/PrismarineJS/prismarine-recipe) | 展示我的世界合成表 +| [prismarine-recipe](https://github.com/PrismarineJS/prismarine-recipe) | 表示 minecraft 合成配方 | [prismarine-biome](https://github.com/PrismarineJS/prismarine-biome) | 用相关数据表示 minecraft 生物群落 -| [prismarine-entity](https://github.com/PrismarineJS/prismarine-entity) | 表示一个 minecraft 实体 +| [prismarine-entity](https://github.com/PrismarineJS/prismarine-entity) | 表示一个 minecraft 实体 ### 调试 @@ -189,7 +194,7 @@ bot.once('spawn', () => { DEBUG="minecraft-protocol" node [...] ``` -在 windows 上: +在 Windows 上: ```powershell set DEBUG=minecraft-protocol @@ -200,49 +205,51 @@ node your_script.js mineflayer 支持插件;任何人都可以创建一个插件,在 mineflayer 之上添加更高级别的 API。 -最新和最有用的有: - -* [pathfinder](https://github.com/Karang/mineflayer-pathfinder) - 具有许多可配置功能的高级 A* 寻路 -* [prismarine-viewer](https://github.com/PrismarineJS/prismarine-viewer) - 简单的在线区块查看器 -* [web-inventory](https://github.com/ImHarvol/mineflayer-web-inventory) - 在线背包查看器 -* [statemachine](https://github.com/TheDudeFromCI/mineflayer-statemachine) - 用于更复杂机器人行为的状态机 API -* [Armor Manager](https://github.com/G07cha/MineflayerArmorManager) - 自动护甲管理 -* [Collect Block](https://github.com/TheDudeFromCI/mineflayer-collectblock) - 快速简单的块收集 API -* [Dashboard](https://github.com/wvffle/mineflayer-dashboard) - mineflayer bot 的前端仪表板 -* [PVP](https://github.com/TheDudeFromCI/mineflayer-pvp) - 用于基本 PVP 和 PVE 的简单 API -* [auto-eat](https://github.com/LINKdiscordd/mineflayer-auto-eat) - 自动进食 - * [Auto Crystal](https://github.com/link-discord/mineflayer-autocrystal) - 自动放置和破碎结 - * [Tool](https://github.com/TheDudeFromCI/mineflayer-tool) - 一个具有高级API的工具/武器自动选择工具的工具 - * [Hawkeye](https://github.com/sefirosweb/minecraftHawkEye) - 一个使用自动瞄准弓的工具 - * [GUI](https://github.com/firejoust/mineflayer-GUI) - 简化了嵌套箱子GUI窗口的导航和管理 - * [Projectile](https://github.com/firejoust/mineflayer-projectile) - 以投射物为基础的战斗的可配置插件 - - - 也可以看看这些 : - -* [radar](https://github.com/andrewrk/mineflayer-radar/) - 使用 canvas 和 socket.io 的基于 Web 的雷达界面 [YouTube 演示](https://www.youtube.com/watch?v=FjDmAfcVulQ) -* [blockfinder](https://github.com/Darthfett/mineflayer-blockFinder) - 在 3D 世界中寻找方块 -* [scaffold](https://github.com/andrewrk/mineflayer-scaffold) - 到达目标目的地,即使您必须建造或破坏块才能这样做 [YouTube 演示](http://youtu.be/jkg6psMUSE0) -* [auto-auth](https://github.com/G07cha/MineflayerAutoAuth) - 基于聊天的bot身份验证 -* [Bloodhound](https://github.com/Nixes/mineflayer-bloodhound) - 确定谁和什么对另一个实体的损害负责 -* [tps](https://github.com/SiebeDW/mineflayer-tps) - 获取当前的 tps(已处理的 tps) -* [panorama](https://github.com/IceTank/mineflayer-panorama) - 拍摄您的世界的全景图像 - * [player-death-event](https://github.com/tuanzisama/mineflayer-death-event) - 在 Mineflayer 里监听玩家死亡事件 +其中更新最及时、最实用的有: + + * [minecraft-mcp-server](https://github.com/yuniko-software/minecraft-mcp-server) 一个用于 mineflayer 的 MCP 服务器,让 LLM 也能使用 mineflayer + * [pathfinder](https://github.com/Karang/mineflayer-pathfinder) - 具有大量可配置功能的高级 A* 寻路 + * [prismarine-viewer](https://github.com/PrismarineJS/prismarine-viewer) - 简单的网页版区块查看器 + * [web-inventory](https://github.com/ImHarvol/mineflayer-web-inventory) - 网页版背包查看器 + * [statemachine](https://github.com/PrismarineJS/mineflayer-statemachine) - 用于更复杂机器人行为的状态机 API + * [Armor Manager](https://github.com/G07cha/MineflayerArmorManager) - 自动护甲管理 + * [Dashboard](https://github.com/wvffle/mineflayer-dashboard) - mineflayer 机器人的前端仪表板 + * [PVP](https://github.com/PrismarineJS/mineflayer-pvp) - 用于基础 PVP 和 PVE 的简易 API + * [Auto Eat](https://github.com/link-discord/mineflayer-auto-eat) - 自动进食。 + * [Auto Crystal](https://github.com/link-discord/mineflayer-autocrystal) - 自动放置和破坏末影水晶。 + * [Tool](https://github.com/TheDudeFromCI/mineflayer-tool) - 具有高级 API 的工具/武器自动选择工具。 + * [Hawkeye](https://github.com/sefirosweb/minecraftHawkEye) - 使用弓箭自动瞄准的工具。 + * [GUI](https://github.com/firejoust/mineflayer-GUI) - 使用 async/await 操作嵌套的 GUI 窗口 + * [Projectile](https://github.com/firejoust/mineflayer-projectile) - 计算抛射物所需的发射角度 + * [Movement](https://github.com/firejoust/mineflayer-movement) - 平滑而真实的玩家移动,最适合 PvP + * [Collect Block](https://github.com/PrismarineJS/mineflayer-collectblock) - 快速简单的方块采集 API。 + + 也可以看看这些: + + * [radar](https://github.com/andrewrk/mineflayer-radar/) - 使用 canvas 和 socket.io 的网页版雷达界面 [YouTube 演示](https://www.youtube.com/watch?v=FjDmAfcVulQ) + * [auto-auth](https://github.com/G07cha/MineflayerAutoAuth) - 基于聊天的机器人身份验证 + * [Bloodhound](https://github.com/Nixes/mineflayer-bloodhound) - 判断谁以及什么对另一个实体造成了伤害 + * [tps](https://github.com/SiebeDW/mineflayer-tps) - 获取当前 tps(已处理的 tps) + * [panorama](https://github.com/IceTank/mineflayer-panorama) - 拍摄你的世界的全景图像 + * [player-death-event](https://github.com/tuanzisama/mineflayer-death-event) - 在 Mineflayer 中发出玩家死亡事件。 ## 正在使用 mineflayer 的项目 +* [Voyager](https://github.com/MineDojo/Voyager) - 基于大语言模型的开放式具身智能体 +* [mindcraft](https://github.com/kolbytn/mindcraft) - 让 LLM 使用 mineflayer 的库 * [rom1504/rbot](https://github.com/rom1504/rbot) * [YouTube - 建造旋转楼梯](https://www.youtube.com/watch?v=UM1ZV5200S0) * [YouTube - 复制一个建筑](https://www.youtube.com/watch?v=0cQxg9uDnzA) -* [Darthfett/Helperbot](https://github.com/Darthfett/Helperbot) - 完成一些简单指令 +* [Darthfett/Helperbot](https://github.com/Darthfett/Helperbot) * [vogonistic/voxel](https://github.com/vogonistic/mineflayer-voxel) - 使用 voxel.js 可视化机器人正在做什么 -* [JonnyD/Skynet](https://github.com/JonnyD/Skynet) - 将玩家活动记录到在线 API 上 -* [MinecraftChat](https://github.com/rom1504/MinecraftChat) (最后一个开源版本,由 AlexKvazos 构建)——基于 Minecraft 网络的聊天客户端 -* [Cheese Bot](https://github.com/Minecheesecraft/Cheese-Bot) - 基于插件的机器人,具有干净的 GUI。使用 Node-Webkit 制作。 -* [Chaoscraft](https://github.com/schematical/chaoscraft) - 使用遗传算法的 Minecraft 机器人,请参阅 [Youtube](https://www.youtube.com/playlist?list=PLLkpLgU9B5xJ7Qy4kOyBJl5J6zsDIMceH) -* [hexatester/minetelegram](https://github.com/hexatester/minetelegram) - Minecraft - Telegram 消息互通,基于 mineflayer & telegraf. -* [PrismarineJS/mineflayer-builder](https://github.com/PrismarineJS/mineflayer-builder) - 在生存中打印我的世界示意图,保持方向 -* [以及数千个](https://github.com/PrismarineJS/mineflayer/network/dependents) - github 检测到的在使用 mineflayer 的项目 +* [JonnyD/Skynet](https://github.com/JonnyD/Skynet) - 将玩家活动记录到在线 API +* [MinecraftChat](https://github.com/rom1504/MinecraftChat)(最后一个开源版本,由 AlexKvazos 构建)- 基于网页的 Minecraft 聊天客户端 +* [Cheese Bot](https://github.com/Minecheesecraft/Cheese-Bot) - 基于插件的机器人,拥有简洁的图形界面。使用 Node-Webkit 开发。 +* [Chaoscraft](https://github.com/schematical/chaoscraft) - 使用遗传算法的 Minecraft 机器人,详见[其 YouTube 视频](https://www.youtube.com/playlist?list=PLLkpLgU9B5xJ7Qy4kOyBJl5J6zsDIMceH) +* [hexatester/minetelegram](https://github.com/hexatester/minetelegram) - Minecraft 与 Telegram 的桥接工具,基于 mineflayer 和 telegraf 构建。 +* [PrismarineJS/mineflayer-builder](https://github.com/PrismarineJS/mineflayer-builder) - 在生存模式下打印 Minecraft 结构(schematics),并保持方向一致 +* [SilkePilon/OpenDeliveryBot](https://github.com/SilkePilon/OpenDeliveryBot) - 用 Python 编写的 Minecraft 机器人,用于在不同地点之间运送物品。 +* [以及数百个](https://github.com/PrismarineJS/mineflayer/network/dependents) - GitHub 检测到的所有使用 mineflayer 的项目 ## 测试 @@ -251,14 +258,14 @@ mineflayer 支持插件;任何人都可以创建一个插件,在 mineflayer 运行 ```bash npm test -```` +``` ### 测试指定版本 运行 ```bash -npm mocha_test -- -g +npm run mocha_test -- -g ``` 其中 `` 表示 minecraft 版本号 如 `1.12`, `1.15.2`... @@ -268,7 +275,7 @@ npm mocha_test -- -g 运行 ```bash -npm mocha_test -- -g +npm run mocha_test -- -g ``` 其中 `` 是测试名称,例如 `bed`, `useChests`, `rayTrace`... @@ -279,7 +286,7 @@ npm mocha_test -- -g npm run mocha_test -- -g "1.18.1.*BlockFinder" ``` -进行 1.18.1 寻路测试 +运行 1.18.1 的 block finder 测试 ## 许可证 From ff1a13b95f0d7f01a67e080f12a0dfabdc612a1b Mon Sep 17 00:00:00 2001 From: MoeDawn <232063003+MoeDawn@users.noreply.github.com> Date: Mon, 12 Oct 2026 14:45:15 +0800 Subject: [PATCH 3/4] docs: update minimum Node.js version to 22 engines.node has been ">=22" since dbff9314 (Use node 22, #3570), but the README still told readers to install 18. --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 851dd556a2..deae125208 100644 --- a/docs/README.md +++ b/docs/README.md @@ -35,7 +35,7 @@ First time using Node.js? You may want to start with the [tutorial](tutorial.md) ## Installation -First install Node.js >= 18 from [nodejs.org](https://nodejs.org/) then: +First install Node.js >= 22 from [nodejs.org](https://nodejs.org/) then: ```bash npm install mineflayer From 87f079378b28d26856966ba8dbef15d97b6ab697 Mon Sep 17 00:00:00 2001 From: MoeDawn <232063003+MoeDawn@users.noreply.github.com> Date: Mon, 16 Nov 2026 11:48:54 +0800 Subject: [PATCH 4/4] docs: fix viewer port comment The port option of prismarine-viewer starts the local web server (http.listen in prismarine-viewer/lib/mineflayer.js); it does not change the bot Minecraft connection. Restore the correct Chinese wording and fix the same wrong comment in the English README. --- docs/README.md | 2 +- docs/zh/README_ZH_CN.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index deae125208..d7771639f9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -130,7 +130,7 @@ Just run `npm install prismarine-viewer` and add this to your bot: ```js const { mineflayer: mineflayerViewer } = require('prismarine-viewer') bot.once('spawn', () => { - mineflayerViewer(bot, { port: 3007, firstPerson: true }) // port is the minecraft server port, if first person is false, you get a bird's-eye view + mineflayerViewer(bot, { port: 3007, firstPerson: true }) // port is the local web server port, if first person is false, you get a bird's-eye view }) ``` And you'll get a *live* view looking like this: diff --git a/docs/zh/README_ZH_CN.md b/docs/zh/README_ZH_CN.md index b626ecb8c9..75f3948b1a 100644 --- a/docs/zh/README_ZH_CN.md +++ b/docs/zh/README_ZH_CN.md @@ -132,7 +132,7 @@ const client = mineflayer.createBot({ ```js const { mineflayer: mineflayerViewer } = require('prismarine-viewer') bot.once('spawn', () => { - mineflayerViewer(bot, { port: 3007, firstPerson: true }) // port 是 minecraft 服务器端口,如果 firstPerson 为 false,你将得到鸟瞰视角 + mineflayerViewer(bot, { port: 3007, firstPerson: true }) // port 是本地网页运行的端口,如果 firstPerson 为 false,你将得到鸟瞰视角 }) ```