Skip to content

Latest commit

 

History

History
127 lines (89 loc) · 3.63 KB

README.md

File metadata and controls

127 lines (89 loc) · 3.63 KB

Piksy

🚧 Work in Progress
Piksy is an evolving C++ application for effortless sprite sheet editing, frame extraction, and animation handling. It's currently replacing this project but remains under heavy development!

Screen.Recording.2025-01-21.at.23.03.58.mov

🚀 Key Features

  • Sprite Sheet Organization
    Load and preview your sprite sheets, neatly organize files, and quickly navigate through folders.

  • Frame Extraction
    Automatically detect frames with computer vision (or create them manually for full control).

  • Animation Editing
    Combine frames into animations, reorder them on-the-fly, and preview motion instantly.

  • Color Swapping
    Tap into a handy color tool to replace any target hue with a new color, saving manual editing time.

  • Export & Save
    Save all animations as JSON and export textures as PNG. Perfect for engine-ready assets!

Tip
Piksy is great for game devs, hobbyists, and artists needing a streamlined workflow to handle sprite sheets.

🎉 Screenshots & Videos (so far, subject to changes)

image

image

🔧 Getting Started

  1. Clone

    git clone https://github.com/adia-dev/piksy.git
cd piksy

  2. Build (example using CMake):

    make
# or
make -j4

  3. Run

    make run
# or
build/Debug/bin/piksy

Info
You’ll need to have SDL2, SDL2_image, SDL2_ttf, and OpenCV installed for a successful build (if building from source). Pre-built binaries may come later.

🔨 Usage Overview

  1. Load or Drop a Sprite Sheet
    • Use the "File" menu or simply drag-and-drop your sprite sheet into Piksy.
  2. Extract Frames
    • Choose the "Extract" tool, draw a selection, and Piksy detects frames in that region.
  3. Create & Preview Animations
    • Group these frames into sequences. Adjust timing and naming on-the-fly.
  4. Export
    • Save the entire texture or export your animation data to JSON with a quick menu option.

Warning
Some tools and features are incomplete—please report any quirks or bugs you encounter.

📂 Project Structure (Brief)

piksy/
├─ include/
│   ├─ core/         # App setup & configuration
│   ├─ command/      # Actions (Export, Save, etc.)
│   ├─ components/   # UI panels (e.g., Console, Viewport)
│   ├─ rendering/    # Rendering logic (SDL, textures)
│   ...
├─ src/
│   ├─ core/
│   ├─ command/
│   ├─ components/
│   ├─ rendering/
│   ...
└─ CMakeLists.txt

🌱 Current Status & Roadmap

  • Basic workflow (load → extract → animate → export) is functional.
  • UI/UX is still evolving; certain settings may not persist.
  • More polishing around frame detection and color swapping is planned.

🙌 Contributing

We welcome pull requests and issue reports! To contribute:

  1. Fork the repo.
  2. Create a branch for your feature/bug fix.
  3. Submit a PR for review.

Info
We value all feedback—whether it’s UI suggestions, performance tweaks, or big new features.

Thank you for checking out Piksy! We hope to make your sprite editing journey easier and faster. Stay tuned for updates!