⚠️Project Status

Canary is no longer maintained. While the repository will remain available, no further updates or fixes will be provided. Please feel free to fork or contribute if you wish to extend its functionality."

#

Canary for Minecraft Forge

Canary is a general performance optimization mod and unofficial fork of Lithium mod for Minecraft Forge, This mod aims to optimize the general performance of Minecraft(mob ai, physics, chunk loading, etc..) without changing any behavior. It works on both the client and server, and doesn't require the mod to be installed on both sides.

Installation

Manual Installation

Canary supports Minecraft Forge 1.18.2 and up, So make sure you have the latest version of Forge present and simply drop the mod into your mods folder, no other mods or additional setup is required!

Curseforge

If you are using Curseforge, you can continue downloading Canary through my Curseforge page.

Modrinth

If you are using Modrinth, you can continue downloading Canary through my Modrinth page.

Github Actions

Github Actions builds will be available soon.

#

What makes Canary different?

One of the most important design goals in Canary is correctness. Unlike other mods which apply optimizations to the game, Canary 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 Canary should be completely transparent to the player.

Configuration

Out of the box, no additional configuration is necessary once the mod has been installed. Canary 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. The wiki may be outdated.

Support the Original Creators

Canary is impossible without the high-quality contributions made by the original Lithium developers, and as such, i would like to ask you support them, for more information you can see this section in the official repository's readme.

License

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

Issues and Feature Requests

If you'd like to get help with the mod, feel free to open an issue here on GitHub, and if you want to propose new features or otherwise contribute to the mod, i will gladly accept pull requests, as well!

#

YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor. Thanks to YourKit for providing a free license for this project.