@kartotherian/makizushi

professional maki chef

Usage no npm install needed!

<script type="module">
  import kartotherianMakizushi from 'https://cdn.skypack.dev/@kartotherian/makizushi';
</script>

README

Build Status

makizushi

Professional Maki chef. This module produces custom markers based on the Maki icon set, in custom sizes and colors. To do this, it chooses, tints, and flattens parts of the image, using node-blend.

install

npm install --save @kartotherian/makizushi

updating icons

To use a newer version of Maki and extract the icons, you must have Inkscape installed locally. Then, update the package and extract:

npm install --also=dev
npm update
./render.sh

api

makizushi(options, callback)

Options:

  • tint: a color in rgb or rrggbb
  • symbol: a Maki symbol name, or a number from 0 to 99
  • size: one of s, m, or l
  • base: "pin"
  • retina: true or false, true will return a 2x resolution image

Callback: (err, data) in which err is an error if any, and data is a buffer of image data.

usage

var makizushi = require('makizushi');

makizushi({
    base: 'pin',
    size: 'l',
    tint: '333',
    symbol: 'car',
    retina: true
}, function(err, buf) {
    if (err) throw err;
    fs.writeFileSync('marker.png', buf);
});