Skip to content

Make README more consistent #432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Oct 15, 2025
Merged

Make README more consistent #432

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1152652
Make README more consistent
colbster937 Oct 14, 2025
0f81613
Fix old branch reference
colbster937 Oct 14, 2025
7060ce5
fix typo
colbster937 Oct 14, 2025
801bcc9
Hyphenate "built‑in"
colbster937 Oct 14, 2025
ce66c56
Address more comments by coderabbitai
colbster937 Oct 14, 2025
fa9b045
ok i think this should be fine atp
colbster937 Oct 14, 2025
c6cf7f1
fix typo
colbster937 Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

![banner](./docs-assets/banner.jpg)

Minecraft **clone** rewritten 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. Minecraft vanilla-compatible client and integrated server packaged into a single web app.

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.
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 deploy. 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/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-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!

For building the project yourself / contributing, see [Development, Debugging & Contributing](#development-debugging--contributing). For reference at what and how web technologies / frameworks are used, see [TECH.md](./TECH.md) (also for comparison with Eaglercraft).

> **Note**: You can deploy it on your own server in less than a minute using a one-liner script from [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)

### Big Features

Expand Down Expand Up @@ -48,7 +48,7 @@ This project is tested with BrowserStack. Special thanks to [BrowserStack](https

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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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.

Suggested change
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.


Expand Down Expand Up @@ -151,7 +151,7 @@ You can also drag and drop any .dat or .mca (region files) into the browser wind

- `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!) -->
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can remove it

- `F3 + G` - Toggle chunk sections (geometries) border visibility + entities outline (aka Three.js geometry helpers)

world chunks have a *yellow* border, hostile mobs have a *red* outline, passive mobs have a *green* outline, players have a *blue* outline.
Expand Down Expand Up @@ -219,7 +219,7 @@ Only during development:

### Notable Things that Power this Project

- [Mineflayer](https://github.com/PrismarineJS/mineflayer) - Handles all client-side communications with the server (including the builtin one) - forked
- [Mineflayer](https://github.com/PrismarineJS/mineflayer) - Handles all client-side communications with the server (including the builtin one)
- [Forked Flying Squid (Space Squid)](https://github.com/zardoy/space-squid) - The builtin offline server that makes single player & P2P possible!
- [Prismarine Provider Anvil](https://github.com/PrismarineJS/prismarine-provider-anvil) - Handles world loading (region format)
- [Prismarine Physics](https://github.com/PrismarineJS/prismarine-physics) - Does all the physics calculations
Expand All @@ -233,6 +233,6 @@ Only during development:

### Alternatives

- [https://github.com/ClassiCube/ClassiCube](ClassiCube - Better C# Rewrite) [DEMO](https://www.classicube.net/server/play/?warned=true)
- [https://m.eaglercraft.com/](EaglerCraft) - Eaglercraft runnable on mobile (real Minecraft in the browser)
- [js-minecraft](https://github.com/LabyStudio/js-minecraft) - An insanely well done clone from the graphical side that inspired many features here
- [ClassiCube](https://github.com/ClassiCube/ClassiCube) - Better 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)
- [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/)
Loading