{"id":15653872,"url":"https://github.com/erbridge/itchy-electron","last_synced_at":"2026-03-16T10:34:09.867Z","repository":{"id":57278417,"uuid":"58834092","full_name":"erbridge/itchy-electron","owner":"erbridge","description":"Package your Electron games for itch.io","archived":false,"fork":false,"pushed_at":"2020-06-14T17:26:56.000Z","size":19,"stargazers_count":29,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-10T07:17:50.472Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/erbridge.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}},"created_at":"2016-05-14T22:56:50.000Z","updated_at":"2025-01-27T00:24:10.000Z","dependencies_parsed_at":"2022-09-18T11:23:10.578Z","dependency_job_id":null,"html_url":"https://github.com/erbridge/itchy-electron","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erbridge%2Fitchy-electron","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erbridge%2Fitchy-electron/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erbridge%2Fitchy-electron/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erbridge%2Fitchy-electron/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/erbridge","download_url":"https://codeload.github.com/erbridge/itchy-electron/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251790227,"owners_count":21644183,"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-10-03T12:47:33.362Z","updated_at":"2026-03-16T10:34:09.838Z","avatar_url":"https://github.com/erbridge.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Itchy Electron\n\n\u003e Package your [Electron](http://electron.atom.io/) games for [itch.io](https://itch.io/)\n\n\n## About\n\nThis is a CLI app for building and publishing games and tools built using [Electron](http://electron.atom.io/) to [itch.io](https://itch.io/). It aims to handle everything from packaging your Electron app into distributables, to publishing it on itch.io. It wraps other tools into a single unified interface, with sensible defaults and simple commands that can easily be called manually or added as `package.json` scripts.\n\nBug reports, feature requests, and pull requests are welcome!\n\n\n## Installation\n\nInstall into a project using `npm`:\n\n```\n$ npm install --save-dev itchy-electron\n```\n\nor globally:\n\n```\n$ npm install -g itchy-electron\n```\n\nPublishing also relies on [`butler`](https://github.com/itchio/butler), which needs to be manually installed.\n\n\n## Usage\n\nOnce installed, *Itchy Electron* is used through the CLI tool `itchy`.\n\nRefer to the help for an up to date command reference:\n\n```\n$ itchy help\n```\n\n\n### Configuration\n\n*Itchy Electron* uses configuration files over command line arguments. To configure it, either add an object to your `package.json` called `itchyElectron`, or create a JavaScript or JSON file called `.itchyelectronrc`, `.itchyelectron.js`, or `.itchyelectron.json` (whatever takes your preference).\n\nThe only \"required\" options are `electronVersion` (which is inherited from the `package.json` if possible - see below for more details) and `itchTargets`.\n\nA minimal `package.json` configuration looks like this:\n\n```json\n{\n  \"name\": \"example\",\n  \"version\": \"0.1.0\",\n  \"itchyElectron\": {\n    \"productName\": \"Example\",\n    \"appDir\": \"./app\",\n    \"itchTargets\": {\n      \"release\": \"erbridge/example\"\n    }\n  },\n  \"devDependencies\": {\n    \"electron-prebuilt\": \"1.0.2\",\n    \"itchy-electron\": \"^0.1.0\"\n  }\n}\n```\n\nor `.itchyelectron.json`:\n\n```json\n{\n  \"productName\": \"Example\",\n  \"appVersion\": \"0.1.0\",\n  \"electronVersion\": \"1.0.2\",\n  \"itchTargets\": {\n    \"beta\": \"erbridge/example-beta\",\n    \"release\": \"erbridge/example\"\n  }\n}\n```\n\n\n#### Options\n\n##### `appDir`\n\nThe app source directory. Defaults to the current directory.\n\n\n##### `appVersion`\n\nThe release version of the application. Maps to the `ProductVersion` metadata property on Windows, and `CFBundleShortVersionString` on OS X. Defaults to the `version` from the `package.json`.\n\n\n##### `buildDir`\n\nThe directory to save builds into. Defaults to `./build`.\n\n\n##### `buildVersion`\n\nThe build version of the application. Maps to the `FileVersion` metadata property on Windows, and `CFBundleVersion` on OS X. Defaults to `appVersion`.\n\n\n##### `electronVersion`\n\nThe version of Electron to build against. If omitted, the pinned version in the `package.json` dependencies will be used. If there is no locally pinned version number, the build will fail.\n\nAccepted packages are:\n\n - `electron`\n - `electron-prebuilt`\n - `electron-prebuilt-compile`\n\n\n##### `itchTargets`\n\nAn object of key value pairs of target to project, used for publishing.\n\n\n##### `productName`\n\nThe application name. If omitted, `name` from the `package.json` will be used instead. If no name is present, it will default to `untitled`.\n\n\n### Project Structure\n\nIt is suggested that you structure your app in the following way, so as to minimize the overheads caused by packaging the `devDependencies`.\n\n```\nproject/\n\n  app/\n        The entire app source is contained within here.\n\n    package.json\n          A minimal package.json containing a reference to the\n          app entry point in \"main\" along with the runtime\n          dependencies in \"dependencies\". Other values are optional.\n\n  build/\n\n  dist/\n\n  package.json\n        A more complete package.json with the development dependencies\n        and other values. This is where the \"itchyElectron\"\n        configuration belongs, if using the package.json option.\n```\n\nSetting `appDir` to `./app` in this case will enable building packages with only the runtime dependencies. It also has the bonus effect of excluding the various configuration files often found in a project's root.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferbridge%2Fitchy-electron","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ferbridge%2Fitchy-electron","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferbridge%2Fitchy-electron/lists"}