JavaFX plugin for JeKa

Build and run a JavaFX application from the source. This plugin adapts the Project KBean to simplify the JavaFX setup process.

Features

• Use basic JavaFX dependencies; the plugin automatically manages native setup for you.
• Manage JavaFX modules/kit behind the scene.
• Run JavaFX apps on any platform directly from a Git repo, no packaging needed.

How to Use

This plugin requires JeKa 0.11.55 or greater.

1- Import the plugin and activate by specifying the following properties in the jeka.properties file.

jeka.classpath=dev.jeka:javafx-plugin:0.11.55-0
@javafx=on

## Optional. By default, this uses the version of the project's JDK or the running JDK.
@javafx.version=25

2- Declare needed JavaFX dependencies in the compile-only section of your dependencies.txt file.

[compile-only]
org.openjfx:javafx-controls
org.openjfx:javafx-graphics
org.openjfx:javafx-fxml

3- From here, you can now code your application and execute it using one of the classic command:

• jeka project: runMain
• jeka project: runJar
• jeka -p (directly run the app bypassing the JeKa engine)

Distribute your Application

Package-less Distribution

Thanks to the Jeka system, you don't need to package your application as a binary to make it runnable from anywhere.

Any Jeka user can install your app and run it efficiently from its Git source repository. The build happens behind the scenes on the user's machine in a portable way.

To install and run a JavaFX app stored in a Git repo:

• jeka app: install repo=your_app_git_repo_url
• jeka app: install repo=your_app_git_repo_url#0.1.0 (to specify a Git tag)

This builds then installs the binary in the PATH of the host machibe. You may create a specific desktop shortcut for convenience.

Tip: Use the catalog to give visibility to your app.

Binary Creation

To create self-contained application (containing the Java runtime), execute the following command:

jeka bundle: pack

Run in the IDE

When running on IDE, you must supply the JavaFX modules as JVM options in your launcher. To grab those options, execute jeka javafx: jvmOptions and copy-paste the result into your IDE launcher configuration.

Example

• https://github.com/djeang/devtools A graphical toolbox for developers, ported from Maven to Jeka.