{"id":16917033,"url":"https://github.com/jpsacha/sbt-install4j","last_synced_at":"2025-04-11T16:25:26.066Z","repository":{"id":13502498,"uuid":"16193313","full_name":"jpsacha/sbt-install4j","owner":"jpsacha","description":"SBT plugin for building installers with Install4J","archived":false,"fork":false,"pushed_at":"2023-05-13T03:24:32.000Z","size":105,"stargazers_count":7,"open_issues_count":0,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-25T12:22:38.223Z","etag":null,"topics":["install4j","sbt","sbt-install4j","sbt-plugin","scala"],"latest_commit_sha":null,"homepage":null,"language":"Scala","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/jpsacha.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":"2014-01-24T02:56:47.000Z","updated_at":"2022-11-05T19:25:33.000Z","dependencies_parsed_at":"2025-02-19T19:34:14.657Z","dependency_job_id":"43d4015e-ea22-4681-9ee5-009aa3a19020","html_url":"https://github.com/jpsacha/sbt-install4j","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpsacha%2Fsbt-install4j","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpsacha%2Fsbt-install4j/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpsacha%2Fsbt-install4j/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpsacha%2Fsbt-install4j/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jpsacha","download_url":"https://codeload.github.com/jpsacha/sbt-install4j/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248439260,"owners_count":21103566,"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":["install4j","sbt","sbt-install4j","sbt-plugin","scala"],"created_at":"2024-10-13T19:32:24.366Z","updated_at":"2025-04-11T16:25:26.044Z","avatar_url":"https://github.com/jpsacha.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"sbt-install4j\n=============\n\n[![Scala CI](https://github.com/jpsacha/sbt-install4j/actions/workflows/scala.yml/badge.svg)](https://github.com/jpsacha/sbt-install4j/actions/workflows/scala.yml)   [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.jpsacha/sbt-install4j/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.jpsacha/sbt-install4j)\n\n\n[SBT] plugin for building installers with [Install4J]   ![Install4J](https://www.ej-technologies.com/images/product_banners/install4j_medium.png)\n\n\nUsage\n-----\n\n`sbt-install4j` is available for sbt-1.x.\n\n### project/plugins.sbt\n\nImport `sbt-install4j` plugin to use `install4j` command.\n\n```sbt\naddSbtPlugin(\"com.github.jpsacha\" % \"sbt-install4j\" % \"1.5.0\")\n```\n\n### build.sbt\nSample use, add following to your `build.sbt`:\n\n```sbt\nexportJars := true\n```\nThis will export dependent JARs that will be copied to the installer\n\n```sbt\nenablePlugins(SBTInstall4J)\ninstall4jProjectFile := \"installer/example.install4j\"\n```\n\n## Available Tasks and Settings\n\nSBT tasks provided by  `sbt-install4j` plugin:\n\n* `install4j` : Task - \n  Builds Install4J project. Simple usage from SBT REPL\n  ```\n  sbt\u003e install4j\n  ```\n  It will build project defined in by setting `install4jProjectFile`\n  \n  It can take optional arguments that are passed by to the Install4J compiler. \n  Refer to `install4jc` documentation in [Install4J Help](https://www.ej-technologies.com/resources/install4j/help/doc/#install4j.cli) for list of supported command line options. You can print option summary from SBT REPL using\n  ```\n  sbt\u003e install4j --help\n  ```\n  Example of only building `windows` media type\n  ```\n  sbt\u003e install4j -m windows\n  ```\n\n* `install4jCopyDependedJars` : Task - \n  Copies project dependencies to directory `install4jDependedJarsDir`\n  \n\nSBT settings provided by  `sbt-install4j` plugin:\n\n* `install4jCopyDependedJarsExclusions` : Seq[String] - \n  List of regex expressions that match files that will be excluded from copying.\n\n* `install4jCopyDependedJarsEnabled` : Boolean -\n   if `true` dependent jars will be copies, if `false` they will be not.\n\n* `install4jcFile` : File -  Location of the install4j's command line compiler `install4jc[.exe]`. It can be found in the `bin` directory of the install4j installation. Default can be set with environment variable `INSTALL4JC_FILE`.\n  ```sbt\n  install4jcFile := file(\"C:/Program Files/install4j8/bin/install4jc.exe\")\n  ```\n\n* `install4jProjectFile` : String - Relative path to the install4j project file that should be build.\n\n* `install4jDependedJarsDir` : String -\n  Location where dependent jars will be copied.\n  \n* `install4jExtraOptions` : Seq[String] - \"Additional command line options passed to the compiler.\"\n\n* `install4jVerbose` : Boolean -\n  Enables verbose mode.\n\n* `install4jRelease` : String -\n  Override the application version. \n  Version number components can be alphanumeric and should be separated by dots, dashes or underscores.\n\n* `install4jCompilerVariables` : Map[String, String] -\n  Override a compiler variable with a different value.\n  In the map, the `key` is variable's name, the `value` is variable's value.\n  \n* `install4jHomeDir` : File - __Deprecated__. Install4J installation directory. It assumes that Install4J compiler is in subdirectory `bin`. Default can be set with environment variable `INSTALL4J_HOME`. This option is deprecated, use environment variable `INSTALL4JC_FILE` or setting `install4jcFile` instead.\n \n## Determining location of Install4J compiler\n\nThe `sbt-install4j` executes Install4J compiler. It needs to know its location. It will attempts to determine location base on the OS used. On Windows it is assumed to be:\n```\nC:\\Program Files\\Install4J10\\bin\\intall4jc.exe\n```\n\nOn Mac OS X:\n```\n/Applications/install4j.app/Contents/Resources/app/bin/install4jc\n```\n\nOn Linux:\n```\n/opt/install4j10/bin/install4jc\n```\n\nIf the Install4J is installed in a different location you can specify location of the compiler using the environment\nvariable `INSTALL4JC_FILE`, property `INSTALL4JC_FILE`, or SBT setting `install4jcFile`. For multi-platform builds it is\npreferred to use the environment variable `INSTALL4JC_FILE`.\n\nYou can set the property variable when starting SBT using `-D` option, for instance:\n```cmd\n$ sbt -DINSTALL4JC_FILE=\"C:/Program Files/install4j11/bin/install4jc.exe\"\n```\n\n## Example of a Complete Application\n\n[ScalaFX Ensemble] is an example of an application that is making use of `sbt-install4j` top create an installer with [Install4J] \n\n## Tips \u0026 Tricks\n\n### Compiling against Install4J API\nIf you use Install4J API in your application and using version other than the default for `sbt-install4j` you will need to set environment variable `INSTALL4J_HOME`. \n\nFor instance, `sbt-install4j` uses Install4J 7 as default, but you have Install4J 9 installed, then set `INSTALL4J_HOME` the installation directory. On Windows that would typically be `C:\\Program Files\\install4j10`\n\n### Debugging\nTo see debugging information set SBT logging level to `debug`:\n```cmd\nsbt\u003e debug\n```\nLook in the log for lines prefixed with `[debug] [sbt-install4j]`.\n\n\n## License\n\nsbt-install4j is licensed under [Apache 2.0 license][Apache2].\n\n\n\n\n[Install4J]: https://www.ej-technologies.com/products/install4j/overview.html\n[SBT]: http://www.scala-sbt.org/\n[ScalaFX Ensemble]: https://github.com/scalafx/scalafx-ensemble\n[Apache2]: https://www.apache.org/licenses/LICENSE-2.0.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpsacha%2Fsbt-install4j","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjpsacha%2Fsbt-install4j","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpsacha%2Fsbt-install4j/lists"}