Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gluonhq/gluonfx-gradle-plugin
Plugin that simplifies using Gluon Client for Java/JavaFX gradle projects
https://github.com/gluonhq/gluonfx-gradle-plugin
Last synced: 3 days ago
JSON representation
Plugin that simplifies using Gluon Client for Java/JavaFX gradle projects
- Host: GitHub
- URL: https://github.com/gluonhq/gluonfx-gradle-plugin
- Owner: gluonhq
- License: bsd-3-clause
- Created: 2019-05-28T08:54:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-18T10:07:10.000Z (3 months ago)
- Last Synced: 2024-12-16T09:20:25.817Z (11 days ago)
- Language: Java
- Size: 288 KB
- Stars: 100
- Watchers: 15
- Forks: 22
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GluonFX plugin for Gradle
[](https://plugins.gradle.org/plugin/com.gluonhq.gluonfx-gradle-plugin)
[](https://github.com/gluonhq/gluonfx-gradle-plugin/actions/workflows/build.yml)
[](https://opensource.org/licenses/BSD-3-Clause)
GluonFX plugin for gradle projects leverages GraalVM, OpenJDK and JavaFX 11+,
by compiling into native code the Java Client application and all its required dependencies,
so it can directly be executed as a native application on the target platform.
# Important Notice
Gluon releases the [GluonFX plugin for Maven](https://github.com/gluonhq/gluonfx-maven-plugin), and this plugin is maintained and kept up to date by the community.
Use at your own risk.
## Getting started
To use the plugin, apply the following steps:
### 1. Apply the plugin
Using the `plugins` DSL, add:
plugins {
id 'com.gluonhq.gluonfx-gradle-plugin' version '1.0.24'
}
This requires adding the plugin repository to the `settings.gradle` file:
pluginManagement {
repositories {
gradlePluginPortal()
}
}
rootProject.name = ...
Alternatively, you can use the `buildscript` DSL:
buildscript {
repositories {
maven {
url "https://plugins.gradle.org/m2/"
}
}
dependencies {
classpath 'com.gluonhq:gluonfx-gradle-plugin:1.0.24'
}
}
apply plugin: 'com.gluonhq.gluonfx-gradle-plugin'
### 2. Tasks
You can run the regular tasks to build and run your project as a regular VM project:
./gradlew clean build
./gradlew run
Once the project is ready, the plugin has these main tasks:
#### `nativeRunAgent`
This task can be run to use a tracing agent and generate the required config files for native-image.
Run:
./gradlew nativeRunAgent
#### `nativeCompile`
This tasks does the AOT compilation. It is a very intensive and lengthy task (several minutes, depending on your project and CPU),
so it should be called only when the project is ready and runs fine on a VM.
Run:
./gradlew build nativeCompile
The results will be available at `$buildDir/client/gvm`.
#### `nativeLink`
When the object is created, this task will generate the native executable for the target platform.
Run:
./gradlew nativeLink
The results will be available at `$buildDir/client/$hostPlatform/$AppName`.
#### `nativeBuild`
This task simply combines `nativeCompile` and `nativeLink`.
#### `nativeRun`
Runs the executable in the target platform
Run:
./gradlew nativeRun
Or run the three tasks combined:
./gradlew build nativeBuild nativeRun
Or run directly the application from command line:
build/gluonfx/$hostPlatform/$AppName/$AppName
It will create a distributable native application.
#### `nativePackage`
On mobile only, create a package of the executable in the target platform
Run:
./gradlew nativePackage
On iOS, this can be used to create an IPA, on Android it will create an APK.
#### `nativeInstall`
Installs the generated package or the binary.
Run:
./gradlew nativeInstall
Note: At the moment, this task is only intended for Android and Linux-AArch64.
### Configuration
The plugin allows some configuration to modify the default settings:
```
gluonfx {
target = "$target"
attachConfig {
version = "$version"
configuration = "implementation";
services "lifecycle", ...
}
bundlesList = []
resourcesList = []
reflectionList = []
jniList = []
compilerArgs = []
linkerArgs = []
runtimeArgs = []
javaStaticSdkVersion = ""
javafxStaticSdkVersion = ""
graalvmHome = ""
verbose = false
enableSwRendering = false
remoteHostName = ""
remoteDir = ""
release {
// Android
appLabel = ""
versionCode = "1"
versionName = "1.0"
providedKeyStorePath = ""
providedKeyStorePassword = ""
providedKeyAlias = ""
providedKeyAliasPassword = ""
// iOS
bundleName = ""
bundleVersion = ""
bundleShortVersion = ""
providedSigningIdentity = ""
providedProvisioningProfile = ""
skipSigning = false
}
}
```
Check the [maven counterpart section](https://docs.gluonhq.com/#_configuration) for more details.
### Requirements
Check the requirements for the [target platform](https://docs.gluonhq.com/#_platforms) before you get started.
## Issues and Contributions ##
Issues can be reported to the [Issue tracker](https://github.com/gluonhq/gluonfx-gradle-plugin/issues)
Contributions can be submitted via [Pull requests](https://github.com/gluonhq/gluonfx-gradle-plugin/pulls),
providing you have signed the [Gluon Individual Contributor License Agreement (CLA)](https://cla.gluonhq.com).