Skip to content

README.md

Latest commit

 

History

History
97 lines (69 loc) · 2.82 KB

README.md

File metadata and controls

97 lines (69 loc) · 2.82 KB

Sprite Pipeline - Godot Plugin

Version Godot License

AI-powered sprite generation directly in the Godot Editor using OpenAI's image generation models.

📦 Installation

From Godot Asset Library

  1. Open Godot → AssetLib tab
  2. Search for "Sprite Pipeline"
  3. Download → Install
  4. Enable in Project Settings → Plugins

From GitHub Releases

  1. Download the latest sprite-pipeline-v*.zip from Releases
  2. Extract to your project's addons/ folder
  3. Enable in Project Settings → Plugins

From itch.io

Purchase and download from itch.io

📖 Documentation

Full documentation is available in the plugin's README: addons/sprite_pipeline/README.md

Quick Links

🚀 Features

  • Two Operation Modes: BYOK (your OpenAI key) or Pool (shared credits)
  • Smart Caching: Prevents duplicate generations
  • Batch Processing: Generate multiple sprites from JSON
  • Multiple Styles: Pixel Art, Cartoon, Flat Vector, Retro 8-bit, Watercolor, Realistic
  • Auto Import: Sprites automatically appear in your project

🛠️ Development

Building from Source

# Development build
./scripts/build.sh dev 1.0.0-alpha
# or
.\scripts\build.ps1 -Mode dev -Version 1.0.0-alpha

# Production build
./scripts/build.sh prod 1.0.0
# or
.\scripts\build.ps1 -Mode prod -Version 1.0.0

Validation

# Standard validation
.\scripts\validate.ps1

# Strict validation (for production)
.\scripts\validate.ps1 -Strict

GitHub Actions

This repository includes automated workflows:

  • Validate: Runs on every push/PR
  • Build Dev: Creates pre-releases from develop branch
  • Build Prod: Creates releases from version tags (e.g., v1.0.0)

📄 License

MIT License - see LICENSE

🤝 Contributing

Contributions welcome! Please:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

💬 Support

Made with ❤️ by fabs133