/sodium-forge

Sodium is a Minecraft mod designed to improve frame rates and reduce micro-stutter. This is a port of Sodium for the Minecraft Forge ecosystem. Sodium (Fabric) is created by JellySquid: https://jellysquid.me/

Primary LanguageJavaGNU Lesser General Public License v3.0LGPL-3.0

Project icon

Sodium (Forge fork)

GitHub license

This is Forge edition of Sodium

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.

⚠️ Though this fork is functional, things may be broken.

Downloads

Currently, only on release page.

Community

Please DO NOT join CaffeineMC's Discord to seek support for this fork. Forks or unofficial versions of Sodium are not supported by the original developers. If you encounter any issues, check current issues on this repo or make a new issue.

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.