/phosphor-forge

A mod designed to dramatically improve the performance of Minecraft's lighting engine while fixing many bugs

Primary LanguageJavaGNU Lesser General Public License v3.0LGPL-3.0

Project icon

Phosphor (Forge fork)

GitHub license

This is Forge edition of Phosphor

Phosphor is a Minecraft mod which works to optimize one of game'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.

⚠️ Though this fork is functional, things may be broken.

Downloads

Currently, only on release page.

Community

Please DO NOT join CaffeineMC's Discord to seek support for this fork. Forks or unofficial versions of Phosphor are not supported by the original developers. If you encounter any issues, check current issues on this repo or make a new issue.

Building from source

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.

Prerequisites

You will need to install JDK 8 (or newer, see below) in order to build Sodium. 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

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