Sprites and TextureRect

When working with Sprite2D, Sprite3D and TextureRect nodes, you have the option to import the file as a static image or load its animations to an AnimationPlayer node.

  1. Create your node (Sprite2D, Sprite3D, TextureRect).
  2. With the node selected, look for the "Aseprite" section on the bottom part of the Inspector dock.
  3. Fill up the fields and click import.

Animation mode options

Field Description
Aseprite File (*.aseprite or *.ase) source file.
Animation Player AnimationPlayer node where animations should be added to.
Layers
Layer Aseprite layer(s) to be used in the animation. By default, all layers are included.
Exclude pattern Do not export layers that match the pattern defined. i.e _draft$ excludes all layers ending with _draft. Uses Godot's Regex implementation
Only visible layers If selected, it only includes in the image file the layers visible in Aseprite. If not selected, all layers are exported, regardless of visibility.
Slices
Slice Aseprite Slice to be used in the animation. By default, the whole file is used.
Animation
Keep manual animation length When this is active the animation length won't be adjusted if other properties were added and the resulting imported animation is shorter. Default: false.
Hide when unused If active, this node will be set as hidden in every existing animation it is not part of. Default: false.
Output
Embed Texture: Embed sprite sheet texture in the scene, instead of generating an external file. Default: enabled
Output folder: (When Embed Texture is off) Folder to save the sprite sheet (png) file. Default: same as scene
Output file name (When Embed Texture is off) Output file name for the sprite sheet. In case the Layer option is used with a single layer, this is used as the file prefix (e.g prefix_layer_name.res). If not set, the source file basename is used.

Notes:

Image mode options

Field Description
Aseprite File (*.aseprite or *.ase) source file.
Layers
Layer Aseprite layer to be used in the animation. By default, all layers are included.
Exclude pattern Do not export layers that match the pattern defined. i.e _draft$ excludes all layers ending with _draft. Uses Godot's Regex implementation
Only visible layers If selected, it only includes in the image file the layers visible in Aseprite. If not selected, all layers are exported, regardless of visibility.
Slices
Slice Aseprite Slice to be used in the animation. By default, the whole file is used.
Output
Output folder Folder to save the sprite sheet (png) file. Default: same as scene
Output file name Output file name for the sprite sheet. In case the Layer option is used with a single layer, this is used as file prefix (e.g prefix_layer_name.res). If not set, the source file basename is used.