Update README.md #410
Update README.md #410
Conversation
WalkthroughThe changes include a minor whitespace addition to the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Browser
participant onError Function
User->>Browser: Interacts with page
Browser->>onError Function: Triggers error event
onError Function-->>Browser: Logs error to console by default (log=true)
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (4)
.npmrc (1)
4-4: Remove superfluous trailing whitespaceThe last line now contains a single space. Although harmless functionally, it introduces needless diff noise and may trigger lint checks in stricter CI setups.
-shell-emulator=true - +shell-emulator=true +index.html (2)
48-51: Log errors withconsole.error(and drop redundant arg)
- Defaulting
log = truemeans every captured error prints a stack trace in production, which is fine, but useconsole.errorso it shows up in browser error filters and preserves formatting.- Both global listeners still pass
true, which is now redundant.-const onError = (errorOrMessage, log = true) => { +const onError = (errorOrMessage, log = true) => { let message = errorOrMessage instanceof Error ? (errorOrMessage.stack ?? errorOrMessage.message) : errorOrMessage - if (log) console.log(message) + if (log) console.error(message)Optionally drop the explicit
truein the two listener callbacks for brevity.
127-129: Hard-coded background colour may clash with theme variables
bluevioletis burned into the stylesheet. Consider referencing a CSS custom property (var(--background-colour)) or class so theming/dark-mode toggles don’t require editing core HTML.No code change required if theming is out-of-scope.
README.MD (1)
13-13: Typo: “device-compatiiblity” → “device compatibility”-aimed for *device-compatiiblity* and better performance... +aimed for *device compatibility* and better performance...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.npmrc(1 hunks)README.MD(2 hunks)index.html(2 hunks)
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings
Learnt from: zardoy
PR: zardoy/minecraft-web-client#373
File: renderer/viewer/three/entities.ts:1120-1120
Timestamp: 2025-06-23T13:33:14.776Z
Learning: In the minecraft-web-client project, team information for entities should be inlined into entity update events from the world data emitter rather than accessing the global bot object from renderer code. This maintains better separation of concerns between the data layer and renderer.
Learnt from: zardoy
PR: zardoy/minecraft-web-client#373
File: renderer/viewer/three/entities.ts:1120-1120
Timestamp: 2025-06-23T13:33:14.776Z
Learning: In the minecraft-web-client project, files under renderer/ directory must not access the global `bot` variable directly according to .cursor/rules/vars-usage.mdc. The updateNameTagVisibility method in renderer/viewer/three/entities.ts currently violates this rule by accessing bot.teamMap and bot.username. Team information should be passed through entity update events from the world data emitter instead.
📚 Learning: in the minecraft-web-client project, team information for entities should be inlined into entity upd...
Learnt from: zardoy
PR: zardoy/minecraft-web-client#373
File: renderer/viewer/three/entities.ts:1120-1120
Timestamp: 2025-06-23T13:33:14.776Z
Learning: In the minecraft-web-client project, team information for entities should be inlined into entity update events from the world data emitter rather than accessing the global bot object from renderer code. This maintains better separation of concerns between the data layer and renderer.
Applied to files:
README.MD
📚 Learning: in the minecraft-web-client project, files under renderer/ directory must not access the global `bot...
Learnt from: zardoy
PR: zardoy/minecraft-web-client#373
File: renderer/viewer/three/entities.ts:1120-1120
Timestamp: 2025-06-23T13:33:14.776Z
Learning: In the minecraft-web-client project, files under renderer/ directory must not access the global `bot` variable directly according to .cursor/rules/vars-usage.mdc. The updateNameTagVisibility method in renderer/viewer/three/entities.ts currently violates this rule by accessing bot.teamMap and bot.username. Team information should be passed through entity update events from the world data emitter instead.
Applied to files:
README.MD
📚 Learning: the minecraft-web-client project uses core-js auto polyfill injection, which means newer javascript ...
Learnt from: zardoy
PR: zardoy/minecraft-web-client#391
File: renderer/viewer/three/threeJsUtils.ts:56-56
Timestamp: 2025-07-10T16:03:10.838Z
Learning: The minecraft-web-client project uses core-js auto polyfill injection, which means newer JavaScript features like Promise.withResolvers() are automatically polyfilled for compatibility across different environments.
Applied to files:
README.MD
📚 Learning: in the minecraft web client project, custom thenable objects are preferred over real promises in per...
Learnt from: zardoy
PR: zardoy/minecraft-web-client#319
File: renderer/viewer/lib/workerProxy.ts:61-73
Timestamp: 2025-04-12T00:33:34.518Z
Learning: In the Minecraft web client project, custom thenable objects are preferred over real Promises in performance-critical code paths (like worker communication) because they avoid creating unnecessary Promise objects and event listeners when results aren't awaited.
Applied to files:
README.MD
📚 Learning: for the minecraft web client, the developer has explicitly decided against encrypting authenticateda...
Learnt from: zardoy
PR: zardoy/minecraft-web-client#310
File: src/react/appStorageProvider.ts:38-39
Timestamp: 2025-03-14T17:16:50.962Z
Learning: For the Minecraft web client, the developer has explicitly decided against encrypting authenticatedAccounts in localStorage due to the inherent limitations of client-side encryption (where to securely store the encryption key) and the practical reality that determined attackers could break it anyway.
Applied to files:
README.MD
🪛 LanguageTool
README.MD
[style] ~13-~13: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...le, flexible and lightweight. It's also a very strong example on how to build true HTML games...
(EN_WEAK_ADJECTIVE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build-and-deploy
🔇 Additional comments (1)
README.MD (1)
59-64: Synchronise “First-class versions” with supported rangeYou expanded support to
1.21.7, but the first-class list still tops out at1.21.4. Either add1.21.7here or clarify why it’s excluded.
| @@ -1,14 +1,16 @@ | |||
| # Minecraft Web Client | |||
| 0# Minecraft Web Client | |||
There was a problem hiding this comment.
Fix header: stray leading 0
Markdown will render 0# literally; replace with a single #.
-0# Minecraft Web Client
+# Minecraft Web Client📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 0# Minecraft Web Client | |
| # Minecraft Web Client |
🤖 Prompt for AI Agents
In README.MD at line 1, the header starts with a stray leading '0' before the
'#' character, causing incorrect Markdown rendering. Remove the leading '0' so
the line begins with a single '#' to correctly format it as a header.
| Unlike most other PrismarineJS clients, this client allows you to use single player and multi-player inside single player worlds (similar to [Essential Mod](https://essential.gg) | ||
|
|
There was a problem hiding this comment.
Close the parenthesis after the Essential Mod link
The sentence opens a ( but never closes it.
-Unlike most other PrismarineJS clients, this client allows you to use single player and multi-player inside single player worlds (similar to [Essential Mod](https://essential.gg)
+Unlike most other PrismarineJS clients, this client allows you to use single-player and multi-player inside single-player worlds (similar to [Essential Mod](https://essential.gg))📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Unlike most other PrismarineJS clients, this client allows you to use single player and multi-player inside single player worlds (similar to [Essential Mod](https://essential.gg) | |
| Unlike most other PrismarineJS clients, this client allows you to use single-player and multi-player inside single-player worlds (similar to [Essential Mod](https://essential.gg)) |
🤖 Prompt for AI Agents
In README.MD around lines 7 to 8, the sentence containing the Essential Mod link
opens a parenthesis but does not close it. Add a closing parenthesis ')'
immediately after the link URL to properly close the parenthesis and fix the
sentence syntax.
| You can try this out at [mcraft.fun](https://mcraft.fun/), [pcm.gg](https://pcm.gg) (short link), [mcon.vercel.app](https://mcon.vercel.app/) or the GitHub pages deploy. Every commit from the default (`develop`) branch is deployed to [s.mcraft.fun](https://s.mcraft.fun/) and [s.pcm.gg](https://s.pcm.gg/) - so it's usually newer, but might be less stable. | ||
| Unlike most other PrismarineJS clients, this client allows you to use single player and multi-player inside single player worlds (similar to [Essential Mod](https://essential.gg) | ||
|
|
||
| You can try this out at [mcraft.fun](https://mcraft.fun/), [pcm.gg](https://pcm.gg) (short link), [mcon.vercel.app](https://mcon.vercel.app/) or [the GitHub pages deploy](https://zarody.github.io/minecraft-web-client). Every commit from the default (`develop`) branch is deployed to [s.mcraft.fun](https://s.mcraft.fun/) and [s.pcm.gg](https://s.pcm.gg/) - so it's usually newer, but might be less stable. |
There was a problem hiding this comment.
Broken GitHub Pages URL
zarody.github.io is miss-spelled; should be zardoy.github.io.
-... or [the GitHub pages deploy](https://zarody.github.io/minecraft-web-client).
+... or [the GitHub Pages deploy](https://zardoy.github.io/minecraft-web-client).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| You can try this out at [mcraft.fun](https://mcraft.fun/), [pcm.gg](https://pcm.gg) (short link), [mcon.vercel.app](https://mcon.vercel.app/) or [the GitHub pages deploy](https://zarody.github.io/minecraft-web-client). Every commit from the default (`develop`) branch is deployed to [s.mcraft.fun](https://s.mcraft.fun/) and [s.pcm.gg](https://s.pcm.gg/) - so it's usually newer, but might be less stable. | |
| You can try this out at [mcraft.fun](https://mcraft.fun/), [pcm.gg](https://pcm.gg) (short link), [mcon.vercel.app](https://mcon.vercel.app/) or [the GitHub Pages deploy](https://zardoy.github.io/minecraft-web-client). Every commit from the default (`develop`) branch is deployed to [s.mcraft.fun](https://s.mcraft.fun/) and [s.pcm.gg](https://s.pcm.gg/) - so it's usually newer, but might be less stable. |
🤖 Prompt for AI Agents
In README.MD at line 9, the GitHub Pages URL is misspelled as
"zarody.github.io". Correct the URL to "zardoy.github.io" to fix the broken
link.
|
This is not true, you can't connect to minecraft servers running only 1.21.5 or later |
2 participants
I noticed that there was a few non updated things in the README (such as that it said that it supported servers up to 1.21.4 when it actually supported up to 1.21.7.) Just a few minor updates.
Summary by CodeRabbit
New Features
Style
Documentation