Skip to content

SpriteLab is a modern tool with a retro soul for game developers. It lets you slice spritesheets, auto-detect animation rows, preview loops, and organize assets in a persistent sandbox. Built with React, Vite, and TypeScript.

License

Notifications You must be signed in to change notification settings

Moussandou/SpriteLab

Repository files navigation

SpriteLab πŸ‘Ύ

A retro-styled web tool for slicing spritesheets, managing assets, and creating pixel-art animations.

SpriteLab Editor

πŸ“Έ Screenshots

Welcome Screen Asset Grid
Welcome Screen Asset Management
Settings Sandbox
System Settings Sandbox Mode

πŸ“– About

SpriteLab is a specialized tool designed for game developers and pixel artists. It streamlines the workflow of importing raw spritesheets, slicing them into usable frames, and testing animations in real-time.

Built with a Retro-Futurist UI (inspired by 90s software), it looks like a legacy tool but runs with modern web performance. It features a persistent Sandbox where you can organize assets and build scenes, all saved automatically to your browser's local storage.

✨ Features

  • 🎨 Asset Pipeline:

    • Drag-and-drop import for images/spritesheets.
    • Smart Slicer: Automatically detects rows and frames in your sprite sheets.
    • Asset Editor: Dedicated workspace to slice, preview, and configure assets.
  • 🎞️ Animation Engine:

    • Instant preview of your sprites.
    • Row-Based Looping: Select specific animation rows (e.g., "Walk Down", "Attack").
    • Adjustable frame rates (FPS).
  • πŸ•ΉοΈ Sandbox Mode:

    • A persistent "Scene" editor to test assets together.
    • Keyboard Shortcuts: Nudge, delete, and duplicate items quickly.
    • Drag & Drop placement.
  • πŸ’Ύ Persistence:

    • All settings (Grid size, CRT effects) and Sandbox layout are saved automatically via localStorage.
    • Export your processed assets as ZIP (JSON + PNGs).
  • πŸ“Ό Retro UX:

    • Custom "Pixel Art" design system.
    • CRT Scanline overlay (togg-able).
    • Keyboard-friendly navigation.

πŸ› οΈ Tech Stack

  • Framework: React 18
  • Build Tool: Vite
  • Language: TypeScript
  • Styling: Vanilla CSS Variables (No UI libraries, 100% custom Design System)
  • Icons: Lucide React
  • State: React Context API

πŸš€ Getting Started

  1. Clone the repository

    git clone https://github.com/Moussandou/SpriteLab.git
    cd SpriteLab
  2. Install dependencies

    npm install
  3. Start the development server

    npm run dev
  4. Build for production

    npm run build

πŸ“¦ Deployment (GitHub Pages)

This project is configured to deploy automatically to GitHub Pages using GitHub Actions.

  1. Go to Settings > Pages.
  2. Select Source: GitHub Actions.
  3. Push changes to the main branch.
  4. The site will be live at: https://Moussandou.github.io/SpriteLab/

Built with ❀️ by Moussandou

About

SpriteLab is a modern tool with a retro soul for game developers. It lets you slice spritesheets, auto-detect animation rows, preview loops, and organize assets in a persistent sandbox. Built with React, Vite, and TypeScript.

Resources

License

Stars

Watchers

Forks

Contributors

Languages