https://github.com/relativitymc/c2me-neoforge
https://github.com/relativitymc/c2me-neoforge
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/relativitymc/c2me-neoforge
- Owner: RelativityMC
- License: mit
- Created: 2024-10-28T01:57:06.000Z (over 1 year ago)
- Default Branch: dev/1.21.5
- Last Pushed: 2025-07-17T16:05:30.000Z (7 months ago)
- Last Synced: 2025-07-17T18:50:51.844Z (7 months ago)
- Language: Shell
- Size: 217 KB
- Stars: 21
- Watchers: 1
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
C^2M-Engine
[](https://discord.gg/Kdy8NM5HW4)
A mod designed to improve the chunk performance of Minecraft.
## So what is C2ME?
C^2M-Engine, or C2ME for short, is a mod designed to improve the performance of chunk generation, I/O, and loading. This is done by taking advantage of multiple CPU cores in parallel. For the best performance it is recommended to use C2ME with [Lithium](https://github.com/CaffeineMC/lithium-fabric) and [Starlight](https://github.com/Spottedleaf/Starlight).
## What does C2ME stand for?
Concurrent chunk management engine, it's about making the game better threaded and more scalable in regard to world gen and chunk io performance.
## Vanilla parity
C2ME does not sacrifice vanilla functionality or behavior, or alter the vanilla world generation in the name of raw speed by default.
However, due to the [non-determinism of vanilla world generation](https://bugs.mojang.com/browse/MC-55596), worlds will vary
significantly run-to-run even with the same seed. This is not a bug on our side.
While we carefully check that we do not modify any vanilla behavior, bugs are unavoidable after all.
So, if you do encounter an issue where C2ME deviates from the intended vanilla behavior, don't hesitate to open an issue.
## Mod and Datapack compatibility
World generation datapacks that can run on vanilla Minecraft are fully supported.
Custom world generators implemented in mods usually runs well, but *may* cause compatibility issues due to certain
design assumption used by mod authors being broken for further speedups of world generation.
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).
We are willing to help mod authors to embrace scalable world generation.
### Undefined behavior sanitization
C2ME includes `CheckedThreadLocalRandom` for world random (included in [UWRAD](https://modrinth.com/mod/uwrad)) plus a few others.
These detections exist to prevent mods from screwing up Minecraft internals and causing undebuggable problems.
The detection should almost **never** produce false positives, and should be taken seriously and reported
to corresponding mod authors instead.
## Usage notice
**Backup your worlds and practice good game modding skills.**
## Downloads
Modrinth: https://modrinth.com/mod/c2me-neoforge
CurseForge: https://www.curseforge.com/minecraft/mc-mods/c2me
## Support
Our issue tracker: [link](https://github.com/RelativityMC/C2ME-neoforge/issues)
Our discord server: [link](https://discord.gg/Kdy8NM5HW4)
## Building and setting up
JDK 22+, Clang 18+ are required to build C2ME
#### Initial setup
Run the following commands in the root directory:
```
git submodule update --init
./build.sh up
./build.sh patch
```
#### Creating a patch
See [CONTRIBUTING.md](CONTRIBUTING.md) for more detailed information.
#### Compiling
Use the command `./build.sh build`. Compiled jars will be placed under `C2ME-fabric-patched/build/libs/`.
## License
License information can be found [here](/LICENSE).