hengqian-chaine / 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 on either the official CurseForge page or through the GitHub releases page. Usually, builds will be made available on GitHub slightly sooner than other locations.

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.

Translations

Translations to other languages are managed on our OneSky site. If you're interested in improving language support for Sodium, you should also join the Discord server to chat with other contributors. Each submitted translation requires either a number of approval votes from the community or approval from a reviewer in order to be included in the mod.

In the future, these translations will be automatically downloaded and included in the mod at compile time. For the time being you will need to manually export the translation files from OneSky and add them to the src/main/resources/assets/sodium/lang directory in order to see them in-game.

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.

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.

Tuning for optimal performance

This section is entirely optional and is only aimed at users who are interested in squeezing out every drop from their game. Sodium will work without issue in the default configuration of almost all launchers.

Generally speaking, newer versions of Java will provide better performance not only when playing Minecraft, but when using Sodium as well. The default configuration your game launcher provides will usually be some old version of Java 8 that has been selected to maximize hardware compatibility instead of performance.

For most users, these compatibility issues are not relevant, and it should be relatively easy to upgrade the game's Java runtime and apply the required patches. For more information on upgrading and tuning the Java runtime, see the guide here.

License

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