Skip to content

airobinnet/NexusSprite

Repository files navigation

NexusSprite Logo

NexusSprite

NexusSprite is a powerful, locally-hosted generative AI tool designed specifically for creating high-quality pixel art sprites. It uses a combination of advanced diffusion models and custom utilities to generate, outpaint, remove backgrounds, and clean up pixel art color palettes seamlessly.

Features

  • High-Quality Pixel Art Generation: Generates sprites with clear silhouettes and game-ready tile formatting.
  • Reference Image Support: Supports up to 8 reference images to guide the generation process.
  • Pixel Snapper Integration: Automatically cleans up and quantizes generated images to an exact pixel size and limited color palette.
  • Background Removal: Seamless background removal using Rembg.
  • Fully Local: Runs 100% locally on your machine with a sleek, unified frontend.

Before and After Examples

NexusSprite combines raw AI generation with precise pixel snapping to deliver clean, game-ready assets. The zoomed-in examples below demonstrate how the raw AI generates blurry, unaligned "half pixels" (left), while the Pixel Snapper quantizes the output into sharp blocks perfectly snapped to a genuine pixel grid (right).

Raw AI Output (Zoomed in - Blurry sub-pixels) Pixel Snapped (Zoomed in - Perfectly aligned 16-color pixels)

How to Run (For Non-Technical Users)

We have provided a fully automated startup script that handles all the technical setup for you.

  1. Prerequisites: Ensure you have Python 3.10+ and Node.js installed on your system.
  2. Double-click the start.bat file.
  3. The script will automatically:
    • Create an isolated environment for the application.
    • Install all necessary dependencies.
    • Build the user interface.
    • Start the server.
  4. Once the console says "Starting NexusSprite Backend & Frontend on port 8006...", open your web browser and navigate to: http://localhost:8006

Note: The first time you run this, it will take several minutes to download the AI models and install dependencies. Subsequent runs will be much faster.

How to Run via Docker (For Technical Users)

If you prefer to keep your host system clean, you can run NexusSprite using Docker. This requires an NVIDIA GPU and the NVIDIA Container Toolkit.

  1. Ensure you have Docker, Docker Compose, and the NVIDIA Container Toolkit installed.
  2. Run the following command in the project directory:
    docker compose up --build
  3. Open your browser and navigate to http://localhost:8006.

Credits & Acknowledgments

NexusSprite is built on the shoulders of giants. We would like to credit the following projects and their creators:

  • FLUX.2-klein-4B by Black Forest Labs for the base diffusion model.
  • Pixel Art LoRA by Limbicnation for the specialized pixel art fine-tuning.
  • Rembg by danielgatis for the AI background removal.
  • SpriteFusion Pixel Snapper for the rust-based pixel snapping and color quantization utility.
  • Built with FastAPI and React/Vite.

About

NexusSprite is a powerful, locally-hosted generative AI tool designed specifically for creating high-quality pixel art sprites

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors