Ren'Py Frame-Based Animation Generation

Generate animations from frame-sets with ease!

This tool is a helper function that makes it easy to generate animations of any length from a folder full of frames.

image taco = generate_animation("images/taco")

Why?

If you have ever constructed animated images by doing the following, you quickly realize how tedious it can be.

image tacos:
    "images/tacos/frame1"
    pause 0.2
    "images/tacos/frame2"
    pause 0.2
    "images/tacos/frame3"
    pause 0.2
    "images/tacos/frame4"
    pause 0.2
    "images/tacos/frame5"
    pause 0.2
    "images/tacos/frame6"
    pause 0.2
    repeat

While this approach is fine if you have few frames, or few animations, if you have to construct an animation with many frames, of a lot of animations, this quickly becomes a pain.

Instead, for situations where the pause duration between frames remains constant, we can replace the above tedium with a simple function call.

image taco = generate_animation("images/taco", pause=0.2, looping=True)

What about ...?

Animations with variable framerates?

If your animation hangs on some frames for longer or shorter than others, this is not the solution for you. This will set the pause duration on all frames to the value given (or the default of 30fps).

Usage

1. Download the latest release
2. Unzip it into your project directory (the directory above game)
3. Create a new directory inside your game directory to hold your animation frames
4. Ensure your frame images are named in such a way that they will be ordered correctly
5. Create your generated animation!

For additional usage information, see the ReadMe on GitHub

Credits

• Explosion frames from pngegg.com

License

This source code and project are released under the MIT license, which to paraphrase in a way that is not legally binding:

• You can use it for free things
• You can use it for paid things
• You can modify it however you see fit
• You can redistribute it as you see fit
• Go nuts!

For a better breakdown of what the license actually means, see: choosealicense.com

I do ask that you credit me in some way, but if you don't I'm not gonna call the open-source police on you. If you do choose to credit me you can do so by providing a link to my GitHub, my Itch.io, or just call me Foxcapades.