Phosphor is a free and open-source Minecraft mod (under GNU GPLv3) aiming to save your CPU cycles and improve performance by optimizing one of Minecraft's most inefficient areas-- the lighting engine. It works on both the client and server, and can be installed on servers without requiring clients to also have the mod.
The mod is designed to be as minimal as possible in the changes it makes, and as such, does not modify the light model or interfaces of vanilla Minecraft. Because of this, Phosphor should be compatible with many Minecraft mods (so long as they do not make drastic changes to how the lighting engine works.) If you've ran into a compatibility problem, please open an issue!
You can find downloads for Phosphor 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.
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.
If you're hacking on the code or would like to compile a custom build of Phosphor from the latest sources, you'll want to start here.
You will need to install JDK 8 in order to build Phosphor. 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.
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.
Phosphor is licensed under GNU LGPLv3, a free and open-source license. For more information, please see the license file.