UEGitPlugin 使用教程

UEGitPlugin 使用教程

UEGitPlugin Unreal Engine Git Source Control Plugin (refactored) 项目地址: https://gitcode.com/gh_mirrors/ueg/UEGitPlugin

1. 项目介绍

UEGitPlugin 是一个为 Unreal Engine 开发的 Git 源代码控制插件，经过重构以优化性能和添加新功能。该项目由 ProjectBorealis 团队维护，旨在提供一个高效、稳定的 Git 源代码控制解决方案，适用于 Unreal Engine 项目。

主要特性

• 多线程锁定/解锁：显著提高锁定/解锁大量文件时的性能。
• 远程锁定状态检查：仅在需要时检查远程锁定状态。
• 本地锁定缓存：加速本地操作。
• 性能优化：改进仓库文件遍历和初始化逻辑。
• 编辑器内拉取优化：仅刷新更改的文件，防止大型项目中的崩溃。
• 支持状态分支：检查多个分支上的过期文件与远程的对比。
• 自动处理推送：从过期的本地副本自动处理推送。

2. 项目快速启动

安装步骤

1. 克隆项目：

   git clone https://github.com/ProjectBorealis/UEGitPlugin.git
   

2. 安装到项目： 将插件安装到你的项目 Plugins/ 文件夹中，或者如果你想安装到引擎中，请将 Engine/Plugins/Developer/GitSourceControl.uplugin 重命名为 Engine/Plugins/Developer/GitSourceControl.uplugin.disabled，然后将此插件安装到 Engine/Plugins 文件夹。

3. 编译插件： 请注意，目前不提供预编译的二进制文件，因此你需要使用 Visual Studio 编译插件。

配置 gitattributes 和 gitignore

此插件需要显式文件属性，例如 *.umap 和 *.uasset，而不是使用通配符（如 Content/**）。你可以参考项目中的 gitattributes 文件作为示例。

配置 Unreal 编辑器

在 Config/DefaultEditorPerProjectUserSettings.ini 中进行以下配置：

[/Script/UnrealEd.EditorLoadingSavingSettings]
bSCCAutoAddNewFiles=False
bAutomaticallyCheckoutOnAssetModification=True
bPromptForCheckoutOnAssetModification=False

在 Config/DefaultEngine.ini 中进行以下配置：

[SystemSettingsEditor]
r.Editor.SkipSourceControlCheckForEditablePackages=1

3. 应用案例和最佳实践

应用案例

UEGitPlugin 适用于需要高效源代码控制的大型 Unreal Engine 项目，特别是那些需要频繁锁定/解锁文件的项目。例如，游戏开发团队可以使用此插件来管理大型资产文件的版本控制。

最佳实践

• 定期更新插件：确保你使用的是最新版本的插件，以获得最佳性能和稳定性。
• 配置状态分支：根据项目需求配置状态分支，以确保文件的版本控制和锁定状态的正确管理。
• 使用 HTTPS 认证：推荐使用 HTTPS 认证来简化 Git 仓库的访问和管理。

4. 典型生态项目

相关项目

• Unreal Engine 官方插件：Unreal Engine 提供了多种官方插件，如 Perforce 和 PlasticSCM 插件，可以与 UEGitPlugin 结合使用，提供更全面的源代码控制解决方案。
• Git LFS：UEGitPlugin 与 Git LFS 集成，可以更好地管理大型二进制文件。

通过以上步骤和配置，你可以快速启动并使用 UEGitPlugin，提升 Unreal Engine 项目的源代码控制效率。

UEGitPlugin Unreal Engine Git Source Control Plugin (refactored) 项目地址: https://gitcode.com/gh_mirrors/ueg/UEGitPlugin