Skip to content

Latest commit

 

History

History
20 lines (13 loc) · 1.24 KB

README.md

File metadata and controls

20 lines (13 loc) · 1.24 KB

Sodium (Iris Fork)

This is a fork of Sodium adding Iris compatibility. It's experimental and is mainly intended for use by developers as a proof of concept.

Notes on compiling the fork

You will need to install JDK 8 in order to build this fork. 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.

You need to have a compiled build of the Iris sodium-compatibility branch in your mavenLocal repository. You will be unable to compile this fork otherwise! Use the publishToMavenLocal Gradle task in the Iris repository (checked out to the sodium-compatibility branch) to accomplish this.

License

Sodium (and this fork) are licensed under GNU LGPLv3, a free and open-source license. For more information, please see the license file.