pixelfx
pixelfx by Patch: pixel art effects and animations as code.
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Check it deeper on your machine
It has changed since its scan on 11 Nov 2026. Its scripts were only partly scanned.
As a Claude Code plugin, install it and then ask Claude Code:
/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/patch-gg/pixelfx with scanskillsafety
Or from a terminal, clone it and run it:
git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/patch-gg/pixelfx'
It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.
Badge for your README
Markdown
[](/listings/patch-gg--pixelfx)HTML
<a href="/listings/patch-gg--pixelfx"><img src="/api/listings/patch-gg--pixelfx/badge.svg" alt="findsafeskills safety rating" /></a>Install
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
.claude-plugin/marketplace.json · Manifest · 17 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.
- {
- "name": "pixelfx",
- "description": "pixelfx by Patch: pixel art effects and animations as code.",
- "owner": {
- "name": "Patch",
- "url": "https://patch.gg"
- },
- "plugins": [
- {
- "name": "pixelfx",
- "source": "./",
- "description": "A skill for pixel art effects and sprite animations: use, recolor and export the library's effects, or draft, render, look at and refine new ones until they look hand-animated.",
- "category": "gamedev",
- "tags": ["pixel-art", "vfx", "animation", "sprite-sheet", "gamedev"]
- }
- ]
- }
README.md · README · 223 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.
- <p align="center">
- <img src="docs/readme/montage.gif" width="800" alt="A grid of pixel art effects playing at once: a campfire, a burning skull, a waterfall, a plasma ball, a portal, a tornado and more.">
- </p>
- # pixelfx.
- **<!-- count -->244<!-- /count --> pixel art effects and animations, every one a small piece of code.** Fire,
- explosions, magic, weather, UI, pickups, critters and more. Play them live, recolor and mirror them, drop them into
- a browser game, or export sprite sheets for any engine. Plus a Claude Code skill that makes new ones the way a
- picky pixel artist would: draft, render, look, refine.
- Every effect that involves a character is **acted out**: he winds up, lets go, freezes on contact and recovers, and a
- target takes the hit. Twelve whole moves chain the effects into attacks from wind-up to recovery.
- It's also a block on Patch: [play pixelfx on Patch](https://patch.gg/patch/pixel-effects), pick an effect and a
- palette, and start a browser game from it.
- **[open the gallery](https://patch-gg.github.io/pixelfx/)** · [catalog](docs/CATALOG.md) · [acting](#acting) ·
- [the skill](#the-skill) · [make your own](#make-your-own) · [publish it on patch](#publish-it-on-patch) ·
- [how it works](#how-it-works)
- The method is [Hugo Duprez](https://x.com/HugoDuprez)'s, from [How to make (good) pixel art effects with
- Claude](https://www.spritefusion.com/blog/how-to-make-good-pixel-art-effects-with-claude): code is clay, trust your
- eyes, feed your references. His [open-source effects](https://www.spritefusion.com/pixel-art-vfx) at Sprite Fusion
- set the bar, and `src/core/sim.js` and the effects that say so at the top adapt his code. This repo is our take on
- the idea at library scale, with a skill to keep going.
- ## what's in it.
- <!-- catalog -->
- | category | effects | some of them |
- |---|---|---|
- | **moves** | 12 | arrow shot, dash strike, earth stomp, fireball throw, ground pound, holy smite… |
- | **fire** | 12 | brazier, campfire, candle, fire breath, fire ring, fire tornado… |
- | **explosions** | 12 | barrel explosion, big explosion, cartoon pow, dirt explosion, firework burst, firework rocket… |
- | **water** | 12 | bubbles, drip, fountain, geyser, rain splash, ripples… |
- | **ice** | 10 | blizzard vortex, freeze, frost breath, frost nova, ice crystal, ice lance… |
- | **lightning** | 11 | ball lightning, chain lightning, charge up, electrified, lightning strike, plasma ball… |
- | **sci-fi** | 12 | emp blast, energy core, force field, glitch, hologram, jetpack… |
- | **melee** | 12 | claw swipe, dagger flurry, double slash, hammer smash, heavy cleave, scythe reap… |
- | **impacts** | 11 | blunt hit, bullet impact, critical hit, ground slam, heavy landing, hit flash… |
- | **projectiles** | 13 | arrow, bullet tracer, cannon shot, energy disc, signal flare, homing missile… |
- | **spawn & death** | 10 | coin drop, disintegrate, dissolve burn, egg hatch, poof, respawn beam… |
- | **arcane** | 12 | arcane beam, arcane missiles, arcane orb, blink in, blink out, magic circle cast… |
- | **holy** | 10 | blessing, divine shield, feather burst, halo, heal, healing ring… |
- | **shadow** | 12 | black hole, curse, dark explosion, eclipse, grasping hands, hex sigil… |
- | **status** | 13 | bleeding, burning, charmed, confused, cursed, frozen… |
- | **nature** | 13 | acid splash, boulder, earth spike, healing bloom, leaf storm, poison cloud… |
- | **weather** | 12 | aurora, blizzard, cherry blossoms, clouds, falling leaves, fireflies… |
- | **ui** | 12 | achievement, coin collect, combo counter, confetti, countdown, crit number… |
- | **pickups** | 11 | chest open, coin spin, collect burst, crystal shard, gem spin, heart pickup… |
- | **transitions** | 10 | blinds, burn away, crt off, diamond wipe, glitch wipe, iris… |
- | **critters** | 12 | bat, bird, butterfly, eyeball, fish school, flying skull… |
- <!-- /catalog -->
- Every effect is a file in `src/fx/<category>/<name>.js`. The [catalog](docs/CATALOG.md) lists them all.
- ## use one.
- **In a browser game** (canvas, Phaser, PixiJS, Kaplay, three.js), use the code. No dependencies.
- ```js
- import { createFrame, clearFrame, createFx, composite } from "pixelfx";
- import * as frostNova from "pixelfx/fx/ice/frost-nova";
- const frame = createFrame(320, 180); // your game's pixel resolution
- const img = new ImageData(320, 180);
- const fx = createFx(frostNova, { x: 160, y: 140 }); // also: flip, angle, seed, palette, light...
- function tick(dt) {
- fx.update(dt);
- clearFrame(frame);
- fx.draw(frame, "back"); // behind characters
- drawCharacters();
- fx.draw(frame, "front");
- composite(frame, img.data, backgroundColor); // color, then light added on top
- ctx.putImageData(img, 0, 0); // scale up with image-rendering: pixelated
- }
- ```
- Install from GitHub with `npm i github:patch-gg/pixelfx`, or copy `src/core` and the effects you want.
- **In any engine** (Godot, Unity, GameMaker, Defold, LÖVE, Bevy), use sprite sheets:
- ```bash
- node tools/render.mjs ice/frost-nova --sheet
- ```
- That writes a transparent PNG of every frame in a grid and an Aseprite-style JSON (frame rects, durations, and
- `meta.pixelfx` with fps, loop, columns and the pivot). Phaser's atlas loader and the Aseprite importers for Godot
- and Unity read it. `node tools/sheets.mjs` exports the whole library to `sheets/`.
- Any effect takes a `palette` (a dark-to-bright ramp of hex colors), so a fire can burn blue and a heal can glow
- pink without touching its code:
- ```bash
- node tools/render.mjs fire/torch --gif --opts '{"palette": ["#102","#215","#43a","#8cf","#cff","#fff"]}'
- ```
- ## acting.
- <p align="center">
- <img src="docs/readme/acts.gif" width="800" alt="A grey dummy fighting a straw target: a three-stroke sword combo, a hammer smash, a ground pound, a holy smite, a frost nova and a run with after-images, each with a wind-up, a freeze on contact and a recovery.">
- </p>
- An effect on its own looks like a sticker. What sells a hit is the body around it: the wind-up that says something is
- coming, the freeze on contact, the target rocking back, the recovery. So the 61 effects with a character, and the 12
- moves, say what the body does and when:
- ```js
- export const act = {
- target: { x: 58 },
- poses: [
- [-0.55, GUARD], // he starts before the effect does (t = 0 is the effect's first frame)
- [-0.3, WIND_UP],
- [0, CUT, "snap"], // "snap" holds the last pose and jumps on the key
- [0.06, FOLLOW_THROUGH, "snap"],
- [0.86, GUARD],
- ],
- hits: [{ t: 0.06, stop: 0.14, shake: 0.18, amp: 2, push: 2.8, straw: 18 }], // freeze for 0.14 s on contact
- };
- ```
- **Play the whole thing**, character and target included, by swapping `createFx` for `createAct`:
- ```js
- import { createFrame, clearFrame, createAct, composite } from "pixelfx";
- import * as slash from "pixelfx/fx/melee/sword-slash";
- const act = createAct(slash, { x: 80, y: 140 });
- function tick(dt) {
- act.update(dt); // holds still by itself during a freeze
- clearFrame(frame);
- act.draw(frame); // { body: false } and { target: false } leave them out
- composite(frame, img.data, backgroundColor);
- const [sx, sy] = act.shake; // throw the picture this far
- ctx.putImageData(img, sx, sy);
- }
- ```
- **Got your own character?** Effect ids haven't changed and a sprite sheet is still the effect alone, so existing games
- keep working. (Effects drawn on the body paint the stock dummy, so regenerate those if you ship them.) The timing is plain data: read `slash.act`, or `meta.pixelfx.act` in a sprite sheet's
- JSON (`windup`, `recovery`, `hits` with `t` and `freeze`, `poses`). Start your own wind-up animation that long before the effect, and
- stop updating everything for `freeze` seconds at each hit.
- Effects drawn on the body (frost, poison, a scan line) are written against the standing character and follow him
- wherever he goes: each pixel of a pose knows which pixel of the standing body it came from. `node tools/act.mjs
- <id> --sheet` bakes a whole act, character included, into a sprite sheet.
- The body is yours to use too: `skeleton(pose)` gives you every joint of a pose in 3D, to hang your own things on, and
- `posedParts(pose)` gives you each part drawn on its own.
- ## the skill.
- The `pixelfx` skill teaches Claude Code to find, use, export and make effects. Install it as a plugin:
- ```
- /plugin marketplace add patch-gg/pixelfx
- /plugin install pixelfx@pixelfx
- ```
- or copy `skills/pixelfx` into `~/.claude/skills/`. Then ask for what you want:
- - "Add a frost nova to my mage's ultimate."
- - "Make five takes on a coin pickup sparkle and show me the best two."
- - "Export the fire and explosions categories as sprite sheets for Godot."
- - "This hit effect feels floaty. Make it punchier."
- - "Give this spell a wind-up and make the enemy react to it."
- ## make your own.
- ```bash
- node tools/new.mjs arcane/my-spell # a working starting point (add --loop for a loop)
- node tools/render.mjs arcane/my-spell # records/arcane/my-spell/contact.png: look at it
- node tools/check.mjs arcane/my-spell # spills, seams, unseeded randomness, slow frames
- ```
- Then go round: look at the contact sheet, fix the worst thing, render again. `--gif` and `--mp4` show the motion,
- `--all` shows every frame. `node tools/act.mjs arcane/my-spell` shows an act as consecutive 12 fps steps, because motion
- bugs don't show in samples. [docs/AUTHORING.md](docs/AUTHORING.md) has the contract, the drawing API and the quality
- bar. `node tools/serve.mjs` runs the gallery locally with your effects in it.
- ## publish it on patch.
- Made a browser game with these? Put it on [Patch](https://patch.gg), where people play and remix browser games and
- mods. Install `pch`, Patch's command line, then restart your coding agent and ask it to publish the game: the install
- gives every agent on your PC Patch's tools. Or run it yourself:
- ```bash
- npm i -g @patchgg/cli # or: curl -fsSL https://patch.gg/install.sh | sh
- pch login
- pch init # in your game's folder; it says what's next
- pch publish
- ```
- Publishing needs [Patch Desktop](https://docs.patch.gg/get-started) open on a Windows PC: it plays your game once to
- test it before it goes live. The [quickstart](https://docs.patch.gg/quickstart) has the rest.
- ## how it works.
- - **Two kinds of effect, no images.** Pure effects export `draw(p, t, o)`, the frame at `t` seconds from `t` alone, so
- loops tile with no seam. Simulated effects export `create(o)` and step real particles, debris and lights at 120 Hz,
- so sparks bounce and smoke rolls the same at any frame rate.
- - **Two buffers.** `color` takes pixels: opaque, dithered or truly translucent. `light` takes additive glow, added on
- top. Hot things look hot because of the light buffer.
- - **Seeded everything.** Every random number comes from the effect's seed, so frame 40 is the same every time.
- - **Local space.** Effects draw around their own origin; the painter places, mirrors and rotates them. Directional
- effects face right. A 24×38 stock character stands in for status effects, auras and hits.
- - **A real skeleton, drawn down to pixels.** The grey dummy is neutral on purpose, so the eye goes to the move and any effect's
- colors read on it. He's a 3D skeleton with fixed-length bones, pelvis to spine to shoulders, rendered in a few flat tones with one clean
- ink line, the way Dead Cells makes its sprites. So he can twist, bend and really turn round, and depth decides what's in front. Poses hold on 12 fps
- steps, the way hand-drawn sprites do, while particles run at full rate.
- - **Same frame shape as Sprite Fusion's VFX** (`{ w, h, ox, oy, color, light }`), so both libraries can draw into
- one frame.
- ## license.
- MIT, code and effects. Use them in anything, commercial included. Parts are adapted from Hugo Duprez's MIT effects
- and from Hollow Crown's MIT source, and the Patch Pixel font in `gallery/fonts` is Patch's own and not covered: see
- [NOTICE.md](NOTICE.md).
- Made by [Patch](https://patch.gg).
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.