README.md

Lithium

Lithium is a free and open-source Minecraft mod (under GNU LGPLv3) 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.

⚠️ Lithium is still in an early stage of development. This mod contains a large number of patches which may cause issues in your game. Please be prepared to edit your configuration file to narrow down issues. If you do run into an issue, please let me know through opening an issue!

Support development

You can help buy me food and support development while getting early access builds of my mods by making a monthly pledge to my Patreon! You'll also gain some special perks, such as prioritized support on my Discord server.

Join the Discord

You can join the official Discord for my mods by clicking here.

Compiling the mod

You will need the latest version of Gradle 4.9 present on your system along with the Java 11 JDK. For Windows users, you can use Chocolatey or SDKMAN to manage these installations. These should be standard packages on most other operating systems. Alternatively, you can use the included Gradle wrapper with gradlew.

Once the prerequisites have been met, start a build with:

gradle build

The resulting build artifacts will be present in build/libs.

License

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