vpype-pixelart

vpype plug-in to plot pixel art.

Usage

Convert pixelart image to vectors

The pixelart command takes an image file as input and converts it to lines according to one of three modes (big, line, and small – see examples below). Each unique color in the the input file results in a new layer created. Pixels which are 100% transparent (alpha = 0) yield no output.

Example invocation:

$ vpype pixelart --mode snake --pen-width .35mm input.png linesort write output.svg

Inline help:

$ vpype pixelart --help

Convert geometries to bitmaps and back to vector

The pixelize command rasterizes the current geometries into a bitmap, and converts them back to vectors similarly to the pixelart command.

Example invocation:

$ vpype read input.svg pixelize --mode snake --pen-width .35mm linesort write output.svg

Inline help:

$ vpype pixelize --help

Examples

Mode big

In this mode, each pixel is drawn using a 5x5 square spiral. The pixel pitch is thus five times the specified pen width.

Cactus sprites from Super Mario World:

Result plotted with Pentel Sign Pen (using --pen-width 0.6mm):

Mode line

In this mode, horizontal lines are generated for horizontal sequences of same-color pixels. The pixel pitch is equal to the specified pen width.

Original art by Reddit user u/_NoMansDream:

Result plotted with Pentel Sign Pen (using --pen-width 0.6mm):

Mode snake

In this mode, [snake](https://en.wikipedia.org/wiki/Snake_(video_game_genre)-like lines attempt to traverse zones of contiguous, same-color pixels. Again, the pixel pitch is equal to the specified pen width.

Detail of the snake algoritm:

Result plotted with Pentel Sign Pen (using --pen-width 0.5mm):

pixelize command

Series of cubes created with vpype-perspective and pixelated using pixelize:

Installation

See vpype's installation instructions for information on how to install vpype.

Existing vpype installation

If vpype was installed using pipx, use the following command:

$ pipx inject vpype vpype-pixelart

If vpype was installed using pip in a virtual environment, activate the virtual environment and use the following command:

$ pip install vpype-pixelart

Check that your install is successful:

$ vpype --help
Usage: vpype [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...

Options:
  -v, --verbose
  -I, --include PATH  Load commands from a command file.
  --help              Show this message and exit.

Commands:
[...]
  Plugins:
    pixelart   Plot pixel art.
[...]

Stand-alone installation

Use this method if you need to edit this project. First, clone the project:

$ git clone https://github.com/abey79/vpype-pixelart.git
$ cd vpype-pixelart

Create a virtual environment:

$ python3 -m venv venv
$ source venv/bin/activate
$ pip install --upgrade pip

Install vpype-pixelart and its dependencies (including vpype):

$ pip install -e .

Check that your install is successful:

$ vpype --help
Usage: vpype [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...

Options:
  -v, --verbose
  -I, --include PATH  Load commands from a command file.
  --help              Show this message and exit.

Commands:
[...]
  Plugins:
    pixelart   Plot pixel art.
[...]

License

See the LICENSE file for details.