aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authormakamys <makamys@outlook.com>2023-01-04 02:40:17 +0100
committerGitHub <noreply@github.com>2023-01-04 02:40:17 +0100
commit0ed3d621a65afa8a203d189b75ee552979a32997 (patch)
tree11f2bcb68b144248590352e9016647313eeb7562 /README.md
parent935e354274ec41db330b975de9bfc5e69f1df798 (diff)
downloadNeodymium-0ed3d621a65afa8a203d189b75ee552979a32997.tar.gz
Neodymium-0ed3d621a65afa8a203d189b75ee552979a32997.tar.bz2
Neodymium-0ed3d621a65afa8a203d189b75ee552979a32997.zip
README: add nomixin explanation [skip ci]
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8e8f640..4401667 100644
--- a/README.md
+++ b/README.md
@@ -55,6 +55,12 @@ The mod increases memory usage, since the chunk meshes have to be stored somewhe
* OptiFine shaders aren't compatible, and will probably never be unless someone contributes a PR, as I have neither the knowledge nor the interest to add compatibility for them.
* Various coremods may be incompatible with Mixin. Use [Mixingasm](https://github.com/makamys/Mixingasm) to fix this.
+### About `nomixin` builds
+
+The mod comes in two flavors:
+* The regular version embeds Mixin 0.7.11, allowing the mod to run standalone. However, this makes the jar a bit larger, and can cause problems in certain use cases.
+* The version marked with `+nomixin` doesn't embed Mixin, which lets it avoid these problems. But it requires a separate [Mixin bootstrap mod](https://gist.github.com/makamys/7cb74cd71d93a4332d2891db2624e17c#mixin-bootstrap-mods) to be installed in order to run. If you have one installed already, getting this version is recommended.
+
## Suggested mods
For more 1.7.10 performance mods, refer to [this list](https://gist.github.com/makamys/7cb74cd71d93a4332d2891db2624e17c).