Building

← Home

Building from source

This page is for developers and operators who compile Realty from the Git repository instead of downloading a release JAR.

---

Prerequisites

You need JDK 21 and Git installed on the machine that runs the build.

---

Build the main plugin

From the repository root, run:

./gradlew :realty-paper:shadowJar

The server-ready JAR is written under realty-paper/build/libs/ and its name ends with -all.jar.

---

Other modules in the repository

Gradle task	What it produces
:realty-paper-plan-extension:shadowJar	The optional JAR that connects Realty to Plan analytics.
:realty-areashop-importer:shadowJar	The optional JAR that helps import AreaShop data into Realty.

Each module writes its artifacts into its own build/libs/ folder.

---

Local test server

The realty-paper module can start a local Paper 1.21.8 server through Gradle (runServer in realty-paper/build.gradle.kts) and pull in sample plugins for testing.

---

Version number

The project version is defined in the shared Gradle convention under buildSrc.

---

Next: Installation