appiconannotator

Annotates app icons with a text in the top and/or bottom.

Dependencies

• Install ImageMagick by running brew install imagemagick.
• Install Ghostscript by rynning brew install ghostscript.

Installation

Install using npm.

npm install -g git+ssh://[email protected]:shapehq/appiconannotator.git

You can also install it in GitHub Actions using the install-appiconannotator action.

Usage

appiconannotator supports the following two commands for annotating app icons. For more information about the commands, run appiconannotator [command] --help.

annotate

Write text on the input app icon.

appiconannotator annotate -i appicon.png -o annotated_appicon.png --top-text "1.0 (14)" --bottom-text "feature/swift3"

Option	Description
-h, --help	output usage information
-i, --input	input app icon to write on
-o, --output	output destination to save the resulting app icon
--top-text	text rendered in the top
--bottom-text	text rendered in the bottom
--top-font-size	size of the text in the top
--top-text-color	color of the text rendered in the top
--top-background-color	background color the text rendered in the top
--bottom-font-size	size of the text in the bottom
--bottom-text-color	color of the text rendered in the bottom
--bottom-background-color	background color the text rendered in the bottom

annotate-all

Scan for app icons in the directory and write on all icons found.

appiconannotator annotate-all -i . --top-text "1.0 (14)" --bottom-text "feature/swift3"

Option	Description
-h, --help	output usage information
-i, --input	directory to scan for app icons
--top-text	text rendered in the top
--bottom-text	text rendered in the bottom
--top-font-size	size of the text in the top
--top-text-color	color of the text rendered in the top
--top-background-color	background color the text rendered in the top
--bottom-font-size	size of the text in the bottom
--bottom-text-color	color of the text rendered in the bottom
--bottom-background-color	background color the text rendered in the bottom