Skip to content

Building from Source

shvquu edited this page Jun 13, 2026 · 5 revisions

Building from Source

Requirements

  • JDK 21
  • Git

Clone and generate the wrapper

The repository uses Gradle. If the Gradle wrapper isn't committed yet, generate it once (requires a local Gradle install):

git clone https://github.com/YOUR-NAME/serverdoctor.git
cd serverdoctor
gradle wrapper --gradle-version 8.10

Tip: commit gradlew, gradlew.bat, and gradle/wrapper/ — JitPack and CI both rely on ./gradlew.

Build the plugin

./gradlew :serverdoctor-paper:shadowJar

Output:

serverdoctor-paper/build/libs/ServerDoctor-0.5.0.jar

This jar bundles common, api, core, storage, and the SQLite driver.

Run the tests

./gradlew test

This runs the JUnit 5 suite and the ArchUnit architecture checks.

Publish the API locally (optional)

./gradlew :serverdoctor-api:publishToMavenLocal :serverdoctor-common:publishToMavenLocal

The artifacts land in ~/.m2/repository/com/serverdoctor/.

IDE

Open the project folder in IntelliJ IDEA via Open — it imports the Gradle project and resolves Paper, JUnit, and sqlite-jdbc automatically.

Clone this wiki locally