版本控制系统

前言

Godot 的目标是做到 VCS 友好,生成的文件大多可读、可合并。

版本控制插件

Godot 旨在对版本控制系统(Version Control System,VCS)友好,并尽量生成可读且可合并的文件。Godot 支持通过插件在编辑器本身中使用 VCS。可以在编辑器中的项目> 版本控制下设置或关闭 VCS。

截至 2023 年 7 月,尚且只有一个 Git 插件可用,但社区可能会创建其他的 VCS 插件。

官方 Git 插件

有一个官方插件可以让你在编辑器中使用 Git。你可以在GitHub找到最新的版本。

最新的更新、文档和源代码可以在Godot iOS插件库找到 Godot iOS plugins repository

从 VCS 中排除的文件

备注

这里列出了 Godot 4.1 及更高版本中应从版本控制中被忽略的文件和文件夹。

Godot 4.0 及更低版本中的版本控制应忽略的文件夹及文件列表与 Godot 4.1 及更高版本 ** 完全 ** 不同。 这点非常重要,因为 Godot 3.x 和 4.0 可能会将敏感凭据存储在 export_presets.cfg 中,而 Godot 4.1 及更高版本不会。

如果你正在使用 Godot 3,请查看本页说明文档的 3.5 版本。

当第一次在编辑器中打开项目时,Godot 会自动创建一些文件和文件夹。 为了避免生成的数据使版本控制仓库膨胀,你应该将它们添加到 VCS 忽略中:

  • . godot/:此文件夹存储各种项目缓存数据。

  • *.translation:这些文件是从 CSV 文件生成的导入后的的二进制翻译文件。

你可以选择在 Godot 项目管理器创建项目时自动生成版本控制元数据。当选择 Git 选项时,将在项目根目录中创建 .gitignore.gitattributes 文件:

在项目管理器的“新建项目”对话框中创建版本控制元数据

在项目管理器的 新建项目 对话框中创建版本控制元数据

在现有的项目中,选择编辑器顶部的 项目 菜单,然后选择 版本控制 > 生成版本控制元数据。这将与在项目管理器中执行的操作一样创建相同的文件。

在 Windows 上使用 Git

大多数 Git for Windows 客户端都将 core.autocrlf 设置为 true。可能会导致部分文件错误地被 Git 标记为已修改,因为这些文件的行尾被自动从 LF 转换成了 CRLF。

最好将此选项设置为:

  1. git config --global core.autocrlf input

使用项目管理器或编辑器创建版本控制元数据时,会使用 .gitattributes 文件自动强制使用 LF 行尾,因此无需更改 Git 配置。