Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/daylily-zeleen/godot-dragonbones

A GDExtension plugin of DragonBones for Godot 4.x
https://github.com/daylily-zeleen/godot-dragonbones

2d addon animation dragonbones gdextension godot godotengine plugin

Last synced: about 1 month ago
JSON representation

A GDExtension plugin of DragonBones for Godot 4.x

Awesome Lists containing this project

README 

        
# Godot-DragonBones Plugin



![image](demo/icon.png)



[点击查看中文说明](README.zh.md)。



A GDExtension plugin to add DragonBones for Godot.



![image](doc/1.PNG)



## Links



* Godot: 

* DragonBones: 



## Support Versions



* Godot 4.2 +

* DragonBones Pro 5.6



## Get plugin



1. Download from [release page](https://github.com/Daylily-Zeleen/Godot-DragonBones/releases).

2. Download from Assets Library.

3. Clone this repo and compile by youself.



## How to compile



1. Clone this repo with submodules.

2. Ensure you have "python", "Scons", and a appropriate c++ compiler.

3. Navigate to the root of local repo, run compile command, for example:

   For debug:



   ```shell

   scons target=template_debug debug_symbols=yes

   ```



   For release:



   ```shell

   scons target=template_release

   ```



   Please refer the build system system of [godot-cpp](https://github.com/godotengine/godot-cpp.git) for more compile options.



4. If compileing is successully, you can get the compiled plugin in `demo/addons/gddragonbones`.



## Run "demo" project



If you are not compile by youself, you should download this plugin and plug it into "demo".



## Export



1. Web: "Extensions Support" is required; "Thread Support" is requred if you use the precompiled plugin.



## Contents



This repository is improved from [gddragonbones](https://github.com/sanja-sa/gddragonbones).



1. Change to GDExtension for Godot 4.x.

2. Implement a import plugin to import DragonBones files automatically.

3. Imported Resource is `DragonBonesFoctory`:

   1. One factory can contain multi DragonBones data and Atlas data files.

   2. Can select DragonBones data and skin which are in factory to instantiate in `DragonBones` node.

   3. If detect DragonBones assets (for example, xxx_ske.json/dbbin and xxx_tex.json) in editor, it will generate a factory resource(xxx_ske.dbfactory) at the same folder.

4. `DragonBones` node:

   1. Remove mostly methods, all operations are work with `DragonBonesArmature`.

5. `DragonBonesArmature` node:

   * **Instantiated by `DragonBones` node which accroding to `DragonBonesFoctory`, don't instantiate it by youself.**

   * **Don't free by youself, it will lead to crash!!**

   * In editor, a proxy property in `DragonBones` node, which it's type is `DragonBonesArmatureProxy`, name is "main_armature", will be indicated as the main `DragonBonesArmature` node. If main armature have child armatures, it will have a "sub_armatures" property in `DragonBonesArmatureProxy`.

6. `DragonBonesArmatureProxy` **is editor use only!! Don't instantiate by youself, and don't access relevant objects/properties, They are unavaunavailable in release build.**

7. Can access `DragonBonesSlot` and `DragonBonesBone` to do some advance operations through `DragonBonesArmature` (but this is lack of test.).

8. I have not time to write a further description, please refer source code in "src/" for more details.



## Others



If this plugin can help you, please consider to [buy me a coffee](https://afdian.com/a/Daylily-Zeleen).



I'm not familiar with DragonBones, so there maybe have some wrong concepts in my code.

This repo is create for my personal project, and it is useful enough, so I think I will not do more optimize anymore.

Of cource, if I encounter bug, I will try to fix it.

If you have any improvement/repair, welcome to commit your pull request.