Installing Git Source Control in Unreal Engine 5

🚪 Prerequisite Knowledge

1. Unreal Engine 5 Fully Installed with all it's development dependencies

   📎 Unreal Engine 5 Installation

2. Git LFS is installed.

   📎 Git LFS

❓ Key Question / Problem / Issue

1. How to Install & Setup Source Control on Unreal Engine 5 Project?

✅ Expected Output/Definition of Done

1. Reader able to setup Git Source Control in Unreal Engine 5

🎁 Resulting Solution

This Document are intended for developer who want to setup Unreal Engine Project with git version control System

---

For version control usage you can read Git Version Control Usage in Unreal Engine (for Artist and Designer)

Source:

Source Control Inside Unreal Editor

GitHub - ProjectBorealis/UEGitPlugin: Unreal Engine Git Source Control Plugin (refactored)

Unreal Project Git Workflow (Tutorial) | Unreal Engine Community Wiki

Unreal Engine 5 Source Control

Version control allows users on your team to share assets and code with one another, as well as providing a backup and history of changes so any files can be rolled back to an earlier version if something went wrong with the file. Unreal assets (like .uasset or .umap) are binaries, it’s been complicated to resolve when the file update is conflict with another user, we should make sure the file is locked (check-out) when been edited by user. So, nobody can edit same binary files on a same times and unlocked (check-in) when user finished edit those files. Here’s a guide for workflow how Source control is works in Unreal Engine 5.

1. Setting Up Unreal Engine 5 Git Repositories (Initial Repositories)

To setup Unreal Engine Git Repositories you need to add these following files to the project root folder

1. 🔗.gitattributes Template
2. 🔗.gitignore Template

2. Installing Git Plugin in Unreal Engine Project (Per-Project Setup)

We use Git LFS 2 3rd party plugin, UEGitPlugin from Project Borealis.

To Install it Follow these steps:

1. Download Latest Relase Version of UE Git Plugin Here

2. Extract and place the plugin folder in Plugins folder of your project

   if you don't find these folder create it yourselves

   you can also refer to these sample project for references

   Sample Project Repositories

3. Add Config/DefaultEditorPerProjectUserSettings.ini to the project roots

   [/Script/UnrealEd.EditorLoadingSavingSettings]
   ; Required
   bSCCAutoAddNewFiles=False
   ; Recommended modifiable based on workflow
   bAutomaticallyCheckoutOnAssetModification=False
   bPromptForCheckoutOnAssetModification=False
   

Further Reading

To Continue understand how to use Git Source Control in Unreal Engine you should read Using Git Source Control In Unreal Engine