https://github.com/Insality/panthera
Panthera Animation Runtime for Defold Game Engine
https://github.com/Insality/panthera
animation defold defold-extension defold-library defold-module editor runtime software
Last synced: 3 months ago
JSON representation
Panthera Animation Runtime for Defold Game Engine
- Host: GitHub
- URL: https://github.com/Insality/panthera
- Owner: Insality
- License: mit
- Created: 2024-04-27T09:09:34.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-08-23T14:38:33.000Z (5 months ago)
- Last Synced: 2025-08-24T05:15:47.594Z (5 months ago)
- Topics: animation, defold, defold-extension, defold-library, defold-module, editor, runtime, software
- Language: Lua
- Homepage: https://insality.github.io/panthera
- Size: 22.1 MB
- Stars: 81
- Watchers: 1
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-defold - Panthera
README
[](https://github.com/sponsors/insality) [](https://ko-fi.com/insality) [](https://www.buymeacoffee.com/insality)
[](https://github.com/Insality/panthera/tags)
# Panthera Runtime
**Panthera Runtime** - a [Defold](https://defold.com/) library designed to seamlessly integrate animations created with [**Panthera 2.0 Editor**](/docs_editor/README.md). This runtime can play animation for Collections and GUI nodes with also a animation cursor support.
## Features
- **Seamless Integration**: Import and use **Panthera 2.0** directly in Defold with one click.
- **Full Animation Support**: Supports all animation features provided by **Panthera 2.0** including all available properties, game events, template animations and more.
- **Flexible Usage**: Compatible with both Collections and GUI nodes in Defold, allowing for flexible usage across different game elements.
- **Animation Cursor**: Provides a way to control animation manually, allowing for precise control over playback and synchronization with game events.
## Panthera 2.0 Editor
Read the [**Panthera 2.0 Editor**](/docs_editor/README.md) guide to learn about the **Panthera 2.0 Editor**. This is the animation editor that you can use to create animations for your Defold projects, created with [Defold engine](https://defold.com/) and [Druid UI framework](https://github.com/Insality/druid)!
## Setup
### [Dependency](https://defold.com/manuals/libraries/#setting-up-library-dependencies)
Open your `game.project` file and add the following lines to the dependencies field under the project section:
**[Defold Tweener](https://github.com/Insality/defold-tweener)**
```
https://github.com/Insality/defold-tweener/archive/refs/tags/5.zip
```
**[Panthera Runtime](https://github.com/Insality/panthera)**
```
https://github.com/Insality/panthera/archive/refs/tags/runtime.5.zip
```
After that, select `Project ▸ Fetch Libraries` to update [library dependencies]((https://defold.com/manuals/libraries/#setting-up-library-dependencies)). This happens automatically whenever you open a project so you will only need to do this if the dependencies change without re-opening the project.
### Library Size
> **Note:** The library size is calculated based on the build report per platform
| Platform | Library Size |
| ---------------- | ------------ |
| HTML5 | **12.42 KB** |
| Desktop / Mobile | **21.35 KB** |
## Basic Usage
### GUI
```lua
local panthera = require("panthera.panthera")
local animation = require("gui.my_gui_panthera") -- Path to Lua animation file
function init(self)
self.animation = panthera.create_gui(animation)
panthera.play(self.animation, "default", {
is_loop = true
})
end
```
### Collections
```lua
local panthera = require("panthera.panthera")
local animation = require("entities.my_entity_panthera") -- Path to Lua animation file
function init(self)
self.animation = panthera.create_go(animation)
panthera.play(self.animation, "default", {
is_loop = true
})
end
```
## API Reference
### Quick API Reference
Read the [API Reference](api/panthera_api.md) file to see the full API documentation for the module.
```lua
local panthera = require("panthera.panthera")
-- Create animation state
panthera.create_go(animation_or_path, [collection_name], [objects])
panthera.create_gui(animation_or_path, [template], [nodes])
panthera.create(animation_or_path, adapter, get_node)
panthera.clone_state(animation_state)
panthera.play(animation_state, animation_id, [options])
panthera.set_time(animation_state, animation_id, time, [event_callback])
panthera.get_time(animation_state)
panthera.stop(animation_state)
panthera.get_duration(animation_state, animation_id)
panthera.is_playing(animation_state)
panthera.get_latest_animation_id(animation_state)
panthera.get_animations(animation_state)
-- Utils
panthera.set_logger([logger_instance])
panthera.reload_animation([animation_path])
panthera.SPEED
panthera.OPTIONS_LOOP
panthera.OPTIONS_SKIP_INIT
panthera.OPTIONS_SKIP_INIT_LOOP
```
### Documentation
- [API Reference](api/panthera_api.md)
- [Animation Blending](docs/animation_blending.md)
- [Customizing Your Adapter](docs/panthera_adapter.md)
## License
Panthera Runtime is licensed under the MIT License - see the [LICENSE](/LICENSE) file for details.
## Issues and Suggestions
For any issues, questions, or suggestions, please [create an issue](https://github.com/Insality/panthera/issues).
## Changelog
Read the [CHANGELOG](/CHANGELOG.md) to learn about the latest updates and features in Panthera Runtime.
## 👏 Contributors
## ❤️ Support the Project ❤️
Your support motivates me to keep creating and maintaining projects for **Defold**. Consider supporting if you find my projects helpful and valuable.
[](https://github.com/sponsors/insality) [](https://ko-fi.com/insality) [](https://www.buymeacoffee.com/insality)