{"id":26201757,"url":"https://github.com/mini2dx/parcl","last_synced_at":"2025-12-16T14:28:34.416Z","repository":{"id":25250737,"uuid":"28675638","full_name":"mini2Dx/parcl","owner":"mini2Dx","description":"Gradle plugin for bundling your Java application for distribution on Windows, Mac and Linux","archived":false,"fork":false,"pushed_at":"2021-11-03T16:47:23.000Z","size":579,"stargazers_count":60,"open_issues_count":8,"forks_count":15,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-06T07:36:28.247Z","etag":null,"topics":["app","bundle","executable","gradle","gradle-plugin","java-application","native"],"latest_commit_sha":null,"homepage":"","language":"Groovy","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mini2Dx.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-31T21:33:36.000Z","updated_at":"2024-08-22T09:27:34.000Z","dependencies_parsed_at":"2022-08-23T21:21:01.384Z","dependency_job_id":null,"html_url":"https://github.com/mini2Dx/parcl","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mini2Dx%2Fparcl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mini2Dx%2Fparcl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mini2Dx%2Fparcl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mini2Dx%2Fparcl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mini2Dx","download_url":"https://codeload.github.com/mini2Dx/parcl/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249016625,"owners_count":21198832,"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":["app","bundle","executable","gradle","gradle-plugin","java-application","native"],"created_at":"2025-03-12T03:23:38.343Z","updated_at":"2025-12-16T14:28:33.952Z","avatar_url":"https://github.com/mini2Dx.png","language":"Groovy","funding_links":[],"categories":[],"sub_categories":[],"readme":"parcl\n==========\n\n[![Build Status](https://travis-ci.org/mini2Dx/parcl.svg?branch=master)](https://travis-ci.org/mini2Dx/parcl)\n\nGradle plugin for bundling your Java application as Windows, Mac and Linux native applications\n\nThe plugin can generate the following platform natives:\n * Windows - .exe\n * Mac OS X - .app\n * Linux - .sh script\n \nFuture releases may add more native formats.\n\n## How to use\n\nAdd the following buildscript configuration to the top of your build.gradle\n\n```gradle\nbuildscript {\n    repositories {\n        mavenLocal()\n        mavenCentral()\n    }\n    dependencies {\n        classpath group: 'org.mini2Dx', name: 'parcl', version: '1.8.0'\n    }\n}\n```\n\nThen add the plugin to your project, configuration for your main class and how you want parcl to bundle the application. The following shows the minimum required configuration.\n\n```gradle\nproject(\":projectName\") {\n   apply plugin: \"java\"\n   apply plugin: \"application\"\n   apply plugin: \"org.mini2Dx.parcl\"\n   \n   ........\n\n   mainClassName = \"com.example.MyMainClass\"\n\n   parcl {\n      exe {\n         exeName = \"myapplication\"\n      }\n\t\t\n      app {\n         appName = \"My Application\"\n         icon = \"relative/path/to/icon.icns\"\n         applicationCategory = \"public.app-category.adventure-games\"\n         displayName = 'My Application'\n         identifier = 'com.example.my.apple.identifier'\n         copyright = 'Copyright 2015 Your Name Here'\n      }\n\t\t\n      linux {\n         binName = \"myapplication\"\n      }\n   }\n}\n```\n\n__Note:__ If your version of Gradle gives an error regarding mainClassName, the following workaround has been reported to resolve it:\n\n```gradle\nproject(\":projectName\") {\n   apply plugin: \"java\"\n   apply plugin: \"application\"\n   apply plugin: \"org.mini2Dx.parcl\"\n   \n   ........\n\n   project.getConvention().getPlugin(ApplicationPluginConvention.class).setMainClassName(\"com.example.MyMainClass\")\n```\n\nThe plugin will add a task called 'bundleNative' to your project. This must be invoked on the platform you wish to bundle the application for, i.e. You must be on Mac OS X to bundle a Mac application.\n\n```bash\ngradle clean build bundleNative\n```\n\nDepending on your platform, the resulting application bundle will appear in build/windows, build/mac or build/linux.\n\n## Tasks\n\n| Task | Description |\n|---|---|\n| bundleNative  |  Generates the native application for the current platform |\n| bundleNativeZip | Generates the native application and packages it into a .zip  |\n\n## Advanced Configuration\n\nThere are several optional configuration parameters for each platform.\n\n| Optional Parameter  | Description | Example |\n| ------------- | ------------- | ------------- |\n| zipName | Specifies the name for the outputted zip file  | zipName = 'my-game-windows.zip' |\n| vmArgs | Passes JVM options to the application on launch  | vmArgs = [\"-Xmx1g\"] |\n| appArgs  | Passes application arguments to the application on launch  | appArgs = [\"arg1\", \"arg2\"] |\n| withJre  | Copies your local JRE and bundles it with the application. The value of $JAVA_HOME must be passed as an argument. | withJre(\"/usr/lib/jvm/java-8-oracle/\") |\n\nThe following example shows all options in use.\n\n```gradle\nmainClassName = \"com.example.MyMainClass\"\n\nparcl {\n  exe {\n    vmArgs = [\"-Xmx1g\"]\n    appArgs = [\"arg1\", \"arg2\"]\n    exeName = \"myapplication\"\n    zipName = 'my-game-windows.zip'\n\t\t\t\n    withJre(\"C:\\\\Program Files (x86)\\\\Java\\\\jdk1.8.0_25\\\\jre\")\n  }\n\t\t\n  app {\n    vmArgs = [\"-Xmx1g\"]\n    appArgs = [\"arg1\", \"arg2\"]\n    appName = \"My Application\"\n    icon = \"relative/path/to/icon.icns\"\n    applicationCategory = \"public.app-category.adventure-games\"\n    displayName = 'My Application'\n    identifier = 'com.example.my.apple.identifier'\n    copyright = 'Copyright 2015 Your Name Here'\n    zipName = 'my-game-mac.zip'\n\n    withJre(\"/Library/Java/JavaVirtualMachines/jdk1.8.0_25.jdk/Contents/Home\")\n  }\n\t\t\n  linux {\n    vmArgs = [\"-Xmx1g\"]\n    appArgs = [\"arg1\", \"arg2\"]\n    binName = \"myapplication\"\n    preferSystemJre = true\n    zipName = 'my-game-linux.zip'\n\t\t\t\n    withJre(\"/usr/lib/jvm/java-8-oracle/\")\n  }\n}\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmini2dx%2Fparcl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmini2dx%2Fparcl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmini2dx%2Fparcl/lists"}