SDSU-GCO.github.io
How to configure git for unity
This is a guide for the initial configuration of git that GCO uses. Please note that this guid is for github desktop with git cli and lfs support using UnityYamlMerge to resolve conflicts which falls back to tourtoise git. Initially this guide will be more for windows users, however if we can find good alternatives we may update this guide in the future.
Disclaimer!
This whole guide might not apply to everyone depending on your preffered tools and workflow, however feel free to use any parts of this guide. This guide is provided under the understanding that we are not responsible if something goes wrong and we do not garentee the correctness/accuracy of this guide.
Table of Contents
Downloads and Installation
Configuration
Downloads and Installations
Installing Unity
GCO recomends managing unity installs with unity hub. If you know you don’t use unity hub you can skip the Unity Hub step.
Unity Hub
Visit Download Unity Huband download Unity Hub. The download button is to the right of the standard unity install. Once downloaded launch the executable and follow the installation wizard.
Unity Game Engine
Visit Download Game Engineand download the appropriate version of Unity for your organization by clicking the “Unity Hub” button. In this case we will use Unity 2019.1.4f1 as our example. Allow the webpage to open Unity Hub. Then simply complete the installation and follow any prompts from Unity Hub.
Installing Github Desktop
Visit Download Github Desktop and download the installer for your system and follow the installation wizard.
Installing Git CLI and LFS
Git
Download then install Git CLI Note that on windows some GCO members prefer to use git from CMD.EXE. If you would like this make sure to select it at installation
LFS
Download then install Git LFS. This tool allows for large asset files such as sounds, images, and other large files to be stored more efficiently.
Meld
Download then install meld. This tool allows you to resolve merge conflicts that UnityYAMLMerge can’t handle automatically
IMPORTANT!!! - Meld version 3.2.0 which is the current version as of this guide seems to have a bug opening diffs automatically via CLI from other programs! Below is a workaround:
Fix Meld library
By default a script looks for a dll in the wrong location resulting in the following error:
Windows
on windows this can be fixed by opening an administrator CMD.exe prompt. Then navigate to the meld folder. By default this folder is located at “C:\Program Files (x86)\Meld”. Then once you are at the right directory path, and ONLY IF YOU ARE IN YOUR MELD DIRECTORY, run the following command
mklink libgirepository-1.0-1.dll lib\libgirepository-1.0-1.dll
This will create a symlink to the file redirecting the script that is looking for it.
Other OS
If you are not on windows then navigate to the \Meld\ folder in a file explorer and open \lib\. Then locate the file “libgirepository-1.0-1.dll” and move it to the parent directory(\Meld\). This should resolve the error.
This should leave you with the following error when running:
This error appears to be beneign and can be reasonably ignored.
Configuration
Tool Configuration
Meld Merge
Open “C:/Program Files/Unity/Hub/Editor/2019.1.4f1/Editor/Data/Tools/” or your custom unity install path and open “mergespecfile.txt” Add these lines to it:
unity use "C:\Program Files (x86)\Meld\Meld.exe" "%r" "%b" "%l" -o "%d"
prefab use "C:\Program Files (x86)\Meld\Meld.exe" "%r" "%b" "%l" -o "%d"
cs use "C:\Program Files (x86)\Meld\Meld.exe" "%r" "%b" "%l" -o "%d"
# Default fallbacks for unknown files. First tool found is used.
# Meld Merge
* use "C:\Program Files (x86)\Meld\Meld.exe" "%r" "%b" "%l" -o "%d"
If you changed the Meld install path use that instead of “C:\Program Files (x86)”.
If “unity use…” and/or “prefab use…” already exist simply delete them and replace them with the above lines.
UnityYamlMerge
Open your “.gitconfig” file and add these lines to it. Your get config can be found at your user directory. On windows this is typically “C:\Users\UserName\” where “UserName” is replaced with your username.
[merge]
tool = unityyamlmerge
[mergetool "unityyamlmerge"]
trustExitCode = false
cmd = 'C:/Program Files/Unity/Hub/Editor/2019.1.4f1/Editor/Data/Tools/UnityYAMLMerge.exe' merge -p "$BASE" "$REMOTE" "$LOCAL" "$MERGED"
[mergetool]
keepBackup = false
prompt = false
Please note that you may need to change “C:/Program Files/Unity/Hub/Editor/2019.1.4f1” to the location where you installed unity if you did not install to the standard location or you aren’t using unity hub.
Repository Configuration
LFS
This portion of the configuration must be completed for each repository. First, launch the CLI
Then Type git lfs install and hit enter as shown below:
.gitignore and .gitattributes
You should include a .gitignore to tell git not to sync unneccisary/temporary files and user specific files. You should also use a .gitattributes file to control what files are managed by lfs. These are the .gitignore(CLICK ME!) and .gitattributes(CLICK ME!) that GCO uses. Simply rename them from “gitignore.txt” to “.gitignore” and from “gitattributes.txt” to “.gitattributes”, then add them to the root directory of your repositoy(found by clicking show in explorer in github desktop) as shown:
Unity
In project settings be sure to set meta files to be visible and force text serialization
Usage
For Command Line Interface help, please see: How To GIT Better
For GUI tutorials please see the Version Control section of Tutorials