GDExtensionTemplate项目指南

GDExtensionTemplate项目指南

GDExtensionTemplate📜 A template project for building Godot 4 GDExtensions using CMake项目地址:https://gitcode.com/gh_mirrors/gd/GDExtensionTemplate

1. 项目目录结构及介绍

本指南将深入解析GDExtensionTemplate项目的结构，它是一个用于构建基于C++和CMake的Godot 4扩展的模板项目，旨在简化GDExtension的开发流程。

主要目录简介

• .github/workflows：包含GitHub Actions的配置文件，用于自动化持续集成和部署。
• vscode, cmake, extern, src, support_files/icons：分别存放编辑器配置、CMake相关文件、外部依赖、源代码、以及资源图标。
• templates: 包含GDExtension的模板文件，用于构建不同平台的扩展。
• clang-format: 配置文件，定义了C++代码风格。
• gitignore: 指示Git忽略哪些文件或目录。
• CHANGELOG.md, LICENSE.md, README.md: 分别记录项目更改日志、许可协议和项目介绍及使用说明。

目录结构详细解读

• project/
  • 项目模板中的Godot工程基本结构，含有可分配给其他项目的组件。
• addons/example/
  • 示例添加项的文件，准备分发到其他项目中。
• demo/
  • 内部测试使用的场景和脚本，非必需但有助于内部验证。
• src/
  • 扩展的源代码所在地，包含了核心功能实现。
• godot-cpp/
  • 子模块，提供Godot引擎的C++绑定，对于GDExtension编译至关重要。

2. 项目启动文件介绍

在GDExtensionTemplate中，并没有单一的“启动文件”如应用程序通常所指。不过，开发流程的关键起点是修改或配置特定文件来创建新的GDExtension：

• RegisterExtension.cpp
  • 修改入口符号GDExtensionInit是关键步骤之一，确保你的扩展正确注册于Godot引擎。
• CMakeLists.txt
  • 控制整个构建过程的主要文件，是编译和链接的起点。你需要在此指定构建类型、目标等。

3. 项目的配置文件介绍

• CMakeLists.txt

  • 这不仅是构建的起点，也是项目配置的核心。通过这个文件，你可以设置编译选项、目标平台、安装路径等。
  • 额外CMake选项：项目定义了一些额外的选项，比如CCACHE_PROGRAM，允许指定ccache的路径以加速编译。

• templates/*.gdextension

  • 这些模板文件用于自动生成对应平台的GDExtension二进制文件，需要根据支持的平台进行适当调整。

• clang-format

  • 不直接参与项目启动，但作为配置文件，确保团队编码风格的一致性。

• gitignore

  • 忽略不需纳入版本控制的文件或目录，对于保持仓库干净非常重要。

• CHANGELOG.md

  • 记录项目随时间的发展历程，遵循Semantic Versioning和Keep a Changelog原则维护更新记录。

• LICENSE.md

  • 描述软件许可条件，开发者需注意遵守的版权法律。

通过理解和定制这些核心元素，您可以快速搭建起适合自己需求的GDExtension项目。记得在进行任何定制化修改之前仔细阅读原始的README.md，获取最新的指导信息。

GDExtensionTemplate📜 A template project for building Godot 4 GDExtensions using CMake项目地址:https://gitcode.com/gh_mirrors/gd/GDExtensionTemplate