|
|
→ |
|
Converts noisy, high-resolution pixel-art-style images (from generative models or low-quality web uploads) into clean, true-resolution assets. Such images often have a non-uniform grid and random artifacts, so standard downsampling fails — the usual alternatives are naive downscaling or redrawing the asset pixel by pixel. This tool automates the recovery instead. Videos and GIFs are supported too.
pip install proper-pixel-art # CLI and Python API
pip install "proper-pixel-art[web]" # Include the local web UI
Or with uv:
uv add proper-pixel-art # CLI and Python API
uv add proper-pixel-art --extra web # Include the local web UI
git clone git@github.com:KennethJAllen/proper-pixel-art.git
cd proper-pixel-art
uv sync --extra web
First, obtain a source pixel-art-style image (e.g. from a generative model such as OpenAI's gpt-image-2, or a web upload of pixel art).
The examples below assume you installed via
pip installoruv add(commands are on yourPATH). If you installed from source withuv sync, prefix each command withuv run(e.g.uv run ppa ...).
Try it live in your browser, no install required, on Hugging Face Spaces.
To run the same interface locally:
ppa-web
# Opens http://127.0.0.1:7860
ppa <input_path> -o <output_path> -c <num_colors> -s <result_scale> [-t]
| Option | Description |
|---|---|
| INPUT (positional) | Source image, video, or GIF in pixel-art style |
-o, --output <path> |
Output directory or file path for result. (default: '.') |
-c, --colors <int> |
Number of colors for output (1-256). Use 0 to skip quantization and preserve all colors. May need to try a few different values. (default 0) |
-s, --scale-result <int> |
Width/height of each "pixel" in the output. 1 = no scaling. (default: 1) |
-t, --transparent |
Output with transparent background. (default: off) |
-u, --initial-upscale <int> |
Initial image upscale factor. Increasing this may help detect pixel edges. (default 2) |
-w, --pixel-width <int> |
Width of the pixels in the input image. Use 0 to determine it automatically. (default: 0) |
--config <path> |
YAML config file of pixelation parameters. Flags passed explicitly override values in the file. (default: none) |
--intermediate-dir <path> |
Directory to save images visualizing intermediate algorithm steps. Useful for development. (default: none) |
ppa assets/blob/blob.png -c 16 -s 25
Note: --colors is the parameter most likely to need tuning. See the option table above.
Video and GIF inputs are recognized by extension, so the same ppa command pixelates animations too (e.g. from video models such as Sora). The pixel mesh and color palette are computed once from sampled frames and applied to every frame, so the animation stays consistent with no flicker.
ppa <input.mp4|input.gif> -o <output_path> -c <num_colors>
The output format follows the output extension (e.g. -o out.mp4 converts a GIF to MP4), and all the pixelation options and --config from the table above apply:
ppa <input.mp4|input.gif> -o <output_path> --config config.example.yaml
Two extra options apply to video/GIF inputs (they are ignored for images):
| Option | Description |
|---|---|
-f, --format <mp4\|gif> |
Output format. (default: inferred from output, then input, extension) |
-n, --sample-frames <int> |
Frames sampled for mesh and palette detection. (default: 8) |
The ppa-video command is a deprecated alias for ppa, kept for compatibility.
GIF input is decoded with full frame compositing (variable-size delta frames, per-frame durations, and transparency are preserved). GIF output uses a single global palette.
From Python:
from proper_pixel_art.video import pixelate_video
pixelate_video('input.mp4', 'output.gif', num_colors=16)
uvx --from "proper-pixel-art[web]" ppa-web
uvx --from "proper-pixel-art" ppa <input_path>
For Python developers who want to integrate this tool into their own code.
from PIL import Image
from proper_pixel_art import pixelate
image = Image.open('path/to/input.png')
result = pixelate(image, num_colors=16)
result.save('path/to/output.png')
These mirror the CLI options above.
image : PIL.Image.Image — the image to pixelate.num_colors : int — colors in result (1-256), or 0 to skip quantization. Most likely to need tuning.initial_upscale_factor : int — upscale the input first; may help detect lines.scale_result : int — upscale the result; 1 = no scaling.transparent_background : bool — if True, make all pixels matching the most common boundary color transparent.intermediate_dir : Path | None — save visualizations of intermediate steps (for development).pixel_width : int — pixel width in the input, or 0 to detect automatically.config : PixelateConfig | None — a bundle of every tunable parameter, including the deeper mesh-detection (Canny, Hough, line clustering) and color (alpha/transparency thresholds, quantization method, color binning) settings not exposed as direct arguments. Load one with PixelateConfig.from_yaml(path). Explicit arguments override matching values in config.A PIL image with true pixel resolution and quantized colors.
All tunable parameters can be collected in a YAML file so you can fine-tune the algorithm without changing code. See config.example.yaml for the full list of keys with their defaults. Any key you omit falls back to the default, so partial files are fine.
from PIL import Image
from proper_pixel_art import pixelate
from proper_pixel_art.config import PixelateConfig
config = PixelateConfig.from_yaml('config.yaml')
result = pixelate(Image.open('input.png'), config=config)
From the CLI, pass --config. Flags given explicitly override values from the file:
ppa input.png --config config.yaml # use the file
ppa input.png --config config.yaml -c 8 # but override num_colors to 8
The algorithm is robust. It performs well for images that are already approximately aligned to a grid.
Here are a few examples. A mesh is computed, where each cell corresponds to one pixel.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This tool can also be used to convert real images to pixel art by first requesting a pixelated version of the original image from GPT-4o, then using the tool to get the true pixel-resolution image.
Consider this image of a mountain
![]()
|
|
|
|
Here's a step-by-step overview, applied to this GPT-4o-generated blob:
![]()
<img src="https://raw.githubusercontent.com/KennethJA
$ claude mcp add proper-pixel-art \
-- python -m otcore.mcp_server <graph>