UEGitPlugin 开源项目安装与使用指南

UEGitPlugin 开源项目安装与使用指南

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

1. 项目目录结构及介绍

UEGitPlugin 是一个针对 Unreal Engine 的 Git 源代码控制插件，经过重构以提供更好的性能、新特性和工作流程改进。以下是项目的主要目录结构概览：

• [Source/GitSourceControl] - 核心源代码，包含插件的功能实现。

  • gitignore: 控制哪些文件不应被 Git 版本控制系统追踪。
  • uplugin: 插件的配置文件，定义了插件的基本信息和兼容性。
  • LICENSE: 许可证文件，该项目遵循 MIT 许可证。
  • README.md: 项目的主要说明文件，包含了安装、配置和使用指导。

• [git-lfs] - 使用Git Large File Storage的相关工具和配置，用于高效管理大文件。

• 其他配置相关文件（如 _config.yml）提供了额外的项目设置或构建指南。

每个部分都精心组织，确保开发者能够快速定位到需要修改或查阅的部分。

2. 项目的启动文件介绍

此插件不直接有一个“启动”文件，因为它作为Unreal Engine的一个插件集成。激活该插件的关键在于将其正确放置在Unreal Engine的插件目录下，并通过编辑器启用它。主要的入口点是在插件的 .uplugin 文件中定义的，这个文件是Meta数据文件，指示了如何加载插件、它的版本、支持的引擎版本等。

3. 项目的配置文件介绍

插件配置

• [GitSourceControl.uplugin]: 这不是一个传统意义上的配置文件，但它是插件的核心配置。它定义了插件名称、版本、描述以及适用于哪个版本的Unreal Engine。

应用程序级别的配置

• Config/DefaultEditorPerProjectUserSettings.ini 和 Config/DefaultEngine.ini 中的条目对插件的行为进行微调。
  • bSCCAutoAddNewFiles=False 强制用户显式添加文件到版本控制，有利于性能优化。
  • 可以设置自动检出(bAutomaticallyCheckoutOnAssetModification)或者提示检出(bPromptForCheckoutOnAssetModification)来改善工作流程。
  • bAutoloadCheckedOutPackages=True 加速加载已检出的包。

特殊配置需求

• 对于实现Status Branches功能，可能需要在自定义的UUnrealEdEngine子类中进行编码配置，这是通过编辑器特定逻辑来完成的，而不是直接由插件的内部文件直接控制。

---

为了使用此插件，首先确保您的开发环境已经准备就绪，包括Visual Studio，Git，以及Git LFS。接下来，需将此插件源码复制到Unreal Engine项目或引擎的插件目录，并根据需要调整上述配置文件。记得编译插件，因为没有预编译的二进制文件提供。遵循这些步骤后，UEGitPlugin即可与你的Unreal Engine项目整合，提供高效的Git源代码管理体验。

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