Skip to content
Back to search

pixel-plugin

Claude Code plugin for creating pixel art with Aseprite through natural language. Supports animation, retro palettes, dithering, and game engine export.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/willibrandon--pixel-plugin/badge.svg)](/listings/willibrandon--pixel-plugin)

HTML

<a href="/listings/willibrandon--pixel-plugin"><img src="/api/listings/willibrandon--pixel-plugin/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

1. Prerequisites

- [Aseprite](https://www.aseprite.org/) v1.3.0+ installed - [Claude Code](https://claude.com/code) installed

2. Installation

**Option A: Via Claude Code (recommended)**

In Claude Code, run:

/plugin

Then: 1. Select "Add marketplace" 2. Enter: `willibrandon/pixel-plugin` (for GitHub) or `./path/to/local/marketplace` (for local) 3. Select "Browse and install plugins" 4. Find and install `pixel-plugin`

**Option B: From command line**

# Add the GitHub marketplace
claude plugin marketplace add willibrandon/pixel-plugin

# Install the plugin
claude plugin install pixel-plugin

**Option C: Local development/testing**

# Clone the repository
git clone https://github.com/willibrandon/pixel-plugin.git
cd pixel-plugin

# Add as local marketplace (from parent directory)
cd ..
claude plugin marketplace add ./pixel-plugin

# Install from local source
claude plugin install pixel-plugin@pixel-plugin

3. Setup

Configure Aseprite path (one-time setup):

/pixel-setup

The command will auto-detect your Aseprite installation. If not found, specify the path manually:

/pixel-setup /Applications/Aseprite.app/Contents/MacOS/aseprite

4. Create Your First Sprite

# Using slash commands
/pixel-new 64x64 gameboy
"Draw a character sprite"
/pixel-export png character.png

# Or natural language only
"Create a 32x32 Game Boy sprite of a character"
"Export it as character.png"

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 · 14 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. {
  2. "name": "pixel-plugin",
  3. "owner": {
  4. "name": "Brandon Williams",
  5. "url": "https://github.com/willibrandon"
  6. },
  7. "plugins": [
  8. {
  9. "name": "pixel-plugin",
  10. "source": "./",
  11. "description": "Create, animate, and export pixel art using Aseprite through natural language and commands"
  12. }
  13. ]
  14. }
README.md · README · 309 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # Aseprite Pixel Art Plugin for Claude Code
  2. Create, animate, and export pixel art using Aseprite through natural language and commands in Claude Code.
  3. *Powered by [pixel-mcp](https://github.com/willibrandon/pixel-mcp) - a Model Context Protocol server for Aseprite.*
  4. ## Features
  5. **Natural Language Pixel Art Creation**
  6. - "Create a 64x64 Game Boy style sprite"
  7. - "Draw a red circle with blue outline"
  8. - "Make a 16x16 tile"
  9. **Animation Support**
  10. - "Add a 4-frame walk cycle"
  11. - "Create an idle animation"
  12. - "Set frame timing to 100ms"
  13. **Advanced Techniques**
  14. - Apply dithering patterns
  15. - Optimize color palettes
  16. - Add shading and antialiasing
  17. - Use retro console palettes (NES, Game Boy, C64, PICO-8)
  18. **Game-Ready Export**
  19. - PNG, GIF, spritesheet formats
  20. - JSON metadata for Unity, Godot, Phaser
  21. - Pixel-perfect scaling (2x, 4x, 8x)
  22. - Multiple spritesheet layouts
  23. ## How It Works
  24. This plugin uses the [pixel-mcp](https://github.com/willibrandon/pixel-mcp) Model Context Protocol server to communicate with Aseprite. The MCP server provides 40+ tools for pixel art operations and is bundled with the plugin.
  25. ## Quick Start
  26. ### 1. Prerequisites
  27. - [Aseprite](https://www.aseprite.org/) v1.3.0+ installed
  28. - [Claude Code](https://claude.com/code) installed
  29. ### 2. Installation
  30. **Option A: Via Claude Code (recommended)**
  31. In Claude Code, run:
  32. ```
  33. /plugin
  34. ```
  35. Then:
  36. 1. Select "Add marketplace"
  37. 2. Enter: `willibrandon/pixel-plugin` (for GitHub) or `./path/to/local/marketplace` (for local)
  38. 3. Select "Browse and install plugins"
  39. 4. Find and install `pixel-plugin`
  40. **Option B: From command line**
  41. ```bash
  42. # Add the GitHub marketplace
  43. claude plugin marketplace add willibrandon/pixel-plugin
  44. # Install the plugin
  45. claude plugin install pixel-plugin
  46. ```
  47. **Option C: Local development/testing**
  48. ```bash
  49. # Clone the repository
  50. git clone https://github.com/willibrandon/pixel-plugin.git
  51. cd pixel-plugin
  52. # Add as local marketplace (from parent directory)
  53. cd ..
  54. claude plugin marketplace add ./pixel-plugin
  55. # Install from local source
  56. claude plugin install pixel-plugin@pixel-plugin
  57. ```
  58. ### 3. Setup
  59. Configure Aseprite path (one-time setup):
  60. ```bash
  61. /pixel-setup
  62. ```
  63. The command will auto-detect your Aseprite installation. If not found, specify the path manually:
  64. ```bash
  65. /pixel-setup /Applications/Aseprite.app/Contents/MacOS/aseprite
  66. ```
  67. ### 4. Create Your First Sprite
  68. ```bash
  69. # Using slash commands
  70. /pixel-new 64x64 gameboy
  71. "Draw a character sprite"
  72. /pixel-export png character.png
  73. # Or natural language only
  74. "Create a 32x32 Game Boy sprite of a character"
  75. "Export it as character.png"
  76. ```
  77. ## Usage
  78. ### Slash Commands
  79. | Command | Description | Example |
  80. |---------|-------------|---------|
  81. | `/pixel-new [size] [palette]` | Create new sprite | `/pixel-new icon nes` |
  82. | `/pixel-palette <action> [args]` | Manage palettes | `/pixel-palette set gameboy` |
  83. | `/pixel-export <format> [file]` | Export sprite | `/pixel-export gif anim.gif` |
  84. | `/pixel-setup [path]` | Configure plugin | `/pixel-setup` |
  85. | `/pixel-help [topic]` | Get help | `/pixel-help palettes` |
  86. ### Natural Language
  87. The plugin responds to natural language requests:
  88. **Creation:**
  89. ```
  90. "Create a 64x64 RGB sprite"
  91. "Make a 16x16 tile with NES palette"
  92. "Start a new 128x128 canvas"
  93. ```
  94. **Drawing:**
  95. ```
  96. "Draw a red circle in the center"
  97. "Fill the background with blue"
  98. "Draw a pixelated tree"
  99. ```
  100. **Animation:**
  101. ```
  102. "Add 4 frames for a walk cycle"
  103. "Create a 2-frame idle animation"
  104. "Set all frame durations to 100ms"
  105. ```
  106. **Advanced:**
  107. ```
  108. "Apply Floyd-Steinberg dithering"
  109. "Reduce to 16 colors"
  110. "Add shading with light from top-left"
  111. "Convert to PICO-8 palette"
  112. ```
  113. **Export:**
  114. ```
  115. "Export as PNG at 4x scale"
  116. "Export as animated GIF at 12 FPS"
  117. "Create a horizontal spritesheet"
  118. "Export with Unity JSON metadata"
  119. ```
  120. ## Examples
  121. ### Example 1: Game Boy Character
  122. ```bash
  123. /pixel-new 48x48 gameboy
  124. "Draw a character sprite - round head, square body, stick limbs"
  125. "Add a 2-frame breathing animation"
  126. /pixel-export gif character-idle.gif fps=2
  127. ```
  128. **Result:** Game Boy character with subtle idle animation.
  129. ### Example 2: NES Tile
  130. ```bash
  131. /pixel-new tile nes
  132. "Draw a brick wall pattern"
  133. "Apply Bayer dithering for texture"
  134. /pixel-export png brick-tile.png scale=4
  135. ```
  136. **Result:** Retro NES-style brick tile, scaled 4x for modern displays.
  137. ### Example 3: Modern Pixel Art
  138. ```bash
  139. /pixel-new 64x64
  140. "Draw a detailed sword with silver blade and gold hilt"
  141. "Add shading from top-left light source"
  142. "Apply soft antialiasing to edges"
  143. /pixel-export png sword.png scale=2
  144. ```
  145. **Result:** Modern pixel art with shading and antialiasing.
  146. ### Example 4: Animated Sprite for Game
  147. ```bash
  148. /pixel-new 32x32 pico8
  149. "Draw a simple character"
  150. "Create an 8-frame run cycle"
  151. "Set frames to 80ms each"
  152. /pixel-export json game-character.json format=unity
  153. ```
  154. **Result:** `game-character.png` spritesheet + `game-character.json` ready for Unity import.
  155. ## Palette Presets
  156. ### Retro Consoles
  157. - `nes` - 54-color NES palette
  158. - `gameboy` - 4-color Game Boy green
  159. - `gameboy-gray` - 4-shade grayscale
  160. - `c64` - 16-color Commodore 64
  161. - `cga` - 4-color IBM CGA
  162. - `snes` - 256-color Super Nintendo
  163. ### Modern Palettes
  164. - `pico8` - PICO-8 fantasy console (16 colors)
  165. - `sweetie16` - Popular 16-color palette by GrafxKid
  166. - `db16` - DawnBringer's 16 colors
  167. - `db32` - DawnBringer's 32 colors
  168. ### Generic
  169. - `retro16` - Generic 16-color retro
  170. - `retro8` - Generic 8-color retro
  171. - `grayscale4/8/16` - Grayscale palettes
  172. ## Export Formats
  173. ### Formats
  174. - **PNG** - Single frame or current frame with transparency
  175. - **GIF** - Animated GIF with loop and timing control
  176. - **Spritesheet** - Multiple layouts (horizontal, vertical, grid, packed)
  177. - **JSON** - Metadata for game engines (Aseprite, TexturePacker, Unity, Godot)
  178. ### Spritesheet Layouts
  179. - `horizontal` - All frames in a row (web animations)
  180. - `vertical` - All frames in a column
  181. - `grid` - Optimal rows × columns (game engines)
  182. - `packed` - Space-optimized (texture atlases)
  183. ### Scaling
  184. - `scale=1` - Original size
  185. - `scale=2` - 2x pixel-perfect
  186. - `scale=4` - 4x pixel-perfect
  187. - `scale=8` - 8x pixel-perfect
  188. ## Documentation
  189. - [Skills Reference](skills/) - Detailed Skill documentation
  190. - [Commands Reference](commands/) - Slash command documentation
  191. ## Troubleshooting
  192. ### "Aseprite not found" Error
  193. Run setup command:
  194. ```bash
  195. /pixel-setup /path/to/aseprite
  196. ```
  197. Platform-specific paths:
  198. - **macOS**: `/Applications/Aseprite.app/Contents/MacOS/aseprite`
  199. - **Linux**: `/usr/bin/aseprite`
  200. - **Windows**: `C:\Program Files\Aseprite\Aseprite.exe`
  201. ### "MCP server not responding"
  202. 1. Verify Aseprite is installed and accessible
  203. 2. Check configuration: `cat ~/.config/pixel-mcp/config.json`
  204. 3. Re-run setup: `/pixel-setup`
  205. 4. Check binary permissions: `chmod +x bin/pixel-mcp`
  206. ### "Export failed" or "File not found"
  207. - Ensure sprite is created before exporting
  208. - Check output path is writable
  209. - Verify format is supported (png, gif, sheet, json)
  210. See [Known Issues](docs/KNOWN_ISSUES.md) for additional troubleshooting information.
  211. ## Platform Support
  212. - macOS (Intel and Apple Silicon)
  213. - Linux (x86_64 and ARM64)
  214. - Windows (x86_64)
  215. ## Requirements
  216. - **Aseprite**: v1.3.0 or higher
  217. - **Claude Code**: v1.0.0 or higher
  218. - **pixel-mcp**: MCP server (bundled) - [Source](https://github.com/willibrandon/pixel-mcp)
  219. - **Disk Space**: ~50MB for plugin and binaries
  220. ## Contributing
  221. Contributions welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
  222. 1. Fork the repository
  223. 2. Create feature branch (`git checkout -b feature/amazing-feature`)
  224. 3. Commit changes (`git commit -m 'Add amazing feature'`)
  225. 4. Push to branch (`git push origin feature/amazing-feature`)
  226. 5. Open Pull Request
  227. ## License
  228. This project is licensed under the MIT License - see [LICENSE](LICENSE) file for details.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.