Sprite Animation Generator

Sprite Animation Generator is a Godot editor plugin that slices character spritesheets into animation frames and exports them as a SpriteFrames resource.

The plugin is primarily designed for spritesheets generated by tools such as the Universal LPC SpriteSheet Character Generator, but it also works with any evenly spaced spritesheet that follows a regular grid.

Features

• Slice a single spritesheet into animation frames by row and column.
• Detect the number of visible frames in each row automatically.
• Assign a custom animation name to each row.
• Preview generated animations as AnimatedSprite2D instances.
• Browse previews in a scrollable grid layout.
• Export all valid animations into one SpriteFrames resource.

Requirements

• Godot 4.x

Installation

1. Place the repository inside your Godot project.
2. Open the project and go to Project -> Project Settings -> Plugins.
3. Enable the Sprite Animation Generator plugin.
4. The plugin panel will appear in the dock on the right side of the editor.

Usage

1. Select a spritesheet

Click Select Sprite2D Resource... in the panel and choose a character spritesheet.

2. Configure slicing

• HFrames: Number of frames in each row.
• VFrames: Total number of rows.
• FPS: Playback speed for generated animations.

The plugin uses HFrames and VFrames to calculate the size of each cell, then scans every row to detect how many cells contain visible image data.

3. Name the animations

Enter an animation name for each row in the text field on the left. The default names are Anim0, Anim1, Anim2, and so on.

Before exporting, at least one animation must be named default. Otherwise, the plugin will show a warning and stop the export flow.

4. Preview animations

• Click Generate on a single row to preview only that animation.
• Click Generate All to preview all animations.

The preview area arranges generated animations in a grid and shows each animation name below its preview.

5. Export SpriteFrames

Click Export Resource File, then:

1. Choose the save location.
2. Enter a file name.
3. Save the generated SpriteFrames resource.
4. Use either the .tres or .res format.

The exported SpriteFrames resource only contains animation frame data. Preview nodes and editor-only layout information are not included.

Export rules

• Each row becomes one animation.
• The animation name comes from the row's LineEdit field.
• The frame count comes from the number of visible cells detected in that row.
• Empty rows are not exported.
• All exported animations use the current FPS setting.

Project structure

addons/sprite_anim_generator/

• editor.gd: Main editor logic.
• editor.tscn: Editor panel scene.
• sprite_anim_generator.gd: EditorPlugin entry point.
• plugin.cfg: Plugin metadata.

Notes

• The plugin exports a SpriteFrames resource only. It does not create an AnimatedSprite2D node or a scene automatically.
• Preview layout, borders, and labels are used for editor display only and are not written to the exported resource.
• If you change HFrames or VFrames, the preview is rebuilt.

License

This project is distributed under the MIT License. See LICENSE.md for details.