How To Deploy Jar, exe, msi for JavaFX 23 Installers Using JPackage on Windows 11 x64 (Full version)

Video Description

In this guide, I'll explain how to use the JPackage tool to create a self-contained JavaFX 23 application with all the required dependencies. This will let us build a native installer, like an .exe or .msi file, for Windows 11 x64. Make sure you're using the same version of Java and JavaFX. For example, if you're using JDK 23.0.1, make sure you also use JavaFX 23.0.1. To create EXE or MSI installers, you will need a third-party library called the WiX Toolset (version 3.0 or later). You should download and install the following: - JDK 23.0.1 is available from https://www.oracle.com/java/technologies/javase-downloads.html - Open JavaFX (OpenJFX) and JMODS 23.0.1 are available from https://gluonhq.com/products/javafx/ - Java Scene Builder 23.0.1 is available from https://gluonhq.com/products/scene-builder/ - IntelliJ IDEA Community Edition 2024.3.1 is available from https://www.jetbrains.com/idea/download/ - WiX Toolset v3.14.1 is available from https://wixtoolset.org/releases/ The Installed directories are as following: C:\Program Files\Java\jdk-23.0.1 C:\Program Files\Java\javafx-sdk-23.0.1 C:\Program Files\Java\javafx-jmods-23.0.1 C:\Users\Ken\AppData\Local\SceneBuilder C:\Program Files\JetBrains\IntelliJ IDEA Community Edition 2024.3.1 C:\Program Files (x86)\WiX Toolset v3.14 The JPackage tool works by taking a Java application and a Java runtime image, then creating an application image that includes everything needed to run it. The tool can generate native packages specific to your platform, like an .exe file for Windows or a .dmg file for macOS. However, the tool only works on the platform it's running on, so you can't build a package for one operating system while using another. The tool also offers various customization options for the packaged app. Source: https://docs.oracle.com/en/java/javase/23/docs/specs/man/jpackage.html Usage Examples 1. Create an EXE file for Windows jpackage --type exe --input . --dest . --main-jar demo.jar --main-class com.example.demo.App --module-path "C:\Program Files\Java\javafx-jmods-23.0.1" --add-modules javafx.controls,javafx.fxml --win-shortcut --win-menu --type exe: Creates a Windows executable (.exe) installer. --win-shortcut: Creates a shortcut for the application in the Start Menu. --win-menu: Creates a menu entry for the application in the Windows Start Menu. 2. Create an MSI file with versioning jpackage --type msi --input . --dest . --main-jar demo.jar --main-class com.example.demo.App --module-path "C:\Program Files\Java\javafx-jmods-23.0.1" --add-modules javafx.controls,javafx.fxml --win-shortcut --win-menu --app-version "2.0" --type msi: Creates an MSI (Microsoft Installer) file. --app-version "2.0": Specifies the version of the application. 3. Create MSI with a custom application name jpackage --type msi --input . --dest . --main-jar demo.jar --main-class com.example.demo.App --module-path "C:\Program Files\Java\javafx-jmods-23.0.1" --add-modules javafx.controls,javafx.fxml --win-shortcut --win-menu --name "My App" --app-version "2.0" --name "My App": Sets the name of the application in the installer. 4. Create MSI with description jpackage --type msi --input . --dest . --main-jar demo.jar --main-class com.example.demo.App --module-path "C:\Program Files\Java\javafx-jmods-23.0.1" --add-modules javafx.controls,javafx.fxml --win-shortcut --win-menu --name "My App" --app-version "2.0" --description "JavaFX 23 Hello World App" --description "JavaFX 23 Hello World App": Adds a description to the installer. 5. Create MSI with an icon jpackage --type msi --input . --dest . --main-jar demo.jar --main-class com.example.demo.App --module-path "C:\Program Files\Java\javafx-jmods-23.0.1" --add-modules javafx.controls,javafx.fxml --win-shortcut --win-menu --name "My App" --app-version "2.0" --description "JavaFX 23 Hello World App" --icon "icon.ico" --icon "icon.ico": Specifies an icon for the installer. 6. 1 Create a custom runtime with jlink jlink --module-path "C:\Program Files\Java\javafx-jmods-23.0.1" --add-modules java.base,javafx.controls,javafx.fxml --output my-runtime --no-header-files --no-man-pages 6.2 Use jpackage to package your application with the custom runtime jpackage --type msi --input . --dest . --main-jar demo.jar --main-class com.example.demo.App --name "My App" --app-version "2.0" --description "JavaFX 23 Hello World App" --icon "icon.ico" --runtime-image my-runtime 7. Verbose logging for debugging jpackage --type msi --input . --dest . --main-jar demo.jar --main-class com.example.demo.App --module-path "C:\Program Files\Java\javafx-jmods-23.0.1" --add-modules javafx.controls,javafx.fxml --win-shortcut --win-menu --name "My App" --app-version "2.0" --description "JavaFX 23 Hello World App" --icon "icon.ico" --verbose --verbose: Provides detailed logging for debugging and troubleshooting the packaging process.