Convert Figma logo to code with AI

CaffeineMC logolithium

A Fabric mod designed to improve the general performance of Minecraft without breaking things

1,990
194
1,990
38

Top Related Projects

4,959

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

Quick Overview

Lithium is a highly optimized, open-source Minecraft mod designed to enhance server performance without altering vanilla gameplay mechanics. It achieves this by improving various aspects of the game's code, including physics, mob AI, and chunk loading, resulting in significantly reduced server load and improved TPS (ticks per second).

Pros

  • Substantial performance improvements without changing gameplay
  • Compatible with many other mods and vanilla clients
  • Actively maintained and regularly updated
  • Open-source, allowing for community contributions and audits

Cons

  • May conflict with some other performance-enhancing mods
  • Requires Fabric mod loader, which may not be compatible with all server setups
  • Performance gains can vary depending on server hardware and configuration
  • Some optimizations may have minor visual differences in extreme edge cases

Getting Started

To use Lithium on your Minecraft server:

  1. Ensure you have a Fabric server set up for the appropriate Minecraft version.
  2. Download the latest Lithium .jar file from the releases page.
  3. Place the downloaded .jar file in your server's mods folder.
  4. Restart your server.

Lithium requires no additional configuration and will automatically optimize your server upon startup.

For client-side installation (optional but recommended for best performance):

  1. Install the Fabric mod loader for your Minecraft client.
  2. Download the Lithium .jar file as mentioned above.
  3. Place the .jar file in your client's mods folder.
  4. Launch Minecraft with the Fabric profile.

Note: Always ensure you're using the correct version of Lithium for your Minecraft version to avoid compatibility issues.

Competitor Comparisons

4,959

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

Pros of Sodium

  • Focuses specifically on rendering optimizations, leading to significant FPS improvements
  • Offers more advanced graphics settings and customization options
  • Generally provides better performance gains for GPU-bound systems

Cons of Sodium

  • Limited to client-side optimizations, unlike Lithium's server-side improvements
  • May have compatibility issues with some mods that modify rendering
  • Requires more frequent updates to keep up with Minecraft's rendering changes

Code Comparison

Sodium (rendering optimization):

public class ChunkRenderRebuildTask implements Runnable {
    @Override
    public void run() {
        this.render.rebuild();
    }
}

Lithium (general optimization):

public class EntityCollisions {
    public static boolean doesBoxCollide(Box box, World world, Predicate<Entity> filter) {
        return world.getOtherEntities(null, box, filter).isEmpty();
    }
}

Both Sodium and Lithium are performance optimization mods for Minecraft, developed by CaffeineMC. Sodium focuses on client-side rendering improvements, while Lithium offers a broader range of optimizations for both client and server. Sodium excels in boosting FPS and providing advanced graphics options, making it ideal for players with GPU limitations. Lithium, on the other hand, offers more comprehensive optimizations that benefit both client and server performance, making it a better choice for overall game improvement and server administrators.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

Lithium

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 & Installation

Download Lithium from Modrinth or CurseForge.

Lithium supports two mod loaders: Fabric and the NeoForge. You can use a launcher (e.g. the Modrinth launcher) to install lithium. Alternatively, you can install lithium manually by placing lithium's jar-file in the mods folder of your game after you have installed the corresponding mod loader.

📝 Why Choose Lithium?

Lithium is the perfect drop-in mod for players who want more performance without affecting their gameplay. It doesn't change any game mechanics or visuals, it just makes the game run faster. Lithium is compatible with most other mods, so you can use it alongside your favorite mods without any issues.

If you do encounter an issue where Lithium deviates from the norm or does not work with another mod, please don't hesitate to 📬 open an issue. Before opening a new issue, please check using the search tool that your issue has not already been created, and that if there is a suitable template for the issue you are opening, that it is filled out entirely. We will provide workarounds and fixes for issues as soon as possible.

🌟 Support the Development

Lithium is actively developed by 2No2Name since JellySquid has stepped down from active development in 2020. Several other contributors have also helped with the development of Lithium, and we are grateful for their contributions.

If you would like to support the development of Lithium, you can do so by joining the community and contributing to the project, or by signing up on patreon:

AuthorRoleLinks
2No2Name's Avatar2No2NameDeveloperPatreon
jellysquid3's AvatarJellySquidFormer Developer

💬 Join the CaffeineMC Community

We have an official Discord community for all of our projects. By joining, you can:

  • Get installation help and technical support with all of our mods
  • Be notified of the latest developments as they happen
  • Get involved and collaborate with the rest of our team
  • ... and just hang out with the rest of our community.

⚙️ Configuration

Out of the box, no additional configuration is necessary once the mod has been installed. Lithium is made of a collection of vastly different optimizations. Very few optimizations depend on each other, enabling you to resolve mod compatibility issues by disabling problematic optimizations. Optimizations are disabled by default if there is a major issue with them that has not yet been resolved.

As such, an empty config file simply means you'd like to use the default configuration, which includes all stable optimizations by default. For the list of options, see the configuration file summary.

🛠️ Bleeding-edge builds (unstable)

GitHub build status

If you are a player who is looking to get your hands on the latest bleeding-edge changes for testing, consider taking a look at the automated builds produced through our GitHub Actions workflow . This workflow automatically runs every time a change is pushed to the repository, and as such, the builds it produces will generally reflect the latest snapshot of development.

Bleeding edge builds will often include unfinished code that hasn't been extensively tested. That code may introduce incomplete features, bugs, crashes, and all other kinds of weird issues. You should not use these bleeding edge builds unless you know what you are doing and are comfortable with software debugging. If you report issues using these builds, we will expect that this is the case. Caveat emptor.


🛠️ Building from sources

Lithium uses the Gradle build tool and can be built with the gradle build command. The build artifacts (production binaries and their source bundles) can be found in the build/mods directory.

The Gradle wrapper is provided for ease of use and will automatically download and install the appropriate version of Gradle for the project build. To use the Gradle wrapper, substitute gradle in build commands with ./gradlew.bat (Windows) or ./gradlew (macOS and Linux).

📜 License

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