Skip to content

Commit 1152652

Browse files
authored
Make README more consistent
1 parent 253e094 commit 1152652

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.MD

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

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

5-
Minecraft **clone** rewritten in TypeScript using the best modern web technologies. Minecraft vanilla-compatible client and integrated server packaged into a single web app.
5+
Minecraft **clone** written in TypeScript using the best modern web technologies. Minecraft vanilla-compatible client and integrated server packaged into a single web app.
66

7-
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.
7+
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 (`develop`) 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.
88

9-
> For Turkey/Russia use [ru.mcraft.fun](https://ru.mcraft.fun/) (since Cloudflare is blocked)
9+
> In Turkey/Russia, use [ru.mcraft.fun](https://ru.mcraft.fun/) (since Cloudflare is blocked)
1010
11-
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!
11+
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!
1212

1313
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).
1414

15-
> **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)
15+
> **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)
1616
1717
### Big Features
1818

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

4949
Howerver, it's known that these browsers have issues:
5050

51-
**Opera Mini**: Disable *mouse gestures* in browsre settings to avoid opening new tab on right click hold
51+
**Opera Mini**: Disable *mouse gestures* in browser settings to avoid opening new tab on right click hold
5252

5353
**Vivaldi**: Disable Controls -> *Raw Input* in game settings if experiencing issues
5454

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

152152
- `F3` - Toggle debug overlay
153153
- `F3 + A` - Reload all chunks (these that are loaded from the server)
154-
<!-- <!-- - `F3 + N` - Restart local server (basically resets the world!) -->
154+
<!-- - `F3 + N` - Restart local server (basically resets the world!) -->
155155
- `F3 + G` - Toggle chunk sections (geometries) border visibility + entities outline (aka Three.js geometry helpers)
156156

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

220220
### Notable Things that Power this Project
221221

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

234234
### Alternatives
235235

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

0 commit comments

Comments
 (0)