GODOT 4 PLUGIN

Pixel art for Godot

A dockable editor plugin that brings spritesynth's AI generation directly into the Godot Editor. Generate, preview, and import pixel art without switching tools.

See it in action

SpriteSynth Godot Generate tab screenshot

generate tab

SpriteSynth Godot Manage tab screenshot

manage tab

SpriteSynth Godot Settings tab screenshot

settings tab

What's included

Dock Panel

3-tab dock panel that integrates into Godot's UI. Switch between Generate, History, and Settings with one click.

Async Polling

4-state HTTP state machine polls the API every 2 seconds with a 10-minute timeout. Handles 402, network errors, and JSON parse failures.

Settings Manager

API key stored in ProjectSettings with SPIRESYNTH_API_KEY env var fallback. Source indicator shows where the key is coming from.

Asset Import

Generated assets are downloaded and saved to the project with proper thumbnails in the history browser.

Generation History

Scrollable history with thumbnail previews. Re-import assets, delete individual entries, or clear all history.

Connection Test

Built-in connection test that validates your API key against the spritesynth API before you start generating.

Installation

Manual Install

  1. Download the latest release
  2. Copy the addons/spritesynth/ folder into your Godot project's addons/ directory
  3. Enable the plugin in Project > Project Settings > Plugins
  4. The dock appears on the left side of the Editor

Via GitHub

Clone the repository and copy the addons/spritesynth/ folder:

git clone https://github.com/magebase/spritesynth-godot.git
cp -r spritesynth-godot/addons/spritesynth your-project/addons/

API Endpoints

The plugin interacts with the spritesynth API using these endpoints:

POST /generations/image Generate pixel art
GET /generations/{uuid} Poll generation status
GET /generations/{uuid}/download Download generated asset

Requirements

Godot 4

Godot 4.x or later

API Key

Free or paid spritesynth account

Internet

Connection to api.spritesynth.com

Start generating in Godot

Install the plugin and create pixel art assets without leaving the Godot Editor.