diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..683c508 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,155 @@ +# ------------------------------------------------------------------------- +# UNREAL ENGINE GITATTRIBUTES +# ------------------------------------------------------------------------- + +# Define LFS macro (Filter, Diff, Merge, and treat as binary) +[attr]lfs filter=lfs diff=lfs merge=lfs -text + +# ------------------------------------------------------------------------- +# UNREAL CORE ASSETS +# ------------------------------------------------------------------------- + +# Main Asset Types +*.uasset lfs +*.umap lfs + +# Build & Localization Internals +*.uexp lfs +*.ubulk lfs +*.locres lfs +*.locmeta lfs + +# ------------------------------------------------------------------------- +# SOURCE CODE & CONFIG +# ------------------------------------------------------------------------- + +# Ensure correct line endings for code across Windows/Mac/Linux +*.cpp text diff=cpp +*.h text diff=cpp +*.cs text diff=csharp +*.ini text +*.uproject text + +# ------------------------------------------------------------------------- +# 3D MODELS & SCENES +# ------------------------------------------------------------------------- + +*.3ds lfs +*.abc lfs +*.bgeo lfs +*.blend lfs +*.c4d lfs +*.collada lfs +*.dae lfs +*.dxf lfs +*.fbx lfs +*.geo lfs +*.glb lfs +*.gltf lfs +*.lws lfs +*.lxo lfs +*.ma lfs +*.max lfs +*.mb lfs +*.obj lfs +*.ply lfs +*.skp lfs +*.stl lfs +*.usd lfs +*.usdc lfs +*.usdz lfs +*.vdb lfs +*.vox lfs +*.zbr lfs +*.ztl lfs + +# ------------------------------------------------------------------------- +# IMAGES, TEXTURES & DESIGN +# ------------------------------------------------------------------------- + +# Standard Textures +*.bmp lfs +*.exr lfs +*.gif lfs +*.hdr lfs +*.ico lfs +*.jpeg lfs +*.jpg lfs +*.pict lfs +*.png lfs +*.tga lfs +*.tif lfs +*.tiff lfs +*.webp lfs +*.xcf lfs + +# Source Art / Design Files +*.afdesign lfs +*.afphoto lfs +*.ai lfs +*.art lfs +*.cdr lfs +*.eps lfs +*.kra lfs +*.psb lfs +*.psd lfs +*.sketch lfs +*.svg lfs + +# ------------------------------------------------------------------------- +# AUDIO & VIDEO +# ------------------------------------------------------------------------- + +# Audio +*.aif lfs +*.aiff lfs +*.bank lfs +*.it lfs +*.mod lfs +*.mp3 lfs +*.ogg lfs +*.s3m lfs +*.wav lfs +*.xm lfs + +# Video +*.asf lfs +*.avi lfs +*.flv lfs +*.m4v lfs +*.mov lfs +*.mp4 lfs +*.mpeg lfs +*.mpg lfs +*.ogv lfs +*.wmv lfs + +# ------------------------------------------------------------------------- +# BINARIES, ARCHIVES & DOCUMENTS +# ------------------------------------------------------------------------- + +# Archives +*.7z lfs +*.bz2 lfs +*.gz lfs +*.rar lfs +*.tar lfs +*.zip lfs + +# Compiled & Libraries +*.a lfs +*.dll lfs +*.dylib lfs +*.exe lfs +*.lib lfs +*.pdb lfs +*.so lfs + +# Documents +*.doc lfs +*.docx lfs +*.pdf lfs +*.ppt lfs +*.pptx lfs +*.xls lfs +*.xlsx lfs diff --git a/.gitignore b/.gitignore index 715b38f..0592900 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,16 @@ -# ---> UnrealEngine -# Visual Studio 2015 user specific files -.vs/ +# ------------------------------------------------------------------------- +# UNREAL ENGINE GITIGNORE +# ------------------------------------------------------------------------- +# ---> Visual Studio & IDEs +# Visual Studio user-specific files +.vs/ +.vsconfig + +# JetBrains Rider / IntelliJ +.idea/ + +# ---> Compilation Artifacts # Compiled Object files *.slo *.lo @@ -32,7 +41,8 @@ *.app *.ipa -# These project files can be generated by the engine +# ---> Generated Project Files +# These are generated by "Generate Project Files" (right-click .uproject) *.xcodeproj *.xcworkspace *.sln @@ -42,35 +52,53 @@ *.VC.db *.VC.opendb -# Precompiled Assets -SourceArt/**/*.png -SourceArt/**/*.tga - -# Binary Files -Binaries/* -Plugins/**/Binaries/* - -# Builds -Build/* - -# Whitelist PakBlacklist-.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 Editor -Saved/* +# ---> Engine & Editor Temporary Files +# Configuration files generated by the Editor (local user prefs) +Saved/ # Compiled source files for the engine to use -Intermediate/* +Intermediate/ +# Recursive check for Intermediate folders in Plugins Plugins/**/Intermediate/* # Cache files for the editor to use -DerivedDataCache/* +DerivedDataCache/ +# Binary Files (Compiled engine code) +Binaries/ +# Recursive check for Binaries in Plugins +Plugins/**/Binaries/* + +# Developer Plugins (Local/sandbox plugins not meant for the shared repo) +Plugins/Developer/ + +# ---> Asset & Build Artifacts +# Built data for maps (Lighting data, etc. - usually massive and auto-generated) +*_BuiltData.uasset + +# Precompiled Assets (Source art is often kept outside repo or in LFS) +SourceArt/**/*.png +SourceArt/**/*.tga + +# Builds +Build/ +Builds/ + +# ---> Build Whitelisting Logic +# This logic ignores the "Build" folder contents BUT allows specific exceptions +# meant for version control (like PakBlacklists and Icons) + +# 1. Allow the immediate subdirectories of Build/ +!Build/*/ +# 2. Ignore everything inside those subdirectories +Build/*/** +# 3. But explicitly KEEP PakBlacklist text files +!Build/*/PakBlacklist*.txt +# 4. And explicitly KEEP icon files +!Build/**/*.ico + +# ---> Specific Configs +# SteamVR and HoloLens auto-generated configs that shouldn't be shared +Config/steamvr_ue_editor_app.json +Config/SteamVRBindings +Platforms/HoloLens/Config/HoloLensEngine.ini diff --git a/README.md b/README.md index 50b9e79..8a70882 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,3 @@ -# unrealengine_template +# Modern Unreal Engine Template +Includes .gitignore and .gitattributes, with LFS support.