How do I export Aseprite files for use with Peachy?

Export your Aseprite animation as a spritesheet with JSON data, ensuring frame tags are defined. Peachy requires the JSON file and image, as shown in the usage example. Even for single animations, frame tags must be set up to work correctly.

Peachy vs Anim8 for LÖVE animations?

Peachy is specialized for Aseprite integration, directly parsing its JSON exports, while Anim8 is a general-purpose animation library. Choose Peachy if you rely on Aseprite's workflow; otherwise, Anim8 offers more flexibility with custom sprite sheets.

How to fix image loading issues in Peachy when Aseprite exports non-relative paths?

Manually edit the JSON file to use relative paths, specify the image directly in peachy.new as the second argument, or use Aseprite's CLI for correct exports. The README links to a workaround from an Aseprite issue.

Can Peachy handle animated slices or hitboxes?

No, Peachy's slices are static and do not animate. This is a limitation of Aseprite's slice system, and Peachy cannot support animated slices until Aseprite adds new layer types, as noted in the limitations.

How to set a callback when an animation loops in Peachy?

Use the :onLoop method on your Peachy object, passing a function to be called. For instance, spinner:onLoop(function() print('Loop!') end) triggers the callback each time the animation completes a cycle, per the API reference.

Is Peachy suitable for UI animations in LÖVE?

Yes, Peachy can handle UI animations by drawing frames or slices at UI coordinates. However, since slices don't animate, for animated UI, you'd use frame tags and control playback via the API, similar to sprite animations.

Peachy — Aseprite Animation Parser for LÖVE

What is Peachy?

Peachy is a Lua library that parses and renders Aseprite animations within the LÖVE 2D game framework. It loads Aseprite's exported JSON data and corresponding spritesheets to manage and display animations directly in LÖVE projects. The tool solves the problem of manually handling animation frames and timing by providing a structured API for animation control.

Target Audience

Game developers using the LÖVE framework who create their sprite animations in Aseprite and need a streamlined way to import and control those animations in their games.

Value Proposition

Developers choose Peachy because it offers a direct, lightweight integration between Aseprite and LÖVE, eliminating the need for custom animation systems. Its support for Aseprite features like frame tags and slices provides a more efficient workflow compared to manual sprite sheet handling.

A parser/renderer for Aseprite animations in LÖVE. :peach:

Use Cases

Best For

Importing Aseprite animations into LÖVE games
Managing sprite animations with play, pause, and frame control
Using Aseprite slices for hitboxes or UI elements in LÖVE
Handling multiple animation states via Aseprite frame tags
Triggering game events when an animation loops
Streamlining the art-to-code pipeline for 2D game developers

Not Ideal For

Games not using Aseprite for sprite animation, as Peachy is specifically designed to parse Aseprite JSON exports.
Projects requiring animated slices or dynamic hitboxes, since Peachy's slices are static and do not support animation.
Developers using game engines or frameworks other than LÖVE, due to its tight integration with the LÖVE API.

Pros & Cons

Pros

Direct Aseprite Integration

Seamlessly loads and parses Aseprite JSON exports with frame tags and slices, simplifying the import workflow as demonstrated in the example code.

Comprehensive Animation Control

Provides functions like play, pause, stop, and tag switching, enabling easy management of animation states without manual timing calculations.

Slice Utility Support

Supports Aseprite slices as named regions with custom user data, useful for hitboxes or UI elements, as shown in the slices documentation.

Event-Driven Callbacks

Includes an onLoop callback system to trigger functions when animations loop, enhancing game interaction without extra boilerplate code.

Cons

Image Path Issues

Aseprite exports non-relative image paths by default, which LÖVE cannot load, requiring manual JSON edits or workarounds as admitted in the limitations.

Static Slices

Slices do not animate, limiting their use for dynamic elements like animated hitboxes, a restriction acknowledged in the README's limitations section.

Frame Tag Dependency

Requires frame tags to be set up in Aseprite even for single animations, adding an extra step that can be error-prone for simple projects.

Frequently Asked Questions

What is Peachy?

Target Audience

Game developers using the LÖVE framework who create their sprite animations in Aseprite and need a streamlined way to import and control those animations in their games.

Value Proposition

Use Cases

Best For

Importing Aseprite animations into LÖVE games
Managing sprite animations with play, pause, and frame control
Using Aseprite slices for hitboxes or UI elements in LÖVE
Handling multiple animation states via Aseprite frame tags
Triggering game events when an animation loops
Streamlining the art-to-code pipeline for 2D game developers

Not Ideal For

Games not using Aseprite for sprite animation, as Peachy is specifically designed to parse Aseprite JSON exports.
Projects requiring animated slices or dynamic hitboxes, since Peachy's slices are static and do not support animation.
Developers using game engines or frameworks other than LÖVE, due to its tight integration with the LÖVE API.

Pros & Cons

Pros

Direct Aseprite Integration

Seamlessly loads and parses Aseprite JSON exports with frame tags and slices, simplifying the import workflow as demonstrated in the example code.

Comprehensive Animation Control

Provides functions like play, pause, stop, and tag switching, enabling easy management of animation states without manual timing calculations.

Slice Utility Support

Supports Aseprite slices as named regions with custom user data, useful for hitboxes or UI elements, as shown in the slices documentation.

Event-Driven Callbacks

Includes an onLoop callback system to trigger functions when animations loop, enhancing game interaction without extra boilerplate code.

Cons

Image Path Issues

Aseprite exports non-relative image paths by default, which LÖVE cannot load, requiring manual JSON edits or workarounds as admitted in the limitations.

Static Slices

Slices do not animate, limiting their use for dynamic elements like animated hitboxes, a restriction acknowledged in the README's limitations section.

Frame Tag Dependency

Requires frame tags to be set up in Aseprite even for single animations, adding an extra step that can be error-prone for simple projects.

Frequently Asked Questions

Peachy

What is Peachy?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

Peachy

What is Peachy?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?