Application Asset Generator
A tool to quickly generate mobile app assets. Supports just about any format you can think of.
Library is located within /lib
. Example usage within an API is located within /api
, and also hosted at https://app-asset-generator-api.draftbit.com.
Requirements
- GraphicsMagick (
brew install graphicsmagick
,port install GraphicsMagick
) - If using Illustrator files (.ai or .eps), ghostscript (
brew install ghostscript
,port install ghostscript
)
Getting Started
- Run
yarn
ornpm install
- To run server:
yarn start
- To process images from command line:
yarn process --imagePath= --color= [--outputDir=]
ORyarn process --imageUrl= --color= [--outputDir=]
API Usage
/icon
- Generates an app icon with the logo centered over a background color- Query Parameters:
logoUrl
- The URL of the logo to use for the app iconcolor
- The hex value of the background color of the app icon
- Example: https://app-asset-generator-api.draftbit.com/icon?logoUrl=https://upload.wikimedia.org/wikipedia/commons/thumb/c/c2/F_icon.svg/1000px-F_icon.svg.png&color=fff
- Query Parameters:
/splash
- Generates a splash screen with the logo centered over a background color or image- Query Parameters:
logoUrl
- The URL of the logo to use for the splash screencolor
- The hex value of the background color of the splash screen. Eithercolor
orbackgroundUrl
is requiredbackgroundUrl
- The URL of the image to use for the background of the splash screen. Eithercolor
orbackgroundUrl
is required
- Example: https://app-asset-generator-api.draftbit.com/splash?logoUrl=https://upload.wikimedia.org/wikipedia/commons/thumb/c/c2/F_icon.svg/1000px-F_icon.svg.png&color=fff
- Query Parameters:
yarn process
Arguments
- imagePath The path of the input logo image to be used for asset generation. Either
imagePath
orimageUrl
is required - imageUrl The URL of the input logo image to be used for asset generation. Either
imagePath
orimageUrl
is required - color The color to use as the asset background color
- (Optional) backgroundImagePath The path of the image to use as the background of the splash screen
- (Optional) backgroundImageUrl The URL of the image to use as the background of the splash screen
- (Optional) outputDir The directory to output the assets. If not specified, the current directory will be used