fxgl-sliding-puzzle

fxgl-sliding-puzzle copied to clipboard

FXGL Sliding Puzzle

=== Getting started

[cols="49a,2a,49a",frame=none,grid=none] |==== | To start the application execute:

./gradlew run

You can move the tiles using the arrow keys or the mouse. Have fun!

| | image:https://raw.githubusercontent.com/beryx/fxgl-sliding-puzzle/master/img/snapshot-small.png[role="thumb" width="240" link="https://raw.githubusercontent.com/beryx/fxgl-sliding-puzzle/master/img/snapshot.png"] |====

=== Creating application packages/installers Packages for Linux, macOS, and Windows are created automatically by GitHub Actions - see for example https://github.com/beryx/fxgl-sliding-puzzle/actions/runs/183513751[these packages]. Read the instructions below to see how to create them yourself.

The Gradle build script uses the https://github.com/beryx/badass-jlink-plugin/blob/master/README.md[badass-jlink plugin], which is able to create application packages/installers. Under the hood, it calls the https://jdk.java.net/jpackage/[jpackage] tool introduced in Java 14, so you need to install jpackage on your machine. On Windows you also need to install http://wixtoolset.org/releases/[WIX], which is required to generate msi or exe packages.

You also need to specify the home of your jpackage distribution in the BADASS_JLINK_JPACKAGE_HOME environment variable. Alternatively, you can explicitly configure this location in https://github.com/beryx/fxgl-sliding-puzzle/blob/490bf0fe35e27493640e647e92390cf7d15a11be/build.gradle#L26-L27[build.gradle].

[cols="49a,2a,49a",frame=none,grid=none] |==== | After that, you can execute:

./gradlew jpackage

The application installers will be available in the build/jpackage directory.

.Example (Windows)

build\jpackage\fxgl-sliding-puzzle-1.0.msi

| | image:https://raw.githubusercontent.com/beryx/fxgl-sliding-puzzle/master/img/installer-thumb.png[role="thumb" link="https://raw.githubusercontent.com/beryx/fxgl-sliding-puzzle/master/img/installer.gif"] |====

On Windows, it's recommended to run the installed application as administrator.