/cordova-icon

Automatic icon resizing for Cordova

Primary LanguageJavaScriptMIT LicenseMIT

cordova-icon

Automatic icon resizing for Cordova. Create an icon in the root folder of your Cordova project and use cordova-icon to automatically resize and copy it for all the platforms your project supports (currenty works with iOS, Android and Windows 10).

Installation

 $ sudo npm install cordova-icon -g

Requirements

  • ImageMagick installed (Mac: brew install imagemagick, Debian/Ubuntu: sudo apt-get install imagemagick, Windows: See here)
  • At least one platform was added to your project (cordova platforms docs)
  • Cordova's config.xml file must exist in the root folder (cordova config.xml docs)

Usage

Create an icon.png file in the root folder of your cordova project. You can provide a platform-specific icon by naming it icon-[platform].png (e.g icon-android.png, icon-ios.png). Then run:

 $ cordova-icon

For good results, your file shoud be:

  • square
  • for Android and iOS, at least 192*192px (512*512px recommended to be future-proof)
  • for Windows, at least 1240*1240px

Creating a cordova-cli hook

Since the execution of cordova-icon is pretty fast, you can add it as a cordova-cli hook to execute before every build. To create a new hook, go to your cordova project and run:

$ mkdir hooks/after_prepare
$ vi hooks/after_prepare/cordova-icon.sh

Paste the following into the hook script:

#!/bin/bash
cordova-icon

Then give the script +x permission:

$ chmod +x hooks/after_prepare/cordova-icon.sh

That's it. Now every time you cordova build, the icons will be auto generated.

Splash screens

Check out cordova-splash

License

MIT