About

@jolly-pixel/pixel-draw.renderer is a browser-based library for editing pixel-art textures. It provides zoom, pan, brush painting, right-click color picking, and an SVG cursor overlay, built around a SOLID-structured class architecture.

Features

• Zoom & pan — smooth mouse-wheel zoom with configurable sensitivity and range; middle-click pan in any mode
• Brush painting — configurable square brush with adjustable size, color, and opacity
• Color picking — right-click eyedropper that reads the master canvas pixel
• Transparency support — configurable checkerboard background renders beneath transparent pixels
• SVG brush highlight — grid-aligned SVG overlay tracks the cursor in real time
• Dual-canvas architecture — a master canvas (full resolution, off-screen) and a working canvas (viewport-cropped, on-screen) maintain pixel-perfect fidelity at any zoom level
• Mode switching — "paint" and "move" modes control how mouse events are interpreted

Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn.

$ npm i @jolly-pixel/pixel-draw.renderer
# or
$ yarn add @jolly-pixel/pixel-draw.renderer

Usage Examples

Minimal setup

import { CanvasManager } from "@jolly-pixel/pixel-draw.renderer";

const manager = new CanvasManager({
  texture: { size: 64 },
  zoom: {
    range: [0.5, 40],
    sensitivity: 0.002
  },
});

const container = document.getElementById("editor-container")!;
manager.reparentCanvasTo(container);
manager.resize();
manager.centerTexture();

Drawing pixels programmatically

import { CanvasManager } from "@jolly-pixel/pixel-draw.renderer";

const manager = new CanvasManager({
  texture: { size: 32 }
});
manager.reparentCanvasTo(document.body);

// Draw a red pixel at texture position (10, 10)
manager.textureBuffer.drawPixels(
  [{ x: 10, y: 10 }],
  { r: 255, g: 0, b: 0, a: 255 }
);
manager.render();

Loading an existing texture

const img = new Image();
img.src = "/assets/sprite.png";
await img.decode();

manager.setTexture(img);

Configuring the brush

manager.brush.setColor("#FF6600");
manager.brush.setOpacity(0.8);
manager.brush.setSize(3);

Switching modes

manager.setMode("move");  // left-click pans
manager.setMode("paint"); // left-click draws

Running the Examples

npm run dev -w @jolly-pixel/pixel-draw.renderer

Open http://localhost:5173 to see the interactive demo.

API

| Class | Description | |---|---| | CanvasManager | Top-level coordinator — the primary public API | | Viewport | Camera position, zoom level, and coordinate transforms | | BrushManager | Brush size, color, opacity, and affected-pixel computation | | TextureBuffer | Dual-canvas pixel storage and image-data access | | CanvasRenderer | Visible canvas drawing and checkerboard background | | InputController | Mouse event routing to drawing and pan actions | | SvgManager | SVG brush-highlight overlay |

Troubleshooting

Canvas is blank after mounting Call manager.resize() after reparentCanvasTo() to let the renderer read the parent element's dimensions, then call manager.centerTexture().

Pixels appear at the wrong position Pass { bounds: canvas.getBoundingClientRect() } when calling viewport.getMouseTexturePosition(). Stale bounding rects cause offset errors.

Master canvas is slow to initialize TextureBuffer pre-allocates a canvas at maxSize (default 2048). In test environments or when large textures are unnecessary, set texture.maxSize to a smaller value such as 64.

Contributors Guide

If you are a developer looking to contribute to the project, you must first read the CONTRIBUTING guide.

Once you have finished your development, check that the tests (and linter) are still good by running the following script:

$ npm run test
$ npm run lint

[!CAUTION] In case you introduce a new feature or fix a bug, make sure to include tests for it as well.

License

MIT