Make README more consistent #432
Conversation
WalkthroughREADME.MD edited for wording, punctuation, link and deployment references; default branch changed from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.MD (1)
51-51: Tighten Opera Mini note phrasing.Suggest adding the article and hyphen so it reads smoothly: “to avoid opening a new tab on right-click hold”.
Apply this diff:
-**Opera Mini**: Disable *mouse gestures* in browser settings to avoid opening new tab on right click hold +**Opera Mini**: Disable *mouse gestures* in browser settings to avoid opening a new tab on right-click hold
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.MD(5 hunks)
🧰 Additional context used
🪛 LanguageTool
README.MD
[grammar] ~11-~11: Ensure spelling is correct
Context: ...nwhile this project is aimed for device-compatiiblity and better performance so it feels por...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~11-~11: 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)
[grammar] ~51-~51: There might be a mistake here.
Context: ... gestures* in browser settings to avoid opening new tab on right click hold *Vivaldi...
(QB_NEW_EN)
[grammar] ~51-~51: Use a hyphen to join words.
Context: ...ttings to avoid opening new tab on right click hold Vivaldi: Disable Control...
(QB_NEW_EN_HYPHEN)
[grammar] ~222-~222: Ensure spelling is correct
Context: ...ications with the server (including the builtin one) - [Forked Flying Squid (Space Squi...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~236-~236: There might be a mistake here.
Context: ...lassiCube) - Better C# Rewrite [DEMO] - Eaglercraft -...
(QB_NEW_EN)
[grammar] ~237-~237: There might be a mistake here.
Context: ... Real Minecraft in the browser [DEMO] - [js-minecraft](https://github.com/LabyStu...
(QB_NEW_EN)
[grammar] ~238-~238: Use a hyphen to join words.
Context: ...yStudio/js-minecraft) - An insanely well done clone from the graphical side that ...
(QB_NEW_EN_HYPHEN)
[grammar] ~238-~238: There might be a mistake here.
Context: ...at inspired many features here [DEMO]
(QB_NEW_EN)
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.MD (1)
1-238: A few extra stray typos elsewhere.Quick fixes to keep the README polished.
- - even even more! + - even more! - When you connect connect to a server with a proxy, websocket connection is created... + When you connect to a server with a proxy, a WebSocket connection is created... - ..., it wont't reload the page, but you will see a button ... + ..., it won't reload the page, but you will see a button ...
🧹 Nitpick comments (4)
README.MD (4)
11-11: Optional style polish (tone/flow).Consider tightening “meanwhile” and “example on how”.
-... fully playable solution, meanwhile this project is aimed for *device-compatibility* and better performance ... -... It's also a very strong example on how to build true HTML games ... +... fully playable solution, whereas this project is aimed at *device-compatibility* and better performance ... +... It's also a strong example of how to build true HTML games ...
15-15: End sentence with a period.Consistency with surrounding prose.
-> **Note**: You can deploy it on your own server in less than a minute using a one-liner script from the [Minecraft Everywhere repo](https://github.com/zardoy/minecraft-everywhere) +> **Note**: You can deploy it on your own server in less than a minute using a one-liner script from the [Minecraft Everywhere repo](https://github.com/zardoy/minecraft-everywhere).
155-155: Commented‑out keybinding entry.Either remove it to reduce clutter or add a brief note why it’s hidden.
-<!-- - `F3 + N` - Restart local server (basically resets the world!) --> +<!-- Intentionally hidden: `F3 + N` – Restart local server (resets the world) -->Or delete the line entirely.
236-238: Minor phrasing/hyphenation in Alternatives.Optional polish; keeps tone neutral and consistent.
-- [ClassiCube](https://github.com/ClassiCube/ClassiCube) - Better C# Rewrite [\[DEMO\]](https://www.classicube.net/server/play/?warned=true) +- [ClassiCube](https://github.com/ClassiCube/ClassiCube) - C# rewrite [\[DEMO\]](https://www.classicube.net/server/play/?warned=true) -- [Eaglercraft](https://eaglercraft.com/) - Real Minecraft in the browser [\[DEMO\]](https://eaglercraft.com/mc/1.8.8-wasm) +- [Eaglercraft](https://eaglercraft.com/) - Java Edition in the browser [\[DEMO\]](https://eaglercraft.com/mc/1.8.8-wasm) -- [js-minecraft](https://github.com/LabyStudio/js-minecraft) - An insanely well done clone from the graphical side that inspired many features here [\[DEMO\]](https://labystudio.github.io/js-minecraft/) +- [js-minecraft](https://github.com/LabyStudio/js-minecraft) - A well‑done clone from the graphical side that inspired many features here [\[DEMO\]](https://labystudio.github.io/js-minecraft/)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.MD(5 hunks)
🧰 Additional context used
🪛 LanguageTool
README.MD
[style] ~11-~11: 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)
[grammar] ~51-~51: There might be a mistake here.
Context: ... gestures* in browser settings to avoid opening new tab on right click hold *Vivaldi...
(QB_NEW_EN)
[grammar] ~51-~51: Use a hyphen to join words.
Context: ...ttings to avoid opening new tab on right click hold Vivaldi: Disable Control...
(QB_NEW_EN_HYPHEN)
[grammar] ~222-~222: Ensure spelling is correct
Context: ...ications with the server (including the builtin one) - [Forked Flying Squid (Space Squi...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~236-~236: There might be a mistake here.
Context: ...lassiCube) - Better C# Rewrite [DEMO] - Eaglercraft -...
(QB_NEW_EN)
[grammar] ~237-~237: There might be a mistake here.
Context: ... Real Minecraft in the browser [DEMO] - [js-minecraft](https://github.com/LabyStu...
(QB_NEW_EN)
[grammar] ~238-~238: Use a hyphen to join words.
Context: ...yStudio/js-minecraft) - An insanely well done clone from the graphical side that ...
(QB_NEW_EN_HYPHEN)
[grammar] ~238-~238: There might be a mistake here.
Context: ...at inspired many features here [DEMO]
(QB_NEW_EN)
⏰ 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 (2)
README.MD (2)
5-5: LGTM on intro sentence.Clear and accurate phrasing; “vanilla-compatible” is correct.
9-9: Regional note reads well.Wording is clearer now.
README.MD
Outdated
| Howerver, it's known that these browsers have issues: | ||
|
|
||
| **Opera Mini**: Disable *mouse gestures* in browsre settings to avoid opening new tab on right click hold | ||
| **Opera Mini**: Disable *mouse gestures* in browser settings to avoid opening new tab on right click hold | ||
|
|
||
| **Vivaldi**: Disable Controls -> *Raw Input* in game settings if experiencing issues |
There was a problem hiding this comment.
Opera Mini note: add article and hyphenate “right‑click‑and‑hold”. Also fix “However”.
Two tiny grammar nits; improves readability.
-Howerver, it's known that these browsers have issues:
+However, it's known that these browsers have issues:
-**Opera Mini**: Disable *mouse gestures* in browser settings to avoid opening new tab on right click hold
+**Opera Mini**: Disable *mouse gestures* in browser settings to avoid opening a new tab on right‑click‑and‑hold📝 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.
| Howerver, it's known that these browsers have issues: | |
| **Opera Mini**: Disable *mouse gestures* in browsre settings to avoid opening new tab on right click hold | |
| **Opera Mini**: Disable *mouse gestures* in browser settings to avoid opening new tab on right click hold | |
| **Vivaldi**: Disable Controls -> *Raw Input* in game settings if experiencing issues | |
| However, it's known that these browsers have issues: | |
| **Opera Mini**: Disable *mouse gestures* in browser settings to avoid opening a new tab on right-click-and-hold | |
| **Vivaldi**: Disable Controls -> *Raw Input* in game settings if experiencing issues |
🧰 Tools
🪛 LanguageTool
[grammar] ~51-~51: There might be a mistake here.
Context: ... gestures* in browser settings to avoid opening new tab on right click hold *Vivaldi...
(QB_NEW_EN)
[grammar] ~51-~51: Use a hyphen to join words.
Context: ...ttings to avoid opening new tab on right click hold Vivaldi: Disable Control...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In README.MD around lines 49 to 53, fix the three tiny grammar/readability
issues: correct "Howerver" to "However", add the definite article "the" before
"Opera Mini" note (e.g., "In the Opera Mini"), and hyphenate the phrase to
"right-click-and-hold" so the Opera Mini sentence reads clearly; update the
Vivaldi line only if needed for consistency but no other changes.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (5)
README.MD (5)
83-84: Typo: duplicated word “connect”.-When you connect connect to a server with a proxy, websocket connection is created between you ... +When you connect to a server with a proxy, websocket connection is created between you ...
120-121: Typo: “wont't” → “won’t”.-..., you can type `#dev` in the URL (browser address bar), it wont't reload the page, but you will see a button ... +..., you can type `#dev` in the URL (browser address bar), it won't reload the page, but you will see a button ...
67-67: Hyphenate “read-only”.-You can open folders in readonly and read-write mode. New chunks may be generated incorrectly for now. +You can open folders in read-only and read-write mode. New chunks may be generated incorrectly for now.
130-132: Grammar: “will enable”; simplify “packet spam”.-- If you type `debugToggle`, press enter in console - It will enables all debug messages! Warning: this will start all packets spam. +- If you type `debugToggle`, press Enter in the console — it will enable all debug messages! Warning: this will start packet spam.
176-180: Typos: “then” → “when”; spacing; “embedded iframes”.-- `?proxy=<proxy_address>` - Set the proxy server address to use for the server +- `?proxy=<proxy_address>` - Set the proxy server address to use for the server-- `?lockConnect=true` - Only works then `ip` parameter is set. Disables cancel/save buttons and all inputs in the connect screen already set as parameters. Useful for integrates iframes. +- `?lockConnect=true` - Only works when the `ip` parameter is set. Disables cancel/save buttons and all inputs in the connect screen already set as parameters. Useful for embedded iframes.-- `?autoConnect=true` - Only works then `ip` and `version` parameters are set and `allowAutoConnect` is `true` in config.json! Directly connects to the specified server. Useful for integrates iframes. +- `?autoConnect=true` - Only works when the `ip` and `version` parameters are set and `allowAutoConnect` is `true` in config.json. Directly connects to the specified server. Useful for embedded iframes.
♻️ Duplicate comments (2)
README.MD (2)
7-7: Capitalize and use “deployment” (repeat from earlier review).Use “GitHub Pages deployment” for correctness and consistency.
-..., or the GitHub pages deploy. Every commit from the default (`next`) branch is deployed to ... +..., or the GitHub Pages deployment. Every commit from the default (`next`) branch is deployed to ...
49-53: Fix “However” and hyphenate/right‑click note (repeat).Correct the misspelling and improve the Opera Mini sentence.
-Howerver, it's known that these browsers have issues: +However, it's known that these browsers have issues: -**Opera Mini**: Disable *mouse gestures* in browser settings to avoid opening new tab on right click hold +**Opera Mini**: Disable *mouse gestures* in browser settings to avoid opening a new tab on right-click-and-hold
🧹 Nitpick comments (7)
README.MD (7)
9-10: Clarity: “Turkey or Russia”.Minor readability tweak.
-> In Turkey/Russia, use [ru.mcraft.fun](https://ru.mcraft.fun/) (since Cloudflare is blocked) +> In Turkey or Russia, use [ru.mcraft.fun](https://ru.mcraft.fun/) (since Cloudflare is blocked)
15-16: Punctuation: end note with a period.-> **Note**: You can deploy it on your own server in less than a minute using a one-liner script from the [Minecraft Everywhere repo](https://github.com/zardoy/minecraft-everywhere) +> **Note**: You can deploy it on your own server in less than a minute using a one-liner script from the [Minecraft Everywhere repo](https://github.com/zardoy/minecraft-everywhere).
67-69: Capitalization/units: iOS, MB, RAM.-In case of opening zip files they are stored in your ram entirely, so there is a ~300mb file limit on IOS. +In case of opening zip files they are stored in your RAM entirely, so there is a ~300 MB file limit on iOS.
29-29: Hyphenate “built‑in”.Make spelling consistent.
-- Builtin JEI with recipes & descriptions for almost every item (JEI is creative inventory replacement) +- Built-in JEI with recipes & descriptions for almost every item (JEI is creative inventory replacement)-- [Forked Flying Squid (Space Squid)](https://github.com/zardoy/space-squid) - The builtin offline server that makes single player & P2P possible! +- [Forked Flying Squid (Space Squid)](https://github.com/zardoy/space-squid) - The built-in offline server that makes single player & P2P possible!Also applies to: 223-223
33-34: Remove duplicate word.-- even even more! +- and even more!
236-238: Minor copyedits in Alternatives.-- [ClassiCube](https://github.com/ClassiCube/ClassiCube) - Better C# Rewrite [\[DEMO\]](https://www.classicube.net/server/play/?warned=true) +- [ClassiCube](https://github.com/ClassiCube/ClassiCube) - Better C# rewrite [\[DEMO\]](https://www.classicube.net/server/play/?warned=true)-- [js-minecraft](https://github.com/LabyStudio/js-minecraft) - An insanely well done clone from the graphical side that inspired many features here [\[DEMO\]](https://labystudio.github.io/js-minecraft/) +- [js-minecraft](https://github.com/LabyStudio/js-minecraft) - An insanely well‑done clone from the graphical side that inspired many features here [\[DEMO\]](https://labystudio.github.io/js-minecraft/)
11-11: Unify Eaglercraft link
Replacehttps://eagsrc.webmc.xyzwith the officialhttps://eaglercraft.com/in the README to maintain consistency.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.MD(5 hunks)
🧰 Additional context used
🪛 LanguageTool
README.MD
[style] ~11-~11: 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)
[grammar] ~51-~51: There might be a mistake here.
Context: ... gestures* in browser settings to avoid opening new tab on right click hold *Vivaldi...
(QB_NEW_EN)
[grammar] ~51-~51: Use a hyphen to join words.
Context: ...ttings to avoid opening new tab on right click hold Vivaldi: Disable Control...
(QB_NEW_EN_HYPHEN)
[grammar] ~236-~236: There might be a mistake here.
Context: ...lassiCube) - Better C# Rewrite [DEMO] - Eaglercraft -...
(QB_NEW_EN)
[grammar] ~237-~237: There might be a mistake here.
Context: ... Real Minecraft in the browser [DEMO] - [js-minecraft](https://github.com/LabyStu...
(QB_NEW_EN)
[grammar] ~238-~238: Use a hyphen to join words.
Context: ...yStudio/js-minecraft) - An insanely well done clone from the graphical side that ...
(QB_NEW_EN_HYPHEN)
[grammar] ~238-~238: There might be a mistake here.
Context: ...at inspired many features here [DEMO]
(QB_NEW_EN)
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (12)
README.MD (12)
5-5: Minor article polish for flowSuggest adding articles for smoother reading.
-Minecraft **clone** written in TypeScript using the best modern web technologies. Minecraft vanilla-compatible client and integrated server packaged into a single web app. +Minecraft **clone** written in TypeScript using the best modern web technologies. A vanilla-compatible client and an integrated server packaged into a single web app.
11-11: Tighten phrasing (“aimed at”; tone)-... meanwhile this project is aimed for *device-compatibility* and better performance ... +... meanwhile this project is aimed at *device-compatibility* and better performance ... -It's also a very strong example on how to build true HTML games... +It's also a strong example of how to build HTML games...
28-28: JEI parenthetical: add article and hyphenate-- Built-in JEI with recipes & descriptions for almost every item (JEI is creative inventory replacement) +- Built-in JEI with recipes & descriptions for almost every item (JEI is a creative-inventory replacement)
33-33: Tone tweak (optional)-- and even more! +- and more!
49-51: Browser notes punctuation consistency
Add terminal periods to bullet sentences for consistency (Vivaldi line too).-**Opera Mini**: Disable *mouse gestures* in browser settings to avoid opening a new tab on right-click-and-hold +**Opera Mini**: Disable *mouse gestures* in browser settings to avoid opening a new tab on right-click-and-hold.Also consider adding a period to Line 53.
67-68: Capitalization and parallelism (ZIP/RAM; modes)-You can open folders in read-only and read-write mode. New chunks may be generated incorrectly for now. +You can open folders in read-only or read-write modes. New chunks may be generated incorrectly for now. -When opening zip files, they are stored in your ram entirely. There is a ~300 MB file limit on iOS. +When opening ZIP files, they are stored entirely in your RAM. There is a ~300 MB file limit on iOS.
77-77: Fix grammar (“host your own!”) and small casing nit-There is a built-in proxy, but you can also host your one! Just clone the repo, run `pnpm i` (following CONTRIBUTING.MD) and run `pnpm prod-start`, then you can specify `http://localhost:8080` in the proxy field. Or you can deploy it to the cloud service: +There is a built-in proxy, but you can also host your own! Just clone the repo, run `pnpm i` (see CONTRIBUTING.md), and run `pnpm prod-start`. Then you can specify `http://localhost:8080` in the proxy field. Or you can deploy it to a cloud service:
83-83: Networking terminology and commas
Capitalize WebSocket; add “the” before TCP; add comma after “That said,”.-Proxy servers are used to connect to Minecraft servers which use TCP protocol. When you connect to a server with a proxy, a websocket connection is created between you (browser client) and the proxy server, then the proxy connects to the Minecraft server and sends the data to the client (you) without any packet deserialization to avoid any additional delays. That said all the Minecraft protocol packets are processed by the client, right in your browser. +Proxy servers are used to connect to Minecraft servers that use the TCP protocol. When you connect to a server with a proxy, a WebSocket connection is created between you (browser client) and the proxy server; then the proxy connects to the Minecraft server and sends the data to the client (you) without any packet deserialization to avoid additional delays. That said, all Minecraft protocol packets are processed by the client, right in your browser.
120-120: Split run-on sentence for readability-To open the console, press `F12`, or if you are on mobile, you can type `#dev` in the URL (browser address bar), it won't reload the page, but you will see a button to open the console. This way you can change advanced settings and see all errors or warnings. Also this way you can access global variables (described below). +To open the console, press `F12`. On mobile, type `#dev` in the URL (address bar); the page won’t reload, and you’ll see a button to open the console. This lets you change advanced settings and see all errors or warnings. You can also access global variables (described below).
130-131: Minor punctuation and clarity-- If you type `debugToggle`, press Enter in the console — it will enable all debug messages! Warning: this will start packet spam. -Instead I recommend setting `options.debugLogNotFrequentPackets`. You can also use `debugTopPackets` (with JSON.stringify) to see what packets were received/sent by name +- If you type `debugToggle` and press Enter in the console — it will enable all debug messages! Warning: this will start packet spam. +Instead, I recommend setting `options.debugLogNotFrequentPackets`. You can also use `debugTopPackets` (with `JSON.stringify`) to see which packets were received/sent by name.
179-179: Wording: “embedded iframes”-- `?autoConnect=true` - Only works when the `ip` and `version` parameters are set and `allowAutoConnect` is `true` in config.json! Directly connects to the specified server. Useful for integrates iframes. +- `?autoConnect=true` - Only works when the `ip` and `version` parameters are set and `allowAutoConnect` is `true` in config.json. Directly connects to the specified server. Useful for embedded iframes.
222-223: Consistency: “singleplayer” usage-- [Forked Flying Squid (Space Squid)](https://github.com/zardoy/space-squid) - The built-in offline server that makes single player & P2P possible! +- [Forked Flying Squid (Space Squid)](https://github.com/zardoy/space-squid) - The built-in offline server that makes singleplayer & P2P possible!
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.MD(11 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-07-10T16:03:10.838Z
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
🪛 LanguageTool
README.MD
[style] ~11-~11: 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)
[grammar] ~28-~28: There might be a mistake here.
Context: ...descriptions for almost every item (JEI is creative inventory replacement) - Custo...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...odels in the world) - Play with friends over internet! (P2P is powered by Peer.js di...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...ding / saving worlds back to the cloud~~ - Support for custom rendering 3D engines....
(QB_NEW_EN)
[grammar] ~223-~223: There might be a mistake here.
Context: ...that makes single player & P2P possible! - [Prismarine Provider Anvil](https://githu...
(QB_NEW_EN)
⏰ 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 (5)
README.MD (5)
7-7: LGTM: deployment note and capitalization look correct
9-9: LGTM: regional access note reads clearly
15-15: LGTM: quick deploy note reads well
176-176: LGTM: query param description is clear
236-238: LGTM: Alternatives list looks good
README.MD
Outdated
| You can try this out at [mcraft.fun](https://mcraft.fun/), [pcm.gg](https://pcm.gg), [mcon.vercel.app](https://mcon.vercel.app/), or the GitHub Pages deployment. Every commit from the default (`next`) branch is deployed to [s.mcraft.fun](https://s.mcraft.fun/) and [s.pcm.gg](https://s.pcm.gg/) - it's usually newer, but might be less stable. | ||
|
|
||
| > For Turkey/Russia use [ru.mcraft.fun](https://ru.mcraft.fun/) (since Cloudflare is blocked) | ||
| > In Turkey or Russia, use [ru.mcraft.fun](https://ru.mcraft.fun/) (since Cloudflare is blocked) | ||
| Don't confuse with [Eaglercraft](https://git.eaglercraft.rip/eaglercraft/eaglercraft-1.8) which is a REAL vanilla Minecraft Java edition port to the web (but with its own limitations). Eaglercraft is a fully playable solution, meanwhile this project is aimed for *device-compatiiblity* and better performance so it feels portable, flexible and lightweight. It's also a very strong example on how to build true HTML games for the web at scale entirely with the JS ecosystem. Have fun! | ||
| Don't confuse this with [Eaglercraft](https://eagsrc.webmc.xyz) which is a REAL vanilla Minecraft Java Edition port to the web (but with its own limitations). Eaglercraft is a fully playable solution, meanwhile this project is aimed for *device-compatibility* and better performance so it feels portable, flexible and lightweight. It's also a very strong example on how to build true HTML games for the web at scale entirely with the JS ecosystem. Have fun! |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
🧩 Analysis chain
Optional: verify external links return 200/OK
Run this to check link health for the URLs changed/touched in this PR. It prints status codes and highlights failures.
Also applies to: 28-28, 67-68, 77-77, 83-83, 179-179, 222-223
🏁 Script executed:
#!/bin/bash
set -euo pipefail
urls=(
"https://mcraft.fun/"
"https://pcm.gg"
"https://mcon.vercel.app/"
"https://s.mcraft.fun/"
"https://s.pcm.gg/"
"https://ru.mcraft.fun/"
"https://eagsrc.webmc.xyz"
"https://npmjs.com/minecraft-react"
"https://minimap.mcraft.fun/storybook/"
"https://app.koyeb.com/deploy?name=minecraft-web-client&type=git&repository=zardoy%2Fminecraft-web-client&branch=next&builder=dockerfile&env%5B%5D=&ports=8080%3Bhttp%3B%2F"
"https://github.com/zardoy/mwc-proxy"
"https://peerjs.com/"
"https://github.com/PrismarineJS/mineflayer"
"https://github.com/zardoy/space-squid"
"https://webmc.xyz/"
"https://labystudio.github.io/js-minecraft/"
)
for u in "${urls[@]}"; do
code=$(curl -LIs -o /dev/null -w '%{http_code}' "$u" || echo "000")
echo "$code $u"
done | awk '{code=$1; $1=""; url=$0; if (code ~ /^2/ || code ~ /^3/) {ok="OK"} else {ok="FAIL"}; printf "%-5s %s\n", ok, url}'Length of output: 701
Broken npmjs.com/minecraft-react link in README
The npmjs.com/minecraft-react URL returns a non-2xx status; update or remove it from README.MD at all occurrences (lines 7–11, 28, 67–68, 77, 83, 179, 222–223).
🧰 Tools
🪛 LanguageTool
[style] ~11-~11: 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)
🤖 Prompt for AI Agents
In README.MD around lines 7–11 (and also at lines 28, 67–68, 77, 83, 179,
222–223), the npmjs.com/minecraft-react link is broken; locate every occurrence
listed and either remove the npmjs.com/minecraft-react URL or replace it with a
valid alternative (or plain text mention) consistently across the file, ensuring
any surrounding punctuation and sentence flow remain correct and that no
residual broken URL text remains.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
README.MD (1)
35-35: Fix npm link forminecraft-react.
https://npmjs.com/minecraft-reactstill resolves to a non-OK response. Please point the README at the package URL that actually works.Apply this diff:
-- [`minecraft-react`](https://npmjs.com/minecraft-react) +- [`minecraft-react`](https://www.npmjs.com/package/minecraft-react)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.MD(10 hunks)
🧰 Additional context used
🪛 LanguageTool
README.MD
[grammar] ~30-~30: There might be a mistake here.
Context: ...odels in the world) - Play with friends over internet! (P2P is powered by Peer.js di...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...ding / saving worlds back to the cloud~~ - Support for custom rendering 3D engines....
(QB_NEW_EN)
[grammar] ~69-~69: There might be a mistake here.
Context: ...der, just singleplayer), you can always export world with the /export command typed ...
(QB_NEW_EN)
[grammar] ~75-~75: There might be a mistake here.
Context: ...er, vanilla servers are fully supported. See the [Mineflayer](https://github.com/...
(QB_NEW_EN)
[grammar] ~76-~76: There might be a mistake here.
Context: ... the list of supported versions (should support majority of versions). There is a built...
(QB_NEW_EN)
[grammar] ~76-~76: There might be a mistake here.
Context: ...s (should support majority of versions). There is a built-in proxy, but you can a...
(QB_NEW_EN)
[grammar] ~171-~171: Use a hyphen to join words.
Context: ... file must be CORS enabled. Multiplayer specific: - ?ip=<server_address> - Di...
(QB_NEW_EN_HYPHEN)
[grammar] ~173-~173: There might be a mistake here.
Context: ...r specific: - ?ip=<server_address> - Display connect screen to the server on load wi...
(QB_NEW_EN)
[grammar] ~173-~173: There might be a mistake here.
Context: ...ay connect screen to the server on load with predefined server ip. :<port> is opti...
(QB_NEW_EN)
[grammar] ~180-~180: There might be a mistake here.
Context: ...h the same format (array) or a txt file with line-delimited list of server IPs. - `?...
(QB_NEW_EN)
[grammar] ~181-~181: Ensure spelling is correct
Context: ...es. For example ?addPing=100 will add 200ms to your ping. Singleplayer specific: ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~223-~223: There might be a mistake here.
Context: ... that makes singleplayer & P2P possible! - [Prismarine Provider Anvil](https://githu...
(QB_NEW_EN)
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.MD(10 hunks)
🧰 Additional context used
🪛 LanguageTool
README.MD
[grammar] ~30-~30: There might be a mistake here.
Context: ...odels in the world) - Play with friends over internet! (P2P is powered by Peer.js di...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...ding / saving worlds back to the cloud~~ - Support for custom rendering 3D engines....
(QB_NEW_EN)
[grammar] ~69-~69: There might be a mistake here.
Context: ...der, just singleplayer), you can always export world with the /export command typed ...
(QB_NEW_EN)
[grammar] ~75-~75: There might be a mistake here.
Context: ...er, vanilla servers are fully supported. See the [Mineflayer](https://github.com/...
(QB_NEW_EN)
[grammar] ~76-~76: There might be a mistake here.
Context: ... the list of supported versions (should support majority of versions). There is a built...
(QB_NEW_EN)
[grammar] ~76-~76: There might be a mistake here.
Context: ...s (should support majority of versions). There is a built-in proxy, but you can a...
(QB_NEW_EN)
[grammar] ~171-~171: Use a hyphen to join words.
Context: ... file must be CORS enabled. Multiplayer specific: - ?ip=<server_address> - Di...
(QB_NEW_EN_HYPHEN)
[grammar] ~173-~173: There might be a mistake here.
Context: ...r specific: - ?ip=<server_address> - Display connect screen to the server on load wi...
(QB_NEW_EN)
[grammar] ~173-~173: There might be a mistake here.
Context: ...ay connect screen to the server on load with predefined server ip. :<port> is opti...
(QB_NEW_EN)
[grammar] ~180-~180: There might be a mistake here.
Context: ...h the same format (array) or a txt file with line-delimited list of server IPs. - `?...
(QB_NEW_EN)
[grammar] ~181-~181: Ensure spelling is correct
Context: ...es. For example ?addPing=100 will add 200ms to your ping. Singleplayer specific: ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~223-~223: There might be a mistake here.
Context: ... that makes singleplayer & P2P possible! - [Prismarine Provider Anvil](https://githu...
(QB_NEW_EN)
⏰ 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
| Whatever offline mode you used (zip, folder, just single player), you can always export world with the `/export` command typed in the game chat. | ||
| Zip files and folders are supported. Just drag and drop them into the browser window. You can open folders in read-only or read-write mode. New chunks may be generated incorrectly for now. | ||
| When opening zip files, they are stored entirely in your RAM. There is a ~300 MB file limit on iOS. | ||
| Whatever offline mode you used (zip, folder, just singleplayer), you can always export world with the `/export` command typed in the game chat. |
There was a problem hiding this comment.
Add the missing article before “world”.
“For now” sentence should read “export the world” to stay grammatically correct.
🧰 Tools
🪛 LanguageTool
[grammar] ~69-~69: There might be a mistake here.
Context: ...der, just singleplayer), you can always export world with the /export command typed ...
(QB_NEW_EN)
🤖 Prompt for AI Agents
In README.MD around line 69, the sentence "you can always export world with the
`/export` command typed in the game chat." is missing the article "the"; change
it to "you can always export the world with the `/export` command typed in the
game chat." to correct the grammar.
| > **Note**: If you want to make **your own** Minecraft server accessible to web clients (without our proxies), you can use [mwc-proxy](https://github.com/zardoy/mwc-proxy) - a lightweight JS WebSocket proxy that runs on the same server as your Minecraft server, allowing players to connect directly via `wss://play.example.com`. `?client_mcraft` is added to the URL, so the proxy will know that it's this client. | ||
| Proxy servers are used to connect to Minecraft servers which use TCP protocol. When you connect connect to a server with a proxy, websocket connection is created between you (browser client) and the proxy server located in Europe, then the proxy connects to the Minecraft server and sends the data to the client (you) without any packet deserialization to avoid any additional delays. That said all the Minecraft protocol packets are processed by the client, right in your browser. | ||
| Proxy servers are used to connect to Minecraft servers that use the TCP protocol. When you connect to a server with a proxy, a WebSocket connection is created between you (browser client) and the proxy server; then the proxy connects to the Minecraft server and sends the data to the client (you) without any packet deserialization to avoid additional delays. That said all Minecraft protocol packets are processed by the client, right in your browser. |
There was a problem hiding this comment.
Insert a comma after “That said”.
Introductory phrase needs a comma: “That said, all Minecraft protocol packets…”.
🤖 Prompt for AI Agents
In README.MD around line 83, the sentence "That said all Minecraft protocol
packets are processed by the client, right in your browser." is missing a comma
after the introductory phrase; edit the line to insert a comma so it reads "That
said, all Minecraft protocol packets are processed by the client, right in your
browser."
| You can try this out at [mcraft.fun](https://mcraft.fun/), [pcm.gg](https://pcm.gg), [mcon.vercel.app](https://mcon.vercel.app/), or the GitHub Pages deployment. Every commit from the default (`next`) branch is deployed to [s.mcraft.fun](https://s.mcraft.fun/) and [s.pcm.gg](https://s.pcm.gg/) - it's usually newer, but might be less stable. | ||
|
|
||
| > For Turkey/Russia use [ru.mcraft.fun](https://ru.mcraft.fun/) (since Cloudflare is blocked) | ||
| > In Turkey or Russia, use [ru.mcraft.fun](https://ru.mcraft.fun/) (since Cloudflare is blocked) |
There was a problem hiding this comment.
| > In Turkey or Russia, use [ru.mcraft.fun](https://ru.mcraft.fun/) (since Cloudflare is blocked) | |
| > In Turkey or Russia, use [ru.mcraft.fun](https://github.mcraft.fun/) (since Cloudflare is blocked) |
| - `F3` - Toggle debug overlay | ||
| - `F3 + A` - Reload all chunks (these that are loaded from the server) | ||
| <!-- <!-- - `F3 + N` - Restart local server (basically resets the world!) --> | ||
| <!-- - `F3 + N` - Restart local server (basically resets the world!) --> |
|
I always wanted to do it. TYSM for making main page of the project much cleaner 🙏 |
2 participants
Reword some things, fix invalid links, and make it a bit cleaner.
Summary by CodeRabbit