Code Monkey home page Code Monkey logo

mobicon's Introduction

mobicon Build Status

Mobile app icon generator

Install

$ npm install --save mobicon

GraphicsMagick

This library depends on GraphicsMagick, so be sure to install this library as well.

Mac OSX

$ brew install graphicsmagick

Linux

$ sudo apt-get install graphicsmagick

Windows

Manual installation or via chocolatey.

$ choco install graphicsmagick

Usage

const mobicon = require('mobicon');

mobicon('icon.png', {platform: 'android'}).then(() => {
    // icons generated
});

mobicon('icon.svg', {platform: 'ios', background: '#ff0000', contentRatio: 1}).then(() => {
    // icons generated
});

API

mobicon(file, options)

file

Type: string

Source file of the icon.

options

platform

Required
Type: string
Values: pwa android ios blackberry10

Platform to generate the icons for.

background

Type: string
Default: white

Color of the icon background if the icon is transparant.

contentRatio

Type: number
Default: 1

Logo-icon ratio. 1 means the logo will fill up the entire width (or height) of the icon, 0.5 means it will only fill up half of the icon.

roundedCorners

Type: boolean
Default: true (only for Android and PWA)

Boolean indicating if the generated icons should have rounded corners. This is true by default for the Android and PWA platform, false otherwise.

borderRadius

Type: number
Default: 0.0909

The corner radius percentage of the generated icon. The default value is 9.09%. See the material design styleguide for more information.

dest

Type: string
Default: process.cwd()

Directory to save the generated icons.

Platforms

The supported platforms are PWA, Android, iOS and BlackBerry 10. Every platform generates a different set of icons.

PWA

  • icon-72x72.png
  • icon-96x96.png
  • icon-128x128.png
  • icon-144x144.png
  • icon-152x152.png
  • icon-192x192.png
  • icon-384x384.png
  • icon-512x512.png

Android

  • mipmap-ldpi/icon.png
  • mipmap-mdpi/icon.png
  • mipmap-hdpi/icon.png
  • mipmap-xhdpi/icon.png
  • mipmap-xxhdpi/icon.png
  • mipmap-xxxhdpi/icon.png

iOS

BlackBerry 10

  • icon-90.png
  • icon-96.png
  • icon-110.png
  • icon-144.png

Related

License

MIT © Sam Verschueren

mobicon's People

Contributors

7kfpun avatar nishtrack avatar samverschueren avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.