image-processor

Generates imagesets for iOS and drawables for Android

Installation

npm i -g @smartface/image-processor

Usage

sfImageProcessor  --srcImage [IMAGE-PATH] --destiOSFolder [DEST_IOS_FOLDER] --destAndroidFolder [DEST_ANDROID_FOLDER]

--srcImage         : must be absolute path (required)
--destiOSFolder    : must be absolute path (required)
--destAndroidFolder: must be absolute path (required)
--scaleFactor      : scale factor of given 'srcImage' float value ( 1.5, 3) (optional)
--delete           : flag -> delete images from 'destiOSFolder' and 'destAndroidFolder' (optional)
--isIconImage      : flag -> generate given image as AppIcon (icons)    
--isLaunchImage    : flag -> generate given image as LaunchImage (splash images)   
--minimize         : flag -> minimizes image that will be generated as possibly as. default value is false (optional) 

Example input: smartface.png, smartface.ios.png, smarface.android.4x.png

Description

1. parse srcImage
   • image(.$(OS))(.$(SCALE)).png
2. generate images by $(OS) and $(SCALE)

Default $(SCALE) is 3x

Examples

srcImage=smartface.png

sfImageProcessor --srcImage=/images/smartface.png --destAndroidFolder=/android --destiOSFolder=/ios

Generates:

- /ios/smartface.imageset
    - smartface.png
    - [email protected]
    - [email protected]
- /android/drawable-mdpi/smartface.png
- /android/drawable-hdpi/smartface.png
- /android/drawable-xhdpi/smartface.png
- /android/drawable-xxhdpi/smartface.png

srcImage=smartface.ios.png

sfImageProcessor --srcImage=/images/smartface.ios.png --destAndroidFolder=/android --destiOSFolder=/ios

Generates:
    
- /ios/smartface.imageset
    - Contents.json   
    - smartface.png
    - [email protected]
    - [email protected]

srcImage=smartface.ios.2x.png

sfImageProcessor --srcImage=/images/smartface.ios.2x.png --destAndroidFolder=/android --destiOSFolder=/ios

Generates:
    
- /ios/smartface.imageset
    - Contents.json   
    - smartface.png
    - [email protected]

srcImage=smartface.android.4x.png

sfImageProcessor --srcImage=/images/smartface.android.4x.png --destAndroidFolder=/android --destiOSFolder=/ios

Generates:
    
- /android/drawable-mdpi/smartface.png
- /android/drawable-hdpi/smartface.png
- /android/drawable-xhdpi/smartface.png
- /android/drawable-xxhdpi/smartface.png
- /android/drawable-xxxhdpi/smartface.png

You can generate AppIcon (icons)

given srcImage size should be 1024 X 1024 at least.

sfImageProcessor --srcImage=/images/icon.png --destAndroidFolder=/android --destiOSFolder=/ios --isIconImage=true

Generates:

- /ios/AppIcon.appiconset
    - Icon-40.png
	- [email protected]
	- [email protected]
	- Icon-72.png
	- [email protected]
	- Icon-76.png
	- [email protected]
	- Icon-Small-50.png
	- [email protected]
	- Icon-Small.png
	- [email protected]
	- Icon.png
	- [email protected]
	- [email protected]
	- [email protected]
	- [email protected]
	- [email protected]
	- Icon-Small.png
	- [email protected]
	- [email protected]
	- [email protected]
	- [email protected]
	- NotificationIcon~ipad.png
	- [email protected]
	- ios-marketing.png
- /android/drawable-mdpi/icon.png
- /android/drawable-hdpi/icon.png
- /android/drawable-xhdpi/icon.png
- /android/drawable-xxhdpi/icon.png
- /android/drawable-xxxhdpi/icon.png
- /android/drawable/icon.png

You can generate LaunchImage (splash images)

given srcImage size should be 2208 X 2208 at least.

sfImageProcessor --srcImage=/images/splash.png --destAndroidFolder=/android --destiOSFolder=/ios --isLaunchImage=true

Generates:

- /ios/LaunchImage.launchimage
	- [email protected]
	- [email protected]
	- Default.png
	- [email protected]
	- [email protected]
	- [email protected]
	- [email protected]
	- Default~ipad.png
	- [email protected]
	- Default~ipad~landscape.png
	- [email protected]
	- Default~ipad~nostatusbar.png
	- Default~ipad~nostatusbar.png
	- [email protected]
	- [email protected]
	- Default~ipad~landscape~nostatusbar.png
	- Default~ipad~landscape~nostatusbar.png
	- [email protected]
	- [email protected]
	- [email protected]
	- [email protected]
	- [email protected]
- /android/drawable-mdpi/splash_image.png
- /android/drawable-hdpi/splash_image.png
- /android/drawable-xhdpi/splash_image.png
- /android/drawable-xxhdpi/splash_image.png
- /android/drawable-xxxhdpi/splash_image.png
- /android/drawable/splash_image.png

Note

If --delete flag is set, deletes generated images.