A Git template for Unreal Engine 5 projects.
- Use this template to create a new repository OR clone this repository to your local machine.
- Change the default MyProject name to reflect your project name in:
- Markdown files (README.md, CONTRIBUTION.md, ... etc.)
- Directories (Raw, Source, Content)
- The .gitignore file
- Delete everything above this line.
- Have fun!
A correct git setup example with git-lfs for Unreal Engine 5.
With git, you might want to also enable One File Per Actor feature, as it provides a more atomic level versioning flow.
/Build/Config/Content/MyProject/MyProjectDLC_01
/Documentation/Plugins/Raw/MyProject/MyProjectDLC_01
/Source/MyProjectEditor/MyProjectGame
/Resources/Editor/Game
git-lfsmanagement rules are mostly defined for file types, and not paths however, there can entire paths marked to be managed bygit-lfs. Without a special note, expect only type-based rules apply to a directory.
/Build
Holds files needed for building the engine or game, including files necessary for creating platform-specific builds.
/Config
Configuration files for setting values that control engine behavior. Values set in the game project Config files override the values set in the Engine\Config directory.
/Content
Holds content for the engine or game, including asset packages and maps.
/Documentation
Holds content for the documentations, like README.md or CONTRIBUTION.md.
/Plugins
Game plugins. Every plugin lives in a subdirectory of the /Plugins dir. A plugin internal directory structure is not strictly documented, so there are no assumptions on how a plugin is structured.
It may be useful to use git submodules to manage plugins in a more robust manner.
It is expected that each plugin will have its own .gitignore file in its subdirectory, as well other required specific git tweaks.
/Raw
This directory is managed entirely by git-lfs.
/Raw is a directory where you store assets in their source formats, in contrast to /Content, where assets are stored in the engine format (after the import). Having an asset in a source format is useful when you're still making updates to it. It may be a good idea to also have separate repos for managing work-in-progress assets (maybe in smaller collections or even idividually).
/Source
C++ source code is stored under the /Source path. As with most other directories, this directory is managed by standard git (and not git-lfs). That means no blobs. Do not put here any .dlls, .exes, .zips and other binaries. Only text files are allowed.
Generated text files can reside in the local /Source dir, but should be ignored by git with additional entries in .gitignore.
/Source/MyProjectEditor
Source files used by just the editor.
/Source/MyProjectGame
Source files in a game project directory are organized by module; one directory per module.
/Resources
Project and Editor related resources. This directory is managed by git-lfs.
/Resources/Editor
Resource files used by the editor. For example, splash images.
/Resources/Game
Resource files used by the game, but not from the content browser. For example, these files can be images or assets used to build the game.
All game content is placed in a sub-folder. eg. Content/MyProject/UI/... This helps in migrating between projects and splitting your content from FAB packs that are added like Content/MyFabPack/...
When testing out local assets that are not ready to be used by other members of your team (or perhaps never should be) you can put them in your Developer-folder. You can enable this folder in the view options of the Content Browser. These assets will not show up in searches by other developers.
/MyProject/AI/Art/Characters/Environment/Buildings/Landscape/Props
/Audio/Data/Music/SFX
/Characters/Core/Editor/FX/Art
/Input/Actions
/Maps/Development
/Movies/Shared/Materials
/UI/Art/Fonts/Materials
/Art
Art related assets, except UI/FX.
/Audio
Audio related assets. /Data folder can be used for SoundClasses or any other sound related logic.
/Core
The core gameplay logic, such as GameInstance or GameMode.
/Editor
Any Editor related content, logic and resource.
/FX
Contains various particle effects.
/Input
All player input related logic.
/Movies
Pre-rendered movies. This directory also used by the Async Loading Screen plugin.
/Shared
Commonly used resources, such as Master Materials.
/UI
Any UI related content, logic and resource.
It’s recommended to use a dedicated FAB content project to import the packs first. This is your staging area before migrating pieces into your main project. This lets you review and filter out unwanted content early.
Note: To help maintain a clean project and Git structure, this template only includes directories from the Content directory that starts with MyProject. For example, the MyProjectDLC_01 directory will be included, but the automatically generated Developers or Collections directory won't be included by default. You can change this behavior by modifying the .gitignore file.