From 9066101f5de8400b8cc1ccb3eba9d0a790e40293 Mon Sep 17 00:00:00 2001 From: Spottedleaf <6100722+Spottedleaf@users.noreply.github.com> Date: Tue, 3 Sep 2024 10:13:11 -0700 Subject: [PATCH] Update README.md --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 57eba798..eb4d4993 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ Moonrise == -Fabric/NeoForge mod for optimising performance of the integrated and dedicated server. +Fabric/NeoForge mod for optimising performance of the integrated (singleplayer/LAN) and dedicated server. ## Purpose -Moonrise aims to optimise the game *without changing Vanilla behavior*. +Moonrise aims to optimise the game *without changing Vanilla behavior*. If you find that there are changes to Vanilla behavior, +please open an issue. Moonrise ports several important [Paper](https://github.com/PaperMC/Paper/) patches. Listed below are notable patches: @@ -19,7 +20,11 @@ patches. Listed below are notable patches: |-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Lithium |
✅ compatibleLithium optimises many of the same parts of the game as Moonrise, for example the chunk system. Moonrise will automatically disable conflicting parts of Lithium. This mechanism needs to be manually validated for each Moonrise and Lithium release.
| | FerriteCore |
📝 requires config changesIn `config/ferritecore-mixin.toml`:
Set `replaceNeighborLookup` and `replacePropertyMap` to `false`
| -| C2ME |
❌ incompatibleC2ME is based around modifications to the chunk system, which Moonrise replaces wholesale. This makes them fundamentally incompatible.
| +| C2ME |
❌ incompatibleC2ME is based around modifications to the chunk system, which Moonrise replaces wholesale. This makes them fundamentally incompatible.
| + +## Configuration +Moonrise provides documented configuration options for tuning the chunk system and enabling bugfixes in the config file `$mcdir$/config/moonrise.yml`. +Important configuration options may be configured from the mods menu as well. ## Contact [Discord](https://discord.gg/tuinity)