Building From Source

Building From Source

VortexRPG is open source and uses Gradle Kotlin DSL with Java 21.

Requirements

• Java 21 JDK
• Git
• The included Gradle wrapper

Clone

git clone https://github.com/Sauron05/vortexrpg.git
cd vortexrpg

Build on Windows

.\gradlew.bat build

Build on macOS or Linux

./gradlew build

Useful Build Tasks

Task	Purpose
test	Runs the JUnit test suite
compileJava	Compiles main plugin sources
shadowJar	Builds the Paper/Folia shaded jar
spigotJar	Builds the dedicated Spigot jar
sourcesJar	Builds the source jar
build	Runs verification and copies release jars

Release Outputs

Release-ready jars are copied into the root jar/ folder:

jar/VortexRPG-1.2.2-alpha-paper-folia.jar
jar/VortexRPG-1.2.2-alpha-spigot.jar
jar/VortexRPG-1.2.2-alpha-sources.jar

Development Stack

• Java 21 toolchain
• Gradle Kotlin DSL
• JUnit 5 tests
• Paper/Folia main build
• Dedicated Spigot jar task
• Shaded runtime libraries including bStats, Jackson, and Caffeine

Verification Standard

Before shipping a jar, run:

.\gradlew.bat build

A successful release build should end with BUILD SUCCESSFUL and regenerate the jars in jar/.