A plugin for the Godot Engine that imports animations from Aseprite

Forked from Aseprite Importer and updated for Godot v4

What does it actually do?

This plugin creates / modifies animations in an AnimationPlayer node that change the offset and region_rect properties of a Sprite2D/Sprite3D node based on the animation tags of a Sprite Sheet JSON data file generated by Aseprite.

Download and Installation

Downloading from the Godot Asset Library

1. In the Godot editor, open the AssetLib tab
2. Search for Aseprite Importer
3. Click on the asset name and click the Download button in the preview window
4. After the download is finished, click Instal... and then Install in the popup
5. Go to Projects -> Project Settings... and enable the plugin in the Plugins tab

Downloading from the GitHub repository

1. Download or clone this repository and copy the /addons/aseprite_importer folder into your project/addons folder
2. In the Godot Editor, go to Projects -> Project Settings... and enable the plugin in the Plugins tab

Usage

Exporting from Aseprite

1. In Aseprite, go to File -> Export Sprite Sheet
2. Configure how you want the Sprite Sheet image to be exported
3. In the Output section:
   • Enable the option Output File and select the directory where you want the texture file to be saved;
   • Enable the option JSON Data and select the directory where you want the JSON data file to be saved (preferably in the same directory of the image)
   • Enable the option Meta -> Tags

Importing to Godot

1. Open the scene where you want to import the animations
2. Open the plugin from the Aseprite Importer button in the top nav (next to the "2D", "3D", "Script", and "AssetLib" buttons)
3. Select the JSON Data file
4. Select the texture file if it has not been automatically loaded
5. Select which tags you want to be imported
6. Select the AnimationPlayer node where you want the animations to be added/modified
7. Select The Sprite2D/Sprite3D node you want to be affected by the animations
8. Press Generate Animations

Compatability

• Tested with Godot v4.0 alpha 14

Limitations

• For now the plugin doesn't keep track of the selected files in the disk to automatically re-import the changes;
• It also is not integrated with the Godot's UndoRedo system.

License

MIT License