Skip to content

Building from Source

Requirements

  • JDK 25+
  • Gradle 9+ (or use the included ./gradlew wrapper)

Clone and run

Terminal window
git clone https://github.com/Kitty-Hivens/Aura-Launcher.git
cd Aura-Launcher
# Run in development mode
./gradlew :client-ui:run
# Run tests
./gradlew :client-core:test :client-launcher:test

Build release artifacts

Terminal window
# Windows — distributable folder (fed into Inno Setup)
./gradlew :client-ui:createReleaseDistributable
# macOS — DMG
./gradlew :client-ui:packageReleaseDmg
# Linux — uber JAR (AppImage is assembled manually in CI)
./gradlew :client-ui:packageReleaseUberJarForCurrentOS

CI / Release pipeline

Releases are built automatically by .github/workflows/build_release.yml on tag push (v*.*.*).

The pipeline:

  1. Runs tests — build fails if any test fails
  2. Builds Windows EXE (Inno Setup), Portable ZIP, Linux AppImage, macOS DMG in parallel
  3. Generates SHA256 checksums
  4. Publishes a GitHub Release with changelog extracted from CHANGELOG.md

Platform notes