wilhelmoks/appetizer

Usage - Command Line App

Command Line

The command appetizer --help will print information about the arguments.

Android Icon

appetizer icon.png 100 100 --androidIcon output

This will create 5 folders in an output folder, each containing icon.png images of different sizes:

<img src="Images/s_android_drawable.png" width="300" alt="Android drawable"/>

The image in drawable-mdpi will have the size 100x100. The others will have greater size.

You can set another name for the android folders, like mipmap:

appetizer icon.png 100 100 --androidIcon output --androidFolderPrefix mipmap

<img src="Images/s_android_mipmap.png" width="300" alt="Android mipmap"/>

iOS Icon

appetizer icon.png 100 100 --iosIcon output

This will create 3 images in the output folder:

<img src="Images/s_ios.png" width="200" alt="iOS icon"/>

The size will be 100x100 for icon.png, 200x200 for icon@2x.png and 300x300 for icon@3x.png.

iOS App Icon

appetizer icon.png 100 100 --iosAppIcon output

This will create many images in the output folder:

<img src="Images/s_ios_app_icon_1.png" width="200" alt="iOS app icon"/>

The images have each size needed to fully specify an app icon on iOS for the iPhone and the iPad, including the 1024x1024 App Store icon.

(The provided size arguments 100 100 are ignored for app icons)

Single Icon

appetizer icon.png 100 100 --singleIcon output

This will create one image in the output folder: icon.png. The size will be 100x100.

Icon Name

By default, the generated icons will have the same name as the original icon.

The name can be changed using the --name argument:

appetizer icon.png 100 100 --singleIcon output --name monkey

The generated icon will be monkey.png.

Removing White Background

With a source image having white background and a black icon <img src="Images/icon.png" width="32"/> , you might want wo remove the white backgound so that it becomes transparent.

appetizer icon.png 100 100 --singleIcon output --clearWhite

Adding the --clearWhite parameter, the result will be an icon with transparent background: <img src="Images/t.png" width="32"/> <img src="Images/s_transparent.png" width="32"/>

Coloring

Using the --color argument, all opaque regions of the icon will be colored:

appetizer icon.png 100 100 --singleIcon output --color #ff5500

Using the source image <img src="Images/t.png" width="32"/>, the resulting image will look like this <img src="Images/ff5500.png" width="32"/>

Padding

You can add transparent padding to the generated icon using the --padding argument:

appetizer icon.png 100 100 --singleIcon output --padding 20

Source and generated icon in comparison: <img src="Images/t.png" width="32"/> <img src="Images/padding_20.png" width="32"/>

Or you can remove padding by providing a negative value:

appetizer icon.png 42 42 --singleIcon output --padding -2

This can be used to remove unwanted borders: <img src="Images/s_with_border.png" width="32"/> <img src="Images/s_with_border_minus2.png" width="32"/>

Installation - Command Line App

Binary release

Download an appetizer binary from the release section and copy it into the folder /usr/local/bin so that it can be launched from anywhere in the command line.

Run sudo chmod 777 /usr/local/bin/appetizer in the command line to make the file executable.

Compile the source

You can compile the source using the command line:

swift build -c release

Then copy the appetizer binary from the folder .build/release to /usr/local/bin so that it can be launched from anywhere in the command line.

Package Metadata

Repository: wilhelmoks/appetizer

Default branch: master

README: README.md