Log inGet started
World

Pixel Ledges: 2D Platformer Kit with Sprites, Tilemaps, Wall Jumps and Dash

README.md

paint

A small raster painter for making pixel art in code (rectangles, lines, ellipses, polygons, ordered Bayer dithering, dithered gradients through a colour ramp, 1 px outlines, ASCII-art stamps, blits and colour replacement), plus deterministic random numbers and tileable value noise, and saving the result as a nearest-filtered texture asset and a material on the kit's sprite or parallax shader.

Every sprite sheet, tile set and background in twoDKit is painted with it. require("pixelPaint.paint"); twoDKit also offers it as twoDKit.paint.

Coordinates are pixels with (0, 0) at the TOP-LEFT and +y down. Colours are { r, g, b, a } tables, 0..255. Painting with partial alpha blends over what is there; alpha 0 or 255 writes the pixel as-is.

API

Colours and randomness:

  • Paint.hex("#rrggbb" | "#rrggbbaa", a?), Paint.ramp({ hex... }), Paint.mix(a, b, t), Paint.shade(c, factor), Paint.CLEAR.
  • Paint.rng(seed): xorshift32 with next(), int(a, b), chance(p), pick(list); the same art on every run and machine.
  • Paint.noise(x, y, seed, period?): 2D value noise 0..1, tileable when period is given. Paint.bayer(x, y), 4 x 4 ordered-dither threshold.

Canvas (Paint.canvas(w, h, fill?)), methods called with ::

  • set, get, alpha, inside, clear(x, y, w, h).
  • rect, frame (1 px border), line, ellipse(cx, cy, rx, ry, c, outlineOnly?), circle, poly({ x1, y1, x2, y2, ... }, c).
  • dither(x, y, w, h, c, level, onlyOpaque?), gradient(x, y, w, h, ramp).
  • outline(c, x?, y?, w?, h?, diagonal?): 1 px outline outside every opaque pixel in the region.
  • rows(x, y, { "..ab.." }, palette, flipX?): paint ASCII art; . and space are skipped.
  • blit(src, sx, sy, w, h, dx, dy, flipX?), replace(from, to), copy(), toPng().

Saving:

  • Paint.save(canvas, folder, name, { wrap? }) -> path: writes <folder>/<name>.texture (sprite, nearest filter, no mips, lossless; wrap = "repeat" repeats horizontally for backgrounds). Saving over an existing texture rewrites its source image.
  • Paint.material(folder, name, textureIdentity, shader?) -> path: writes <folder>/<name>.material on pixelSprites.sprite, or pixelParallax.parallax when shader == "parallax" (cutout, alpha cutoff 0.5).
local Paint = require("pixelPaint.paint")
local c = Paint.canvas(16, 16)
c:rect(0, 0, 16, 16, Paint.hex("#3a2a1e"))
c:dither(0, 8, 16, 8, Paint.hex("#2a1d14"), 0.5)
c:frame(0, 0, 16, 16, Paint.hex("#120c08"))
Paint.save(c, "/source/myArt", "crate", {})
Paint.material("/source/myArt", "crate", "myArt.crate")