https://github.com/fueled/ios-icon-generator
A terminal tool that generates app icon sets for Xcode
https://github.com/fueled/ios-icon-generator
Last synced: 11 months ago
JSON representation
A terminal tool that generates app icon sets for Xcode
- Host: GitHub
- URL: https://github.com/fueled/ios-icon-generator
- Owner: Fueled
- License: apache-2.0
- Created: 2019-02-19T21:03:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-19T08:24:45.000Z (about 3 years ago)
- Last Synced: 2024-04-24T23:01:13.431Z (about 2 years ago)
- Language: Ruby
- Homepage: https://fueled.com
- Size: 3.99 MB
- Stars: 45
- Watchers: 10
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
iOS Icon Generator
============
[](https://app.bitrise.io/app/b23ec2cde834230f)
[](https://fueled.github.io/ios-icon-generator/)
[](http://www.apache.org/licenses/LICENSE-2.0)
[](https://rubygems.org/gems/ios_icon_generator)
[](https://codecov.io/gh/Fueled/ios-icon-generator)
## Usage
The CLI currently supports 2 commands:
- `generate`: generates an iOS App Icon Set from a base PDF
- `mask`: generates a new iOS App Icon Sets from a base one, adding a mask at its bottom left which can be customized.
- `stub`: generates a default iOS App Icon Sets, using a background color, a text and its color.
### Installation
iOS Icon Generator is built using Ruby, and can be installed using its default local installation in your terminal via:
```bash
sudo gem install ios_icon_generator
```
If 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.
It requires both [`imagemagick`](http://www.imagemagick.org/) and [`ghostscript`](https://www.ghostscript.com/), both can be installed using Homebrew:
```bash
brew install imagemagick ghostscript
```
### Generate App Icon Sets
For now, the CLI supports generating app icon sets for all supported platforms:
- iPhone
- iPad
- Apple Watch
- Mac
- Carplay
> Please note that the Display P3 color space is not supported yet
And supports generating sticker packs icons for iMessage apps.
You can specify iPhone and iPad at the same time, however iMessage must be specified on its own.
The base syntax of the command is:
```bash
icongen generate [XCAsset Folder] --type=
```
If the `XCAsset Folder` is not specified, then the current working is assumed to be the output folder.
The type, if not specified, defaults to `iphone`.
For 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`):
```bash
icongen generate Icon.pdf Images.xcassets --type=iphone,ipad
```
There are more options to `icongen generate` which you can discover by running `icongen generate --help`.
### Masking Existing App Icon Sets
The 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:
Into this:
The command used in the example was (it assumes that `AppIcon.appiconset` is the original App Icon Set and is in the current working directory):
```bash
icongen mask AppIcon.appiconset \
--mask-shape=square \
--x-size-ratio=0.30 \
--y-size-ratio=0.30 \
--size-offset=0.11 \
--x-offset=0.1 \
--y-offset=0.1 \
--background-color='#A36AE9' \
--stroke-width-offset=0 \
--font=Symbol \
--symbol-color='#FFFFFF'
```
For 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.
The command supports a lot of customization through options, and you can find more information about each option by typing `icongen mask --help`
### Creating temporary icons
The 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:
Here's the command that were run to get each icons above:
```bash
#1
icongen stub \
WS \
--background-color='#A36AE9' \
--stroke-width-offset=0 \
--y-offset=-0.04 \
--size-offset=0.5 \
--symbol-color='#FFFFFF'
```
```bash
#2
icongen stub \
W \
--background-color='#3A7D31' \
--font=Symbol \
--stroke-width-offset=0.01 \
--y-offset=-0.07 \
--size-offset=0.5 \
--symbol-color='#C9C9C9'
```
```bash
#3
icongen stub \
A \
--background-color='#000000' \
--stroke-width-offset=0.01 \
--stroke-color='#FFFFFF' \
--font='Arial' \
--size-offset=0.5 \
--symbol-color='#000000'
```
The command supports a lot of customization through options, and you can find more information about each option by typing `icongen stub --help`.
## Development
### Set Up
To 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:
```bash
echo "BUNDLE_GEMFILE=\"`pwd`/Gemfile\" bundler exec ruby \"`pwd`/bin/icongen\" \"\${@---help}\"" > /usr/local/bin/icongen-dev
chmod +x /usr/local/bin/icongen-dev
```
All you'll be all set!
To run the development version of `icongen` from anywhere, just run `icongen-dev` rather than `icongen`.
You 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!
To 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`:
```bash
brew install libpng libjpeg
```
You may then execute the following command to run the test suite:
```bash
bundler exec rake
```