StickerClone/addons/modular_sprite_animation_factory/README.md

ModularSpriteAnimationFactory

A Godot 4 plugin to generate animations for modular 2d sprites. Generated animations will have multiple tracks, one for each Sprite2D node.

Installation

1. Download the plugin from github and place the addons directory to your Godot project root folder. Alternatively, you can install it from the AssetLib in the Godot editor.
2. In the Godot editor, go to Project > Project Settings > Plugins and enable Modular Sprite Animation Factory.

Usage

1. Prepare your sprites. Split it to different parts and convert them to white (or greyscale). Example below:

   Original: Head: Body: Eyes: Outline:

2. Setup your nodes, it has to be a Node2D, contains an AnimationPlayer and at least a Sprite2D among its children. It's recommended to name the Sprite2Ds accordingly. Example below:

   • Node2D
     • AnimationPlayer
     • Sprite2D
     • Sprite2D
     • ... more Sprite2Ds

   

3. Set the textures of the Sprite2Ds with your sprites. And set the Hframes and Vframes (under the Sprite2D > Animation section), in the example it's a 4x4 spritesheet.

   

4. You can now customize your character by setting different colors to each part of the sprite. To do so, in the CanvasItem > Visibility section, change the modulate color. You can also change that via a script. Alternatively, you can also customize your character by changing the texture. For example, you can have a Sprite2D node named Hat, and you can change the character's hat to different styles, instead of just changing the hat color.

   

5. When you select the root Node2D, a tab will apear on the right panel, named MSAF. You can then manage and generate animations using it.

   

6. The result of the generated animation: