游戏引擎 / 系统课时
整理可复用的项目交付结构
整理可复用的项目交付结构
一个小游戏即使已经成功导出,混乱的源码目录、临时素材和缺失的说明仍会拖慢下一次修改。本课把 Godot 4 工程整理为可继续开发、可重复构建、可独立发布的交付单元,并用一次全新检出验证整理没有破坏项目。
学习目标
- 区分可编辑工程、可运行构建和交付说明的边界。
- 清理临时内容,同时保留场景与资源的真实依赖。
- 使用忽略规则和全新环境复现,验证项目可交接。
区分源码、构建与说明
至少区分三类交付物:源码工程供后续修改,发布包供玩家运行,说明文档供团队复现。不要把导出的可执行文件混放在 scenes/、scripts/ 等源码文件夹中,也不要把缓存当作源素材提交。
源码根目录保留 project.godot、实际使用的场景、脚本、源贴图和音频,以及确实需要的插件。推荐按职责组织为 scenes/、scripts/、assets/ 和 ui/;复杂项目也可以按玩法模块组织,但同类资源的归属规则要一致。场景路径、Autoload 名称和输入动作名是工程约定,不能仅为了目录整齐就随意重命名。
团队要重复导出时,还应保留不含私密凭据的 export_presets.cfg。给玩家的发布目录则只放该平台所需的可执行文件、配套资源与使用说明,不强行要求玩家安装编辑器。
清理临时内容但不破坏引用
先在版本库中建立一个可回退的检查点,再在 Godot 编辑器里移动或重命名资源,让编辑器同步更新引用。优先移除确定未使用的试验场景、重复贴图、测试脚本和临时输出;删除前检查主场景、实例化场景、脚本预加载与动态路径加载是否仍依赖它们。
需要特别谨慎的是动态加载:某张贴图可能不在场景树中直接引用,而是由 load() 或 ResourceLoader 在运行时选择。仅凭文件没有显示在某个场景下,就判断它无用,容易造成导出后缺资源。清理后要重新打开主场景,并跑一遍核心流程。
.godot/ 是 Godot 4.1 及以后可重新生成的项目缓存目录,通常不进入版本库;但源图片、模型、音频和必要的导入设置不能因为带有“缓存”字样就一并删除。插件的实际源码、许可证和配置文件如果是运行必需品,也应随工程保留。
配置适合团队协作的忽略规则
以下是适用于 Godot 4.1 及以后、使用 Git 管理工程的一份 .gitignore 片段示例。将它放在 project.godot 同级目录,且假定发布文件统一输出到 build/ 或 dist/。
# 引擎可重新生成的缓存与翻译产物
.godot/
*.translation
# 本地导出包与构建结果
build/
dist/
# 若使用本地环境文件,避免提交私密值
.env
.env.*
!.env.example生效行为是新生成的缓存、构建目录和本地环境文件默认不会被 Git 收录;.env.example 可作为不含密钥的配置模板保留。可通过 git status --short --ignored 检查哪些文件被忽略。注意忽略规则不会自动移除以前已被 Git 跟踪的文件,需先审核后将其移出索引;不要对仍被场景引用的源资源做这种处理。
用最小交接说明消除隐含依赖
在 README.md 写清目标 Godot 版本(尽量固定到具体小版本)、项目入口 project.godot、主场景路径、目标平台、输入操作、使用的插件与可选外部工具,以及导出方法。若项目依赖第三方素材,应列出来源与许可条件;如果需要单独安装导出模板或平台 SDK,也要注明。
可把交付包拆成可编辑工程与平台发布压缩包分别命名,并在版本记录中注明二者对应的提交版本。私钥、签名文件、账户令牌和本机绝对路径不应放进公开工程;有特殊本地配置时,说明怎样安全取得,而不是把真实值写进文档。
在全新工作目录验证可复用性
验收时从版本库全新检出工程,使用文档指定的 Godot 版本打开 project.godot,等待资源重新导入,再运行主场景。依次确认插件可启用、输入映射存在、Autoload 正常、场景引用无丢失,最后用保存的导出预设生成新发布包并独立启动。
如果新环境缺少素材、插件或外部工具,说明这些内容没有被正确纳入交付边界;如果本地原工程正常而全新检出失败,应先修复可复现性,再谈清理完成。真正可复用的项目不依赖作者机器上的隐形缓存,也能让另一位开发者按照说明继续维护。