img-res-generator v0.6.5

image-res-generator

Introduction

Automatic icon and splash screen resizing CLI tool for Cordova/Ionic/PhoneGap based applications and PWAs.

It automatically resizes and copies your icon.png and splash.png files to the platform dedicated directories.

It does NOT require any external binary libraries. Javascript only.

Usage

Required files

Add your icon and splash files to the 'resources' folder under the root of your project. Make sure they are atleast (1024px x 1024px) for icons and (2732px x 2732px) for splash images.

resources/
├── icon.png
└── splash.png

Command line

    $ image-res-generator

or

    $ irgen

ATTENTION: while preserving source files, it overwrites previous output if any.

Options

-V, --version               output the version number
-i, --icon [optional]       optional icon file path
                            (default: ./resources/icon.png)
-s, --splash [optional]     optional splash file path
                            (default: ./resources/splash.png)
-p, --platforms [optional]  optional platform token comma separated list
                            available tokens: android, ios, windows, blackberry10, pwa
                            (default: all platforms processed)
-o, --outputdir [optional]  optional output directory
                            (default: ./resources/)
-I, --makeicon [optional]   option to process icon files only
-S, --makesplash [optional] option to process splash files only
-h, --help                  output usage information
-d, --debug                 output debugging information

Do yourself a favour

Add to your package.json a script definition to match your file generation needs. This way, you won't have to repeat the whole command along with the options.

An example

{
  ...
  "scripts": {
    ...
      "resgen": "irgen -p android,ios"
  }
}

All you have to do then is type :

npm run resgen

NPM will cope with typing the whole command line for you.

Platforms

Supported platforms:

• iOS
  • icons
  • splash screens
• Android
  • icons
  • splash screens
• Windows
  • icons
  • splash screens
• Blackberry 10
  • icons
• PWAs
  • icons

Contributing

Thanks for your interest in contributing! Read up on our guidelines to start contributing.

Credits

This open-source project is made possible with the help and support of the amazing open source community. Special thanks to:

• All contributors in this project ✨💚.
• @olivab for creating and maintaining the original project cordova-res-generator.
• Contributors to cordova-res-generator.

License

This project is made available under the terms of the GPLv3. See the LICENSE file for the full text of the license.