ProjectKorra | Minecraft Reimagined - Master the elements from Avatar: The Last Airbender and The Legend of Korra

Getting Started

If you're looking for already compiled versions, visit our GitHub Releases page for standard releases. Otherwise, read on to learn how you can compile the plugin yourself.

Prerequisites

In order to build ProjectKorra-Core, you need to have the Java JDK installed on your system (version 8u251 or later). Additionally, ProjectKorra-Core utilizes Gradle as its source control system. You can either download and install Gradle yourself or use the provided Gradle wrapper (gradlew).

Building

You can start by either downloading the source code directly or cloning it via Git (recommended):

git clone https://github.com/ProjectKorra/ProjectKorra-Core.git

Now, navigate to your new ProjectKorra-Core directory in a terminal and execute the corresponding Gradle task to get your desired result.

Compile the plugin:

gradle build

Run all JUnit tests:

gradle test

Compile all documentation:

gradle javadoc

Start a local Spigot test server with a newly built binary and all dependencies.

gradle debugSpigot

Start a local Paper test server with a newly built binary and all dependencies.

gradle debugPaper

Remove all build/debug files:

gradle cleanAll

Note: If you are going to use the provided gradle wrapper, replace gradle with gradlew in the above commands

Contributing

We are always eager to see active members in the community posting issues or making pull requests and invite you to do so. We just ask that all incoming pull requests be made to the wip branch and that you adhere to our issue / pull request templates.