shaunstanislauslau / sodium-fabric

A Fabric mod designed to improve frame rates and reduce micro-stutter

Sodium (for Fabric)

Sodium is a free and open-source optimization mod for the Minecraft client that improves frame rates, reduces micro-stutter, and fixes graphical issues in Minecraft.

⚠️ Sodium has had a lot of time to shape up lately, but the mod is still alpha software. You may run into small graphical issues or crashes while using it. Additionally, the Fabric Rendering API is not yet supported, which may cause crashes or prevent other mods from rendering correctly. Please be aware of these issues before using it in your game.

Downloads

You can find downloads for Sodium through the GitHub releases page. Once Sodium matures and leaves the stage of alpha software, builds will be published on CurseForge.

Community

If you'd like to get help with the mod, check out the latest developments, or be notified when there's a new release, the Discord community might be for you! You can join the official server for my mods by clicking here.

Building from source

If you're hacking on the code or would like to compile a custom build of Sodium from the latest sources, you'll want to start here.

Prerequisites

You will need to install JDK 8 (or newer, see below) in order to build Sodium. You can either install this through a package manager such as Chocolatey on Windows or SDKMAN! on other platforms. If you'd prefer to not use a package manager, you can always grab the installers or packages directly from AdoptOpenJDK.

On Windows, the Oracle JDK/JRE builds should be avoided where possible due to their poor quality. Always prefer using the open-source builds from AdoptOpenJDK when possible.

A note on newer Java versions

For the best possible experience with Sodium installed, you should prefer to use a Java 14 runtime for your game client with the Z Garbage Collector (ZGC) enabled. This is purely optional, but will generally help to improve frame times by reducing garbage collection pause times. However, please be sure you read this entire section before upgrading your Java runtime.

If you build the mod with JDK 11 or newer, you must upgrade your game client's runtime to at least the version you are building with. If you try to use an older runtime while building with a newer version, your game may crash or not render anything at all. Additionally, if you are using the Java 11 runtime or newer for your client, you should install Voyager mod for Fabric to patch a known world generation bug which can cause rare crashes.

The official Minecraft launcher (and most other third-party launchers) will often use Java 8 runtime in order to work around bugs in the Intel HD 2xxx/3xxx graphics drivers on Windows 10. If you are not affected by these issues, you can usually upgrade the runtime by modifying your game profile's settings in your launcher of choice.

Compiling

Navigate to the directory you've cloned this repository and launch a build with Gradle using gradlew build (Windows) or ./gradlew build (macOS/Linux). If you are not using the Gradle wrapper, simply replace gradlew with gradle or the path to it.

The initial setup may take a few minutes. After Gradle has finished building everything, you can find the resulting artifacts in build/libs.

License

Sodium is licensed under GNU LGPLv3, a free and open-source license. For more information, please see the license file.