AutoKeyframe_SpriteFrames_GodotPlugin

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

AutoKeyframe_SpriteFrames_GodotPlugin

★ 17 Open GitHub ↗

A plugin for the Godot game engine that streamlines the keyframing process of SpriteFrames resources on AnimatedSprites. Made with Godot 4.5.beta3.

다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## <img width="48" height="48" alt="AutoKey_AnimatedSpriteFrames" src="addons/AutoKey_SpriteFrames/icon.svg" /> Auto-Keyframe `AnimatedSprite2D`'s `SpriteFrames`

[![License: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg)](http://creativecommons.org/publicdomain/zero/1.0/)
<a href="https://godotengine.org/">
<img src="https://img.shields.io/badge/4.4-white?style=flat-square&logo=godotengine&logoColor=white&label=Godot&labelColor=%232f5069&color=%233e4c57" alt="Godot 4.4" height="20"></a>

#### A QOL Plugin for 2D frame-based Animation in Godot

This Godot editor plugin is designed to streamline the process of animating an `AnimatedSprite2D` node with an `AnimationPlayer`. It reduces the tedious manual work of keyframing each frame of a sprite animation down to a single button-press.

Made in `Godot 4.5 beta3`. Other Godot versions untested. Almost certain to work in 4.4, oldest I'd say is probably 4.2. If it breaks on an older version, submit an issue.

## How to Use

### Installation

1. Place the `AutoKey_SpriteFrames` folder inside your project's `addons` directory.
2. Enable the plugin in `Project > Project Settings > Plugins`.

The final file structure should look like this:
```
res://addons/AutoKey_SpriteFrames/
├── AutoKey_SpriteFrames.gd
├── inspector_plugin.gd
├── plugin.cfg
├── license.md
└── README.md
```

### Usage

1.  Select an `AnimatedSprite2D` node in the scene tree. 
	- In the Inspector, you will see a new button at the top: **"Auto-Key SpriteFrames Animation"**.
2.  Ensure it has a sibling `AnimationPlayer` node.
3.  Assign a `SpriteFrames` resource to your `AnimatedSprite2D`.
4.  Select the animation you want to auto-key in the `Animation` property below `Sprite Frames`.
5.  Click the button.

## What It Does

When the button is clicked, the plugin will:

1.   Find the sibling `AnimationPlayer`.
2.   Get the current animation name from the `AnimatedSprite2D` (e.g., "walk").
3.   Create a new `Animation` resource in the `AnimationPlayer` with that name, or find an existing one.
4.   **Automatically generate two tracks:**
		i.   `AnimatedSprite2D:animation`: Sets the current animation name at time `0.0`.
		ii.   `AnimatedSprite2D:frame`: Creates a keyframe for every single frame of the animation in the `SpriteFrames` resource. The timing of these keyframes is based on the FPS (step) set in the `AnimationPlayer`'s animation timeline.
		*   **WARNING**: This will clear all existing frames of the above-mentioned tracks.
5.   Set the total length of the animation (in frames) to match the sprite animation's duration.

This allows you to instantly create a perfectly timed `AnimationPlayer` animation from your `SpriteFrames` with a single click.

## Why

I was getting really fed up with the tedium of finding the AnimatedSprite2D, clicking on the Animation tab, creating new animation, key "animation", click yes to the dialog, and then key every single frame (however long it is) by carpal-tunneling myself to tears going back and forth between clicking the little up-arrow on the frame, and the key next to it, over and over and over.

This does all of those things in ONE button press.

All you need to do is go to the AnimatedSprite2D, assign a SpriteFrames, select an animation, and click the button once for each animation. EZ-PZ.

### License

By Kaiiboraka. Licensed under CC0. See `license.md`. I don't care what you do with it, go nuts. Credit me if you like.

AutoKeyframe_SpriteFrames_GodotPlugin

다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

AutoKeyframe_SpriteFrames_GodotPlugin

다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README