Skip to content

Latest commit

 

History

History
82 lines (56 loc) · 3.55 KB

README.zh.md

File metadata and controls

82 lines (56 loc) · 3.55 KB
Raw

Godot-DragonBones Plugin

image

Click here to refer English readme.

一个为 Godot 添加 DragonBones 功能的 GDExtension 插件。

image

相关连接

支持的版本

  • Godot 4.2 以上(可以尝试切换子模块godot-cpp来编译4.1的gdextension)
  • DragonBones Pro 5.6

获取插件

  1. 从发布页面下载最新的发布版。
  2. 克隆该仓库自行编译。

如何编译

  1. 与子模块一并克隆。

  2. 确保你的开发环境中有"python", "Scons",以及一个合适的c++编译器。

  3. 导航至本地仓库的根目录，运行编译命令，以下命令仅作参考: Debug:

    scons target=template_debug debug_symbols=yes

    Release:

    scons target=template_release

    更多编译选项请参考godot-cpp的编译系统。

  4. 如果编译成功的话，你将可以在demo/addons/gddragonbones获取到编译好的插件。

运行示例项目

如果不是自行编译，则需要从发布页面下载该插件并安装到"demo"项目中。

说明

该仓库改进自龙骨模块。

改进内容

  1. 改为4.x用的GDExtension。
  2. 实现编辑器导入插件以供自动导入龙骨相关文件。
  3. 导入资源为DragonBonesFoctory:
    • 单个工厂资源可以指定多个龙骨数据和图集描述数据文件
    • 可在DragonBones节点中指定要从DragonBonesFoctory实例化的龙骨数据名称和相应的皮肤名称
    • 如果识别到合适的龙骨资源(xxx_ske.json/dbbin 与 xxx_tex.json)时将在同目录下生成对应的工厂资源文件(xxx_ske.dbfactory)
  4. DragonBones节点:
    • 播放动画相关的方法只对主DragonBonesArmature进行操作，停止播放则递归对所有DragonBonesArmature操作
    • 其他属性则对所有的DragonBonesArmature操作 由于龙骨对动画的操作粒度是针对某一个Armature，因此不建议直接对DragonBones进行动画相关的控制。
  5. DragonBonesArmature节点:
    • 由DragonBones根据设定从DragonBonesFoctory进行实例化，不应该手动创建。
    • 在编辑器中,作为DragonBones的"main_armature"属性以DragonBonesArmatureProxy类型进行设置,如果有子Armature，则会用有一个"sub_armatures"属性可供编辑（所有一切编辑设置将会保存在场景数据中，实例化时将被正确设置倒相应的DragonBonesArmature上）。
    • 千万不要手动释放！否则将导致崩溃！
  6. DragonBonesArmatureProxy仅供编辑器使用，不要自行实例化，也不要访问相关对象（如DragonBones的"main_armature"与DragonBonesArmatureProxy的"sub_armatures"属性。）
  7. 可从DragonBonesArmature访问其中的DragonBonesSlot和DragonBonesBone进行一些高级操作（该部分没有测试，个人项目没有需求）。
  8. 没有时间编写更详细的说明，具体请翻看"src/"下的源码。

其他

如果这个插件能帮到你还请为我充电。

该仓库为个人项目使用，反正龙骨也已经跑路了，仅供给想在Godot中使用现存龙骨资源的人。 本人对龙骨中的概念也并不熟悉，是翻看源码一点改的，如果有些依赖关系搞混了也请多包涵。 改进的内容也已经大大超出我个人所需了，应该不会再附加什么改进了。 不过仍然欢迎提交修复和改进pr。