README

AppIconKit

An app icon/image assets generator for apps.

CLI

Installation

Install the package globally.

npm install -g appiconkit

The default command is icon.

icon [options] <input> [output]

Options

-t, --type <type>: Type for generated assets. Can be icon | image.

-p, --platform <platform>: Platform for icon set. Can be ios | watchos | macos | web.

Please note that for web platform, favicons will be generated, along with code.txt that includes HTML code.

Please note that default value means that keeps the original format. For icon type, this option will be ignored and only PNG will be generated. On Apple platforms, only JPEG and PNG will be generated.

-W, --width <number>: @1x width for generated image set.

-H, --height <number>: @1x height for generated image set.

Please note that width and height are for generated @1x image. If both weight and height are given, the image will be resized to exactly weight and height. If one of width and height is given, it will automatically choose the other dimension for the resized images. If none of them is given, the original image is used as @3x.

-h, --help: Shows the help.

Usage

Install the package under your project.

npm install --save appiconkit

Import the dependency in your code.

const { IconGenerator } = require('appiconkit');

Initialize an IconGenerator instance.

let g = new IconGenerator();

Call proper functions to generate imageset or appiconset.

g.generateIconSet('/path/to/image', '/path/to/output');

Or you can call generateImageAssets and pass your own options.

g.generateImageAssets('/path/to/image', '/path/to/output', {
  type: 'image',
  platform: 'ios',
  width: 160,
  height: 120,
  format: 'png',
});

You can also call generateImages and pass an array of ResizeOption to export a set of images that fit your need.

g.generateImages('/path/to/image', '/path/to/output', [{
  width: 16,
  height: 16,
  filename: '16icon',
  format: 'png',
}, {
  width: 32,
  height: 32,
  filename: 'anotherIcon',
  format: 'tiff',
}]);

License

The project is released under MIT license. Please see LICENSE for full terms.

Usage no npm install needed!