svg-mask2png v0.4.4

SVG-mask2PNG

It's a node package to extract to PNG every object inside a SVG file when their ID match a mask.

Important This is not a real extractor! Is more like a helper. You MUST have inkscape in your path to execute the real extraction of images.

Install

npm install [-g] svg-mask2png

Usage

You can require it on your code:

var svgMask2png = require('svg-mask2png');

svgMask2png(['input.svg'], {  // <- notice filename is an array!
    color   : '#f2f2f2',
    outpath : 'images',
    flat    : true
})
.then(function(result){
    console.log('extracted objects: ', result[0]);
    console.log('total objects: ', result[1]);
})
.catch(function(err){
    console.log(err);
});

Or, if installed as global, you can execute:

$ svg-m2png --help

#example
$ svg-m2png -o images input.svg [other.svg ...]

Options

Workflow

I like to create all my image assets inside a single SVG file, then name all of them to its final png's name (plus the stating mask).

When creating fixed size images with transparent background I usually use a known color since it is easier to manipulate and define its size. Then group that background with the draw over it, name the group and instruct this helper to convert that color to transparent prior extraction.

$ svg-m2png -o images input.svg --transparent "#f2f2f2"

Developing

If you want to change the code:

# clone it to a local folder
git clone git@github.com:xgvargas/svg-mask2png.git

# install dependencies
npm install -g coffeescript
npm install

# install in dev mode
npm link

# compile code with:
npm run compile
# or
npm run watch