{"id":22951843,"url":"https://github.com/fueled/ios-icon-generator","last_synced_at":"2025-08-13T00:32:52.232Z","repository":{"id":34219379,"uuid":"171549433","full_name":"Fueled/ios-icon-generator","owner":"Fueled","description":"A terminal tool that generates app icon sets for Xcode","archived":false,"fork":false,"pushed_at":"2023-04-19T08:24:45.000Z","size":4186,"stargazers_count":45,"open_issues_count":12,"forks_count":3,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-04-24T23:01:13.431Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://fueled.com","language":"Ruby","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/Fueled.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":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2019-02-19T21:03:43.000Z","updated_at":"2024-03-16T16:49:28.000Z","dependencies_parsed_at":"2023-01-15T05:22:02.264Z","dependency_job_id":null,"html_url":"https://github.com/Fueled/ios-icon-generator","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fueled%2Fios-icon-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fueled%2Fios-icon-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fueled%2Fios-icon-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fueled%2Fios-icon-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Fueled","download_url":"https://codeload.github.com/Fueled/ios-icon-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229718632,"owners_count":18113549,"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-12-14T15:19:01.692Z","updated_at":"2024-12-14T15:19:02.574Z","avatar_url":"https://github.com/Fueled.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"iOS Icon Generator\n============\n\n[![Build Status](https://app.bitrise.io/app/b23ec2cde834230f/status.svg?token=IBOm9v8claU8aEpmnLMWig)](https://app.bitrise.io/app/b23ec2cde834230f)\n[![Documentation](https://img.shields.io/badge/docs-available-success.svg)](https://fueled.github.io/ios-icon-generator/)\n[![LICENSE](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)\n[![Version](https://img.shields.io/gem/v/ios_icon_generator.svg)](https://rubygems.org/gems/ios_icon_generator)\n[![codecov](https://codecov.io/gh/Fueled/ios-icon-generator/branch/master/graph/badge.svg)](https://codecov.io/gh/Fueled/ios-icon-generator)\n\n## Usage\n\nThe CLI currently supports 2 commands:\n\n- `generate`: generates an iOS App Icon Set from a base PDF\n- `mask`: generates a new iOS App Icon Sets from a base one, adding a mask at its bottom left which can be customized.\n- `stub`: generates a default iOS App Icon Sets, using a background color, a text and its color.\n\n### Installation\n\niOS Icon Generator is built using Ruby, and can be installed using its default local installation in your terminal via:\n\n```bash\nsudo gem install ios_icon_generator\n```\n\nIf you wish not to use `sudo` permissions to RubyGems, you can follow the instructions of the `CocoaPods` guys [here](https://guides.cocoapods.org/using/getting-started.html#getting-started), by replacing all `cocoapods` with `ios_icon_generator` in the shell commands.\n\nIt requires both [`imagemagick`](http://www.imagemagick.org/) and [`ghostscript`](https://www.ghostscript.com/), both can be installed using Homebrew:\n\n```bash\nbrew install imagemagick ghostscript\n```\n\n### Generate App Icon Sets\n\nFor now, the CLI supports generating app icon sets for all supported platforms:\n\n- iPhone\n- iPad\n- Apple Watch\n- Mac\n- Carplay\n\n\u003e Please note that the Display P3 color space is not supported yet\n\nAnd supports generating sticker packs icons for iMessage apps.\n\nYou can specify iPhone and iPad at the same time, however iMessage must be specified on its own.\n\nThe base syntax of the command is:\n\n```bash\nicongen generate \u003cPDF Base Icon\u003e [XCAsset Folder] --type=\u003ctype\u003e\n```\n\nIf the `XCAsset Folder` is not specified, then the current working is assumed to be the output folder.\nThe type, if not specified, defaults to `iphone`.\n\nFor example, to generate icons for iPhones and iPads, and output the images set in `Images.xcassets`, run (assuming the path Icon PDF file is also in the current directory and is called `Icon.pdf`):\n```bash\nicongen generate Icon.pdf Images.xcassets --type=iphone,ipad\n```\n\nThere are more options to `icongen generate` which you can discover by running `icongen generate --help`.\n\n### Masking Existing App Icon Sets\n\nThe application also supports \"masking\" app icons, adding a small mask at the bottom-left corner of the icons, allowing for example to convert the following icons:\n![Before Example](README_Images/Mask-Before.png)\nInto this:\n![Before Example](README_Images/Mask-After.png)\n\nThe command used in the example was (it assumes that `AppIcon.appiconset` is the original App Icon Set and is in the current working directory):\n```bash\nicongen mask AppIcon.appiconset \\\n    --mask-shape=square \\\n    --x-size-ratio=0.30 \\\n    --y-size-ratio=0.30 \\\n    --size-offset=0.11 \\\n    --x-offset=0.1 \\\n    --y-offset=0.1 \\\n    --background-color='#A36AE9' \\\n    --stroke-width-offset=0 \\\n    --font=Symbol \\\n    --symbol-color='#FFFFFF'\n```\n\nFor now, the command only supports adding a mask into the bottom-left corner, but allowing to add it anywhere is definitely a feature we want.\n\nThe command supports a lot of customization through options, and you can find more information about each option by typing `icongen mask --help`\n\n### Creating temporary icons\n\nThe application also supports creating \"temporary\" icons, that you would use during development if you don't have an icon yet (for example at project creation). For example, here are some icons created using various commands:\n\n![Icons Example](README_Images/Icons-Example.png)\n\nHere's the command that were run to get each icons above:\n```bash\n#1\nicongen stub \\\n    WS \\\n    --background-color='#A36AE9' \\\n    --stroke-width-offset=0 \\\n    --y-offset=-0.04 \\\n    --size-offset=0.5 \\\n    --symbol-color='#FFFFFF'\n```\n```bash\n#2\nicongen stub \\\n    W \\\n    --background-color='#3A7D31' \\\n    --font=Symbol \\\n    --stroke-width-offset=0.01 \\\n    --y-offset=-0.07 \\\n    --size-offset=0.5 \\\n    --symbol-color='#C9C9C9'\n```\n```bash\n#3\nicongen stub \\\n    A \\\n    --background-color='#000000' \\\n    --stroke-width-offset=0.01 \\\n    --stroke-color='#FFFFFF' \\\n    --font='Arial' \\\n    --size-offset=0.5 \\\n    --symbol-color='#000000'\n```\n\nThe command supports a lot of customization through options, and you can find more information about each option by typing `icongen stub --help`.\n\n## Development\n\n### Set Up\n\nTo set you up for developing on driveshaft, first make sure the repository is cloned and you're in its root folder, and then run the following:\n\n```bash\necho \"BUNDLE_GEMFILE=\\\"`pwd`/Gemfile\\\" bundler exec ruby \\\"`pwd`/bin/icongen\\\" \\\"\\${@---help}\\\"\" \u003e /usr/local/bin/icongen-dev\nchmod +x /usr/local/bin/icongen-dev\n```\n\nAll you'll be all set!\nTo run the development version of `icongen` from anywhere, just run `icongen-dev` rather than `icongen`.  \nYou can then proceed on developing locally on the ios-icon-generator repository, and create a PR whenever a new piece of code is ready to be reviewed and integrated!\n\nTo be able to run the test suite, the dependencies `libpng` and `libjpeg` are required (on top of `imagemagick`) to be installed. You can install them via `homebrew`:\n```bash\nbrew install libpng libjpeg\n```\n\nYou may then execute the following command to run the test suite:\n```bash\nbundler exec rake\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffueled%2Fios-icon-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffueled%2Fios-icon-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffueled%2Fios-icon-generator/lists"}