{"id":13821191,"url":"https://github.com/beryx/badass-jlink-plugin","last_synced_at":"2025-05-15T23:03:30.512Z","repository":{"id":37271460,"uuid":"137633220","full_name":"beryx/badass-jlink-plugin","owner":"beryx","description":"Create a custom runtime image of your modular application","archived":false,"fork":false,"pushed_at":"2025-05-14T12:10:11.000Z","size":38782,"stargazers_count":406,"open_issues_count":29,"forks_count":28,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-05-15T23:03:03.550Z","etag":null,"topics":["gradle","gradle-plugin","jigsaw","jlink","jpackage","runtime-image"],"latest_commit_sha":null,"homepage":"https://badass-jlink-plugin.beryx.org","language":"Groovy","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/beryx.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,"zenodo":null}},"created_at":"2018-06-17T06:11:59.000Z","updated_at":"2025-05-14T12:10:16.000Z","dependencies_parsed_at":"2023-01-30T21:31:02.181Z","dependency_job_id":"aed98e81-94a1-40be-b2a0-097d129bb3d9","html_url":"https://github.com/beryx/badass-jlink-plugin","commit_stats":null,"previous_names":[],"tags_count":112,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beryx%2Fbadass-jlink-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beryx%2Fbadass-jlink-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beryx%2Fbadass-jlink-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beryx%2Fbadass-jlink-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/beryx","download_url":"https://codeload.github.com/beryx/badass-jlink-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254436944,"owners_count":22070946,"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":["gradle","gradle-plugin","jigsaw","jlink","jpackage","runtime-image"],"created_at":"2024-08-04T08:01:17.148Z","updated_at":"2025-05-15T23:03:30.486Z","avatar_url":"https://github.com/beryx.png","language":"Groovy","funding_links":[],"categories":["Groovy"],"sub_categories":[],"readme":"[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)\r\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/beryx/badass-jlink-plugin/blob/master/LICENSE)\r\n[![Build Status](https://img.shields.io/github/actions/workflow/status/beryx/badass-jlink-plugin/.github/workflows/build-jlink-plugin.yml?branch=master)](https://github.com/beryx/badass-jlink-plugin/actions?query=workflow%3A%22Java+11+Gradle+CI%22)\r\n\r\n## Badass JLink Plugin ##\r\n\r\n##### NOTE: Looking for co-maintainers - see [this issue](https://github.com/beryx/badass-jlink-plugin/issues/223). #####\r\n\r\nUsing this Gradle plugin you can create a custom runtime image of your modular application with minimal effort, \r\neven if it depends on automatic modules.\r\nThe plugin also lets you create an application installer with the [jpackage](https://docs.oracle.com/en/java/javase/21/jpackage/packaging-overview.html) tool introduced in Java 14\r\n(see [fxgl-sliding-puzzle](https://github.com/beryx/fxgl-sliding-puzzle/blob/master/README.adoc) for a usage example).\r\n\r\n:bulb: For non-modular applications use the [Badass-Runtime plugin](https://badass-runtime-plugin.beryx.org/releases/latest/).\r\n\r\nBadass-JLink exposes an extension with the name `jlink` to let you configure various\r\naspects of its operation.\r\nA simple example configuration is shown below:\r\n\r\n```\r\njlink {\r\n    options = ['--strip-debug', '--compress', '2', '--no-header-files', '--no-man-pages']\r\n    launcher{\r\n        name = 'hello'\r\n        jvmArgs = ['-Dlog4j.configurationFile=./log4j2.xml']\r\n    }\r\n}\r\n```\r\n\r\n### This is a complex plugin. Please [read the documentation](https://badass-jlink-plugin.beryx.org/releases/latest/) before using it.\r\n\r\nThe following projects illustrate how to use this plugin to create custom runtime images:\r\n- [badass-jlink-example](https://github.com/beryx-gist/badass-jlink-example) - a 'Hello world' application using slf4j and logback.\r\n- [badass-jlink-example-log4j2-javafx](https://github.com/beryx-gist/badass-jlink-example-log4j2-javafx) - a 'Hello world' JavaFX application using log4j2.\r\n- [badass-jlink-example-javafx-multiproject](https://github.com/beryx-gist/badass-jlink-example-javafx-multiproject) - A 'Hello world' JavaFX application with a Gradle multi-project build.\r\n- [badass-jlink-example-richtextfx](https://github.com/beryx-gist/badass-jlink-example-richtextfx) - A [RichTextFX](https://github.com/FXMisc/RichTextFX) project that shows how to configure splash screens and file associations when using jpackage.\r\n- [badass-jlink-example-kotlin-javafx](https://github.com/beryx-gist/badass-jlink-example-kotlin-javafx) - a 'Hello world' JavaFX application written in Kotlin.\r\n- [badass-jlink-example-kotlin-tornadofx](https://github.com/beryx-gist/badass-jlink-example-kotlin-tornadofx) - a 'Hello world' application written in Kotlin using [tornadofx](https://github.com/edvin/tornadofx).\r\n- [badass-jlink-spring-petclinic](https://github.com/beryx-gist/badass-jlink-spring-petclinic) - creates a custom runtime image of the [Spring PetClinic](https://github.com/spring-projects/spring-petclinic) application.\r\n- [fxgl-sliding-puzzle](https://github.com/beryx/fxgl-sliding-puzzle/blob/master/README.adoc) - a sliding puzzle game using the [FXGL](https://github.com/AlmasB/FXGL) library.\r\n- [copper-modular-demo](https://github.com/copper-engine/copper-modular-demo) - creates a custom runtime image of a [COPPER 5](http://copper-engine.org/) modular application. \r\n- [javafx-jlink-starter-gradle](https://github.com/brunoborges/javafx-jlink-starter-gradle) - A JavaFX starter project with an Azure Pipelines setup that produces binaries for Windows, Mac, and Linux.\r\n- [javafx-springboot-badass-jlink](https://github.com/mockbirds/javafx-springboot-badass-jlink) - A modular JavaFX application with Spring Boot.\r\n- [pdf-decorator](https://bitbucket.org/walczak_it/pdf-decorator/src/master/) - A [JavaFX tool](http://pdf-decorator.walczak.it/) to add stamps and backgrounds to PDF documents. There's also a [related article](https://walczak.it/blog/distributing-javafx-desktop-applications-without-requiring-jvm-using-jlink-and-jpackage) explaining how to migrate to this plugin. \r\n\r\nSee the [list of all releases](https://github.com/beryx/badass-jlink-plugin/blob/gh-pages/releases.md) if you use an older version of this plugin. \r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fberyx%2Fbadass-jlink-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fberyx%2Fbadass-jlink-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fberyx%2Fbadass-jlink-plugin/lists"}