github/gitignore · UnrealEngine.gitignore
Unreal Engine .gitignore 模板详解
说明 UnrealEngine.gitignore 忽略 Binaries、Intermediate、Saved、DerivedDataCache 和生成的解决方案文件的原因,以及 Build 目录中否定规则的结构。
UnrealEngine.gitignore 是面向虚幻引擎 C++ 项目的模板。它排除引擎为编译、烘焙和着色器缓存生成的大容量目录,以及编辑器可以重新生成的 IDE 项目文件。
处理 Build/ 目录的五行是展示 gitignore 优先级的好例子。先排除目录中的全部内容,再恢复各平台的子目录,然后在其中只重新包含图标和 PakBlacklist 文件。
逐条规则详解
| 模式 | 忽略什么,为什么忽略 |
|---|---|
Binaries/*Intermediate/*Saved/*DerivedDataCache/* | 引擎生成的目录编译后的模块、中间构建文件、日志、自动保存与配置缓存、着色器与资源派生数据。都由编辑器或构建重新生成。 |
Plugins/**/Binaries/*Plugins/**/Intermediate/* | 插件构建结果项目插件也会各自生成 Binaries、Intermediate。用 ** 匹配任意深度的插件。 |
Build/*!Build/*/Build/*/**!Build/*/PakBlacklist*.txt!Build/**/*.ico | Build 目录的例外结构用 Build/* 排除内容,用 !Build/*/ 恢复子目录。只有目录保持有效,才能先用 Build/*/** 再次排除,然后用 ! 只包含 PakBlacklist 和图标文件。这是绕开“父目录被排除后无法恢复子文件”这一规则的方法。 |
*.sln*.suo*.xcodeproj*.xcworkspace.vs/.vsconfig | 生成的 IDE 项目可以随时从 .uproject 通过 'Generate Project Files' 重新生成的 Visual Studio、Xcode 文件。 |
*.obj*.o*.pch*.dll*.lib*.exe*.app*.ipa | 编译产物C++ 编译、链接结果和打包结果。 |
*_BuiltData.uasset | 已构建的光照数据光照构建生成的各地图数据。体积大、变化频繁,可以重新构建。 |
SourceArt/**/*.pngSourceArt/**/*.tga | 原始美术素材用于把导入前的原始纹理目录排除在仓库之外的规则。如果要对原始素材做版本控制,请删除它并使用 Git LFS。 |
实践中的注意事项
.uasset、.umap等二进制资源实际上必须用 Git LFS 跟踪。Config/、Content/、Source/、.uproject是提交对象。Saved/Config中的设置属于个人设置,被排除是正确的。- 修改
Build/结构之前,请把Build/Windows/Application.ico这样的路径放进模式测试器确认结果。
原始模板
UnrealEngine.gitignore
# Visual Studio 2015 user specific files.vs/# Compiled Object files*.slo*.lo*.o*.obj# Precompiled Headers*.gch*.pch# Compiled Dynamic libraries*.so*.dylib*.dll# Fortran module files*.mod# Compiled Static libraries*.lai*.la*.a*.lib# Executables*.exe*.out*.app*.ipa# These project files can be generated by the engine*.xcodeproj*.xcworkspace*.sln*.suo*.opensdf*.sdf*.VC.db*.VC.opendb.vsconfig# Precompiled AssetsSourceArt/**/*.pngSourceArt/**/*.tga# Binary FilesBinaries/*Plugins/**/Binaries/*# BuildsBuild/*# Whitelist PakBlacklist-<BuildConfiguration>.txt files!Build/*/Build/*/**!Build/*/PakBlacklist*.txt# Don't ignore icon files in Build!Build/**/*.ico# Built data for maps*_BuiltData.uasset# Configuration files generated by the EditorSaved/*# Compiled source files for the engine to useIntermediate/*Plugins/**/Intermediate/*# Cache files for the editor to useDerivedDataCache/*
模板来源: github/gitignore/UnrealEngine.gitignore @356fd7b (2026-09-11) · CC0-1.0