Code Monkey home page Code Monkey logo

vectorize-pixelart's Introduction

build-test

vectorize-pixelart

Convert raster pixel art graphics to vector.

Installation

$ npm install vectorize-pixelart

CLI usage

You may vectorize PNG image to SVG using next command:

$ vectorize-pixelart input.png output.svg

Also EPS output is supported:

$ vectorize-pixelart input.png output.eps

Online web usage

The package has been build with a Browserify version and available online:

http://zasenko.name/vectorize-pixelart.html

Main limitation of the web version is that browser has issues when processing large SVG files. As there are no control over image displaying some resulting SVG might cause browser hang.

API

Please check vectorize-pixelart.js code.

So, basic usage is next:

  1. Read raster image.
  2. Trace image
var fs  = require('fs'),
    PNG = require('pngjs').PNG,
    ContourTracing = require('vectorize-pixelart/contour-tracing'),
    paUtils = require('vectorize-pixelart/utils');

// PNGImageData provides transparent pixel retrieving/comparasion interface
let image = new paUtils.PNGImageData(PNG.sync.read(fs.readFileSync('in.png')));

// Vector composer
let composer = new paUtils.SVG(image.height, image.width);

process.stdout.write(composer.header());

let tracer = new ContourTracing(image);
tracer.traceContours((contour, pixel) => {
    // Output next traced contour
    process.stdout.write(composer.path(contour, pixel));
})

process.stdout.write(composer.footer());

Class: ContourTracing

Trace contours of a given image.

new ContourTracing(image)

Object image should contain height and width information. Also it should provide function comparePixels(y1, x1, y2, x2) { } and function getPixel(y1, x1). See PNGImageData.

ContourTracing.traceContours(callback)

Traces contours of a given image and return next contour to callback. The callback gets one argument (contour) that contains array of contour points [y, x].

Copyright

Copyright (C) 2019-2022 Sergii Zasenko

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

vectorize-pixelart's People

Contributors

dependabot[bot] avatar und3f avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

vectorize-pixelart's Issues

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.