{"id":18523481,"url":"https://github.com/gluonhq/gluonfx-gradle-plugin","last_synced_at":"2025-04-05T15:05:44.722Z","repository":{"id":37970647,"uuid":"188991756","full_name":"gluonhq/gluonfx-gradle-plugin","owner":"gluonhq","description":"Plugin that simplifies using Gluon Client for Java/JavaFX gradle projects","archived":false,"fork":false,"pushed_at":"2025-03-27T15:14:08.000Z","size":305,"stargazers_count":100,"open_issues_count":51,"forks_count":20,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-03-29T14:06:46.142Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gluonhq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-28T08:54:56.000Z","updated_at":"2025-03-27T15:14:14.000Z","dependencies_parsed_at":"2023-12-06T14:30:37.710Z","dependency_job_id":"2d4bf76f-b4bf-40a0-b285-82f88c2bc7bc","html_url":"https://github.com/gluonhq/gluonfx-gradle-plugin","commit_stats":null,"previous_names":[],"tags_count":62,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gluonhq%2Fgluonfx-gradle-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gluonhq%2Fgluonfx-gradle-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gluonhq%2Fgluonfx-gradle-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gluonhq%2Fgluonfx-gradle-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gluonhq","download_url":"https://codeload.github.com/gluonhq/gluonfx-gradle-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247353731,"owners_count":20925329,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T17:35:45.570Z","updated_at":"2025-04-05T15:05:44.697Z","avatar_url":"https://github.com/gluonhq.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GluonFX plugin for Gradle\n\n[![Plugin Portal](https://img.shields.io/maven-metadata/v?label=Gradle%20Plugin%20Portal\u0026metadataUrl=https://plugins.gradle.org/m2/com/gluonhq/gluonfx-gradle-plugin/maven-metadata.xml)](https://plugins.gradle.org/plugin/com.gluonhq.gluonfx-gradle-plugin)\n[![Build](https://github.com/gluonhq/gluonfx-gradle-plugin/actions/workflows/build.yml/badge.svg)](https://github.com/gluonhq/gluonfx-gradle-plugin/actions/workflows/build.yml)\n[![BSD-3 license](https://img.shields.io/badge/license-BSD--3-%230778B9.svg)](https://opensource.org/licenses/BSD-3-Clause)\n\nGluonFX plugin for gradle projects leverages GraalVM, OpenJDK and JavaFX 11+, \nby compiling into native code the Java Client application and all its required dependencies, \nso it can directly be executed as a native application on the target platform.\n\n# Important Notice\n\nGluon 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.\n\nUse at your own risk.\n\n## Getting started\n\nTo use the plugin, apply the following steps:\n\n### 1. Apply the plugin\n\nUsing the `plugins` DSL, add:\n\n    plugins {\n        id 'com.gluonhq.gluonfx-gradle-plugin' version '1.0.26'\n    }\n\nThis requires adding the plugin repository to the `settings.gradle` file:\n\n    pluginManagement {\n        repositories {\n            gradlePluginPortal()\n        }\n    }\n    rootProject.name = ...\n\nAlternatively, you can use the `buildscript` DSL:\n\n    buildscript {\n        repositories {\n            maven {\n                url \"https://plugins.gradle.org/m2/\"\n            }\n        }\n        dependencies {\n            classpath 'com.gluonhq:gluonfx-gradle-plugin:1.0.26'\n        }\n    }\n    apply plugin: 'com.gluonhq.gluonfx-gradle-plugin'\n\n\n### 2. Tasks\n\nYou can run the regular tasks to build and run your project as a regular VM project:\n\n    ./gradlew clean build\n    ./gradlew run\n\nOnce the project is ready, the plugin has these main tasks:    \n\n#### `nativeRunAgent`\n\nThis task can be run to use a tracing agent and generate the required config files for native-image.\n\nRun:\n\n    ./gradlew nativeRunAgent\n\n#### `nativeCompile`\n\nThis tasks does the AOT compilation. It is a very intensive and lengthy task (several minutes, depending on your project and CPU), \nso it should be called only when the project is ready and runs fine on a VM.\n\nRun:\n\n    ./gradlew build nativeCompile\n\nThe results will be available at `$buildDir/client/gvm`.\n\n#### `nativeLink`\n\nWhen the object is created, this task will generate the native executable for the target platform.\n\nRun:\n\n    ./gradlew nativeLink\n\nThe results will be available at `$buildDir/client/$hostPlatform/$AppName`.\n\n#### `nativeBuild`\n\nThis task simply combines `nativeCompile` and `nativeLink`.\n\n#### `nativeRun`\n\nRuns the executable in the target platform\n\nRun:\n\n    ./gradlew nativeRun\n\nOr run the three tasks combined:\n\n    ./gradlew build nativeBuild nativeRun\n\nOr run directly the application from command line:\n\n    build/gluonfx/$hostPlatform/$AppName/$AppName    \n\nIt will create a distributable native application.\n\n#### `nativePackage`\n\nOn mobile only, create a package of the executable in the target platform\n\nRun:\n\n    ./gradlew nativePackage\n\nOn iOS, this can be used to create an IPA, on Android it will create an APK.\n\n#### `nativeInstall`\n\nInstalls the generated package or the binary.\n\nRun:\n\n    ./gradlew nativeInstall\n    \nNote: At the moment, this task is only intended for Android and Linux-AArch64.    \n    \n### Configuration\n\nThe plugin allows some configuration to modify the default settings:\n\n```\ngluonfx {\n    target = \"$target\"\n    attachConfig {\n        version = \"$version\"\n        configuration = \"implementation\";\n        services \"lifecycle\", ...\n    }\n\n    bundlesList = []\n    resourcesList = []\n    reflectionList = []\n    jniList = []\n\n    compilerArgs = []\n    linkerArgs = []\n    runtimeArgs = []\n\n    javaStaticSdkVersion = \"\"\n    javafxStaticSdkVersion = \"\"\n    graalvmHome = \"\"\n\n    verbose = false\n    enableSwRendering = false\n\n    remoteHostName = \"\"\n    remoteDir = \"\"\n    \n    release {\n        // Android\n        appLabel = \"\"\n        versionCode = \"1\"\n        versionName = \"1.0\"\n        providedKeyStorePath = \"\"\n        providedKeyStorePassword = \"\"\n        providedKeyAlias = \"\"\n        providedKeyAliasPassword = \"\"\n        // iOS\n        bundleName = \"\"\n        bundleVersion = \"\"\n        bundleShortVersion = \"\"\n        providedSigningIdentity = \"\"\n        providedProvisioningProfile = \"\"\n        skipSigning = false\n    }\n}\n```\n\nCheck the [maven counterpart section](https://docs.gluonhq.com/#_configuration) for more details.\n\n### Requirements\n\nCheck the requirements for the [target platform](https://docs.gluonhq.com/#_platforms) before you get started.\n\n## Issues and Contributions ##\n\nIssues can be reported to the [Issue tracker](https://github.com/gluonhq/gluonfx-gradle-plugin/issues)\n\nContributions can be submitted via [Pull requests](https://github.com/gluonhq/gluonfx-gradle-plugin/pulls), \nproviding you have signed the [Gluon Individual Contributor License Agreement (CLA)](https://cla.gluonhq.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgluonhq%2Fgluonfx-gradle-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgluonhq%2Fgluonfx-gradle-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgluonhq%2Fgluonfx-gradle-plugin/lists"}