Repository navigation
Conversation
The Chinese badge block had not been kept in sync with the English one, and some of its badges no longer work.
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 <!--version--> 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
engines.node has been ">=22" since dbff931 (Use node 22, PrismarineJS#3570), but the README still told readers to install 18.
a5da4e7 to
ff1a13b
Compare
|
I have rebased my branch onto the latest master and force-pushed the changes. |
|
No tests are more than 2x slower than master's recent runs anymore. |
rom1504
left a comment
There was a problem hiding this comment.
Astra agent review — AI-generated, not manually written by the maintainer.
Reviewed ff1a13b95f0d. The Node 22 and command fixes are useful, but one newly translated statement reverses the actual viewer API contract: the viewer port is its local HTTP/socket server port, not the Minecraft server’s port. The English source has the same mistake; copying that wording into another locale would spread it. Please correct both lines while touching the source README.
Skills used: prismarine-architecture-review: checked the public option against its owning package; prismarine-review: reviewed the changed documentation and surrounding examples rather than requiring tests for prose.
Validation: Static comparison of both changed READMEs, package engines and current prismarine-viewer/lib/mineflayer.js. Viewer constructs an HTTP server and calls http.listen(port). No runtime tests needed for this documentation correction; current CI is green.
| 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,你将得到鸟瞰视角 |
There was a problem hiding this comment.
Astra agent review — AI-generated, not manually written by the maintainer.
[P2] This port belongs to the viewer web server. prismarine-viewer/lib/mineflayer.js creates the HTTP/socket server and calls http.listen(port); it does not change the bot’s Minecraft connection. The previous Chinese wording was correct here. Describing3007 as the Minecraft server port can make users point the viewer at25565 and collide with a local game server. Restore the web-server wording and correct the matching English comment as well.
Skills used: prismarine-architecture-review: verifies a documented public option against its actual package owner.
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.
Summary
The Chinese README had fallen behind the English source. This brings it back in
line and fixes the errors in it. Three commits:
docs(zh): sync with the English README— adds the missing Microsoft authparagraph, refreshes the plugin and project lists, and fixes accumulated
mistranslations, broken commands and a stale version line
docs(zh): use the English README's badges— replaces the stale badge blockdocs: update minimum Node.js version to 22—docs/README.mdonlyContent that was missing or stale (
docs/zh/README_ZH_CN.md)auth: 'microsoft'(browser code login, tokencaching,
profilesFolder) and its link to node-minecraft-protocol's API docwas absent entirely.
minecraft-mcp-server,Movement,Voyager,mindcraftandOpenDeliveryBot. Droppedblockfinderandscaffold, which the EnglishREADME no longer lists.
statemachine,Collect BlockandPVPmoved to this org; the links stillpointed at TheDudeFromCI. The
Auto Eatlink had the author's name misspelled.usernameis now described the way node-minecraft-protocol does: the name tojoin as when
authisoffline, otherwise a per-account identifier.portis the minecraft server port — the Chinese text called itthe local web page port.
<!--version-->marker..github/helper/updator.jsonly rewritesdocs/README.md, so this line isupdated by hand and had stopped at 1.21.11.
Fixes
酿造台->发射器: the English saysdispensers, not brewing stands.npm mocha_test->npm run mocha_test. Withoutrun, npm invokes no script.™had split into& trade;and rendered as literal text.进行 1.18.1 寻路测试->运行 1.18.1 的 block finder 测试. The test runsexamples/blockfinder.js, a bot that answersfind <block>by callingbot.findBlocksand reporting what it found nearby; it contains nopathfinding. The Chinese described it as a pathfinding test.
数千个->数百个: the English says "and hundreds more".prismarine-recipewas described as a crafting table rather than recipes.在 windows 上:->在 Windows 上:(capitalised, full-width colon). TheEnglish source still uses
On windows :; this is a Chinese localisation fixand the English line is left untouched.
Badges
The Chinese badge block had not been kept in sync with the English one, and some
of its badges no longer work. It now matches the English block.
The ES, FR, TR and BR READMEs still carry the old block and have the same
problem. Fixing those is out of scope here.
Node.js requirement (
docs/README.mdanddocs/zh/README_ZH_CN.md)engines.nodehas been">=22"since dbff931 (Use node 22, #3570), but bothREADMEs still told readers to install 18. Both are updated so they stay in sync.
Relationship to #3885
Refs #3885
#3885 also touches
docs/zh/README_ZH_CN.md. Both PRs start from the sameupstream English README and share a lot of wording; #3885 is a full
retranslation of the file, while this PR is an independent targeted pass over
it. Whichever merges first, the other will need a rebase.
A few of the fixes in this PR are not present in #3885's version of the file:
the supported-version line, the
dispensersmistranslation, the two testcommands missing
run, and the plugin links that moved to this org. If #3885lands first, these would need to be carried over when resolving conflicts — I'm
happy to rebase this branch and do that. #3885 goes further than this PR in the
rest of the folder, covering
docs/zh/api.md,tutorial.md,FAQ.md,CONTRIBUTING.mdandhistory.md.Verification
npm run lint(standard && standard-markdown) passes locally. Heading count(23), unique link set (94) and list lengths now match the English README.