.gitattributes for Unity3D with git-lfs

.gitattributes

## Unity ##

*.cs diff=csharp text
*.cginc text
*.shader text

*.mat merge=unityyamlmerge eol=lf
*.anim merge=unityyamlmerge eol=lf
*.unity merge=unityyamlmerge eol=lf
*.prefab merge=unityyamlmerge eol=lf
*.physicsMaterial2D merge=unityyamlmerge eol=lf
*.physicMaterial merge=unityyamlmerge eol=lf
*.asset merge=unityyamlmerge eol=lf
*.meta merge=unityyamlmerge eol=lf
*.controller merge=unityyamlmerge eol=lf


## git-lfs ##

#Image
*.jpg filter=lfs diff=lfs merge=lfs -text
*.jpeg filter=lfs diff=lfs merge=lfs -text
*.png filter=lfs diff=lfs merge=lfs -text
*.gif filter=lfs diff=lfs merge=lfs -text
*.psd filter=lfs diff=lfs merge=lfs -text
*.ai filter=lfs diff=lfs merge=lfs -text

#Audio
*.mp3 filter=lfs diff=lfs merge=lfs -text
*.wav filter=lfs diff=lfs merge=lfs -text
*.ogg filter=lfs diff=lfs merge=lfs -text

#Video
*.mp4 filter=lfs diff=lfs merge=lfs -text
*.mov filter=lfs diff=lfs merge=lfs -text

#3D Object
*.FBX filter=lfs diff=lfs merge=lfs -text
*.fbx filter=lfs diff=lfs merge=lfs -text
*.blend filter=lfs diff=lfs merge=lfs -text
*.obj filter=lfs diff=lfs merge=lfs -text

#ETC
*.a filter=lfs diff=lfs merge=lfs -text
*.exr filter=lfs diff=lfs merge=lfs -text
*.tga filter=lfs diff=lfs merge=lfs -text
*.pdf filter=lfs diff=lfs merge=lfs -text
*.zip filter=lfs diff=lfs merge=lfs -text
*.dll filter=lfs diff=lfs merge=lfs -text
*.unitypackage filter=lfs diff=lfs merge=lfs -text
*.aif filter=lfs diff=lfs merge=lfs -text
*.ttf filter=lfs diff=lfs merge=lfs -text
*.rns filter=lfs diff=lfs merge=lfs -text
*.reason filter=lfs diff=lfs merge=lfs -text
*.lxo filter=lfs diff=lfs merge=lfs -text

Nice one. Thank you I'll use it to start.

added .cubemap & .tif to mine

Any opinions on LFS tracking .asset or .unity files?

@evitolins doesn't Unity YAML know how to handle it?

I think my terrain .asset files were corrupted by git using this setup, I suspect the eol=lf part should be removed. Any similar experiences?

Right, I seemed to have fixed it by removing eol=lf and adding * -text at the top.

https://gist.github.com/anjdreas/7d203cc2b2077df5acd67b8c101c4efa

It seems like you've incorrectly specified: physicsMaterial, it should be: physicMaterial (no s). I guess the same with the 2d variant as well.

thanks!

Thanks @jason-yak. Here is fork with updated physics -> physic along with some other configuration following this guide.

I also stumbled on the terrain issue. Problem is that most .asset files in Unity are YAML but TerrainData is the only thing I know of that is binary even if you Force Text serialization. Couldn't Unity just use a different extension if it was a special case?! Oh well.

@NPatch I was asking myself the same thing. Might be best to just stick to tracking Terrain assets in regular git?

@NPatch @hoffmannprojects
I can think of two solutions:

1. If only the terrain files are the .asset that are always binary ones, which I'm not 100% sure right now (after a quick search I found a couple more binaries but were on directories like Library that are not meant to be versioned), you can save all terrains in a specific path like Assets/Terrains/** (or similar). And add it to your .gitattribute file right in this order:

*.asset merge=unityyamlmerge eol=lf
/Assets/Terrains/*.asset filter=lfs diff=lfs merge=lfs -text
#only if subfolders with terrains exist:
/Assets/Terrains/**/*.asset filter=lfs diff=lfs merge=lfs -text

2. Let git guess the type of file with:

*.asset merge=unityyamlmerge text=auto

I will probably go for the first option (if you can afford that folder structure) since it's the more flexible.

I added .exr too. Sounds correct?

LightingData.asset seems to be always binary. This should also be added as well I believe?

 LightingData.asset binary

Noob here, is this a better version of the Unity.gitignore or a different file?

@Dreaddisk This file is for use with Git LFS

I see you're using:

*.asset merge=unityyamlmerge eol=lf

for all .asset files. But what I'm finding is that things like, /ProjectSettings/* is text, like TagsManager.asset and should be able to merge by line. So yeah, we don't want those in LFS.

On the other hand, Unity decided to use .asset for other things too, like meshes, materials, and others. Some of which are upwards of 25mb. Some of which are text (mesh/material), but others that are binary.

Is there a way to specify, if binary use lfs? Or do you really think it's okay for all .asset files to not use LFS?

I see you're using:

*.asset merge=unityyamlmerge eol=lf

for all .asset files. But what I'm finding is that things like, /ProjectSettings/* is text, like TagsManager.asset and should be able to merge by line. So yeah, we don't want those in LFS.

On the other hand, Unity decided to use .asset for other things too, like meshes, materials, and others. Some of which are upwards of 25mb. Some of which are text (mesh/material), but others that are binary.

Is there a way to specify, if binary use lfs? Or do you really think it's okay for all .asset files to not use LFS?

Check my previous message just a little bit above in the page.

I would probably go with the option 1, just because I do not really trust the ability of git to determine that. So you would like to identify the "*.assets" that are binaries and make some rules just for them. The most commons are terrains, not sure of any others.

Some *.asset files are binary, others text. I also have a hybrid (text / binary) asset file with a size of 180 MB. How to handle it in .gitattributes?
*.asset filter=lfs diff=lfs merge=lfs -text?

I have been having issues with asset files as well. Is there an updated version of this that has the rules for the common binary and text .asset types? It would be good to have one place to go for a Unity Git LFS file instead of reinventing the wheel each time.

For people looking at limiting binary *.asset file size, I got a solution for you.

https://stackoverflow.com/a/53692461/1677057

Looked into line ending of files with .asset extension in Force Text mode

crlf

• .asset files under ProjectSettings

lf

• Tile set config

Still binary with Force Text

• Lighting Data
• Terrain Data

2 cents: Leave .asset alone

I have been digging into this as well and wanted to point out that Unity's documentation for YAMLMerge indicates it should be used only for two types of files: .unity and .prefab

https://docs.unity3d.com/Manual/SmartMerge.html

Also what's the point of treating 3D objects/Video/Audio/Image as text? They are all binary. Ofc there are in some cases, ascii versions(FBX probably has one, OBJ is by default but there's a binary version as well, though almost no one uses it).

"-text" means non text : https://git-scm.com/docs/gitattributes

@nemotoo My bad..thx!

thanks for this. How would I use this with Unity assetbundles?

@dorkbot Unfortunately, I have no idea that how to manage assetbundles with git-lfs.
By the way, Unity team released new asset manage system.
I recommend this if you want to manage assets with git-lfs.
https://blogs.unity3d.com/2019/07/15/addressable-asset-system/

@nemotoo I see you use merge=unityyamlmerge to let git use unityyamlmerge for one type of files, How to let git know the unityyamlmerge tool?
how to config unityyamlmerge in .gitconfig file?

I like your way to set unityyamlmerge for specified files.
but this setting in .gitconfig file:
[merge]
tool = unityyamlmerge
I'm afraid that may let git always use unityyamlmerge for everything.