Skip to content

Commit 3e18e75

Browse files
committed
docs: update README.md [ci skip]
1 parent e9524ac commit 3e18e75

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,33 @@ C^2M-Engine, or C2ME for short, is a Fabric mod designed to improve the performa
1414
## What does C2ME stand for?
1515
Concurrent chunk management engine, it's about making the game better threaded and more scalable in regard to world gen and chunk io performance.
1616

17-
## So what is C2ME not?
18-
**C2ME is currently in alpha stage and pretty experimental.**
19-
Although it is usable in most cases and tested during build time, it doesn't mean that it is fully stable for a production server.
20-
So backup your worlds and practice good game modding skills.
17+
## Vanilla parity
18+
C2ME does not sacrifice vanilla functionality or behavior, or alter the vanilla world generation in the name of raw speed by default.
19+
However, due to the [non-determinism of vanilla world generation](https://bugs.mojang.com/browse/MC-55596), worlds will vary
20+
significantly run-to-run even with the same seed. This is not a bug on our side.
21+
22+
While we carefully check that we do not modify any vanilla behavior, bugs are unavoidable after all.
23+
So, if you do encounter an issue where C2ME deviates from the intended vanilla behavior, don't hesitate to open an issue.
24+
25+
## Mod and Datapack compatibility
26+
World generation datapacks that can run on vanilla Minecraft are fully supported.
27+
Custom world generators implemented in mods usually runs well, but *may* cause compatibility issues due to certain
28+
design assumption used by mod authors being broken for further speedups of world generation.
29+
As a world generation mod author, if you find your mod broken, don't hesitate to look for help in our discord server (linked below).
30+
We are willing to help mod authors to embrace scalable world generation.
31+
32+
### Undefined behavior sanitization
33+
C2ME includes `CheckedThreadLocalRandom` for world random (included in [UWRAD](https://modrinth.com/mod/uwrad)) plus a few others.
34+
These detections exist to prevent mods from screwing up Minecraft internals and causing undebuggable problems.
35+
The detection should almost **never** produce false positives, and should be taken seriously and reported
36+
to corresponding mod authors instead.
37+
38+
## Usage notice
39+
**Backup your worlds and practice good game modding skills.**
2140

2241
## Downloads
23-
Modrinth: https://modrinth.com/mod/c2me-fabric
24-
CurseForge: https://www.curseforge.com/minecraft/mc-mods/c2me-fabric
42+
Modrinth: https://modrinth.com/mod/c2me-fabric
43+
CurseForge: https://www.curseforge.com/minecraft/mc-mods/c2me
2544

2645
## Support status for Minecraft versions
2746
Only the latest Minecraft release and the latest Minecraft snapshot are fully supported.

0 commit comments

Comments
 (0)