Lithium (for Fabric)

Lithium is a free and open-source Minecraft mod which works to optimize many areas of the game in order to provide better overall performance. It works on both the client and server, and doesn't require the mod to be installed on both sides.

Downloads

You can find downloads for Lithium 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.

Installation instructions

Lithium relies on the Fabric Loader. Users should select Fabric for either the Minecraft launcher (client) or the dedicated server (server) depending on their needs. Once you have installed Fabric, place the Lithium .jar in the mods folder generated by Fabric.

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.

Support the developers

Lithium is made possible by the following core contributors and others. You can help support members of the core team by making a pledge to our Patreon pages below.

	Author	Role	Links
	jellysquid3	Project Lead	Patreon / Contributions
	2No2Name	Maintainer	Patreon / Contributions

What makes Lithium different?

One of the most important design goals in Lithium is correctness. Unlike other mods which apply optimizations to the game, Lithium does not sacrifice vanilla functionality or behavior in the name of raw speed. It's a no compromises' solution for those wanting to speed up their game, and as such, installing Lithium should be completely transparent to the player.

If you do encounter an issue where Lithium deviates from the norm, please don't hesitate to open an issue. Each patch is carefully checked to ensure vanilla parity, but after all, bugs are unavoidable.

Configuration

Out of the box, no additional configuration is necessary once the mod has been installed. Lithium makes use of a configuration override system which allows you to either forcefully disable problematic patches or enable incubating patches which are otherwise disabled by default. As such, an empty config file simply means you'd like to use the default configuration, which includes all stable optimizations by default.

See the Wiki page on the configuration file format and all available options.

Building from source

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

Prerequisites

You will need to install JDK 8 in order to build Lithium. 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.

License

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