Getting Started

SnapFX is currently in a public-preview release-readiness phase (0.x). Until Maven Central publication is live, use source checkout or GitHub Release demo assets.

Run Tests

./gradlew test

Run Demo

./gradlew run

Quick Localization Setup

SnapFX snapFX = new SnapFX();
snapFX.setLocale(Locale.GERMAN);

// Optional: provide your own language pack
snapFX.setLocalizationProvider(
    new DockResourceBundleLocalizationProvider("com.example.i18n.snapfx")
);

See the full guide at Localization.

Build Demo Runtime Image (jlink)

./gradlew :snapfx-demo:jlink

Build Demo Package Image (jpackage)

./gradlew :snapfx-demo:jpackageImage
./gradlew :snapfx-demo:packageJPackageImageZip

Next

• Continue with the User Guide.
• Follow Tutorial: First Layout for a complete start-to-finish flow.
• Browse Examples for reusable snippets.
• Use API JavaDoc for full public API details.