187

What are the detailed steps necessary to prepare a Unity project for committing to a git repository eg. github? I don't want to store unnecessary files (specially temp files and avoid binary formats as much as possible) and I would appreciate a walk-through.

4
  • 91
    Oh definitely not. I'll stick to git, thanks
    – German
    Commented Dec 23, 2014 at 10:33
  • hi German, I was mainly just joking, but, svn is definitely easier for UNity projects.
    – Fattie
    Commented Dec 24, 2014 at 11:56
  • 2
    german, I just realised you mention to HIDE meta files. this is completely wrong. Is it a typo? Notice: docs.unity3d.com/Manual/… "by selecting Visible Meta Files" and "2. Enable Visible Meta files in Edit->Project Settings->Editor" It's a fairly basic point that you MAKE VISIBLE meta files for source control, you can see 100s QA on it on the unity forum. what's the confusion here? cheers!
    – Fattie
    Commented Dec 24, 2014 at 12:03
  • 1
    Wow! It's a very unpleasant typo on my side. Thanks for pointing it out (fixed)
    – German
    Commented Dec 24, 2014 at 15:37

2 Answers 2

264

On the Unity Editor open your project and:

  1. Enable External option in UnityPreferencesPackagesRepository (only if Unity ver < 4.5)
  2. Switch to Visible Meta Files in EditProject SettingsEditorVersion Control Mode
  3. Switch to Force Text in EditProject SettingsEditorAsset Serialization Mode
  4. Save Scene and Project from File menu.
  5. Quit Unity and then you can delete the Library and Temp directory in the project directory. You can delete everything but keep the Assets and ProjectSettings directory.

If you already created your empty git repo on-line (eg. github.com) now it's time to upload your code. Open a command prompt and follow the next steps:

cd to/your/unity/project/folder

git init

git add *

git commit -m "First commit"

git remote add origin [email protected]:username/project.git

git push -u origin master

You should now open your Unity project while holding down the Option or the Left Alt key. This will force Unity to recreate the Library directory (this step might not be necessary since I've seen Unity recreating the Library directory even if you don't hold down any key).

Finally have git ignore the Library and Temp directories so that they won’t be pushed to the server. Add them to the .gitignore file and push the ignore to the server. Remember that you'll only commit the Assets and ProjectSettings directories.

And here's my own .gitignore recipe for my Unity projects:

# =============== #
# Unity generated #
# =============== #
Temp/
Obj/
UnityGenerated/
Library/
Assets/AssetStoreTools*

# ===================================== #
# Visual Studio / MonoDevelop generated #
# ===================================== #
ExportedObj/
*.svd
*.userprefs
*.csproj
*.pidb
*.suo
*.sln
*.user
*.unityproj
*.booproj

# ============ #
# OS generated #
# ============ #
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
Icon?
ehthumbs.db
Thumbs.db
22
  • 23
    You may want to refer to gitignore.io for some suggested ignore content.
    – Chris
    Commented Feb 5, 2014 at 13:25
  • 1
    I will add my own .gitignore recipe here, thanks for the advice (makes sense)
    – German
    Commented Feb 9, 2014 at 12:07
  • 9
    As of 4.5, it looks like this option: "Enable External option in Unity → Preferences → Packages → Repository" is no longer in preferences or necessary. I didn't do that, but followed the rest of this, and it worked just fine. Commented Jul 10, 2014 at 20:28
  • 12
    By the way, confirmed everything works as is for Unity 5. Also, thanks a ton, German- this is a true life saver
    – MDragon
    Commented Mar 15, 2015 at 1:02
  • 2
    @fguillen you don't have to. The point if you "can" if you want, it's just a note
    – German
    Commented Aug 21, 2017 at 12:09
23

Since Unity 4.3 you also have to enable External option from preferences, so full setup process looks like:

  1. Enable External option in Unity → Preferences → Packages → Repository
  2. Switch to Hidden Meta Files in Editor → Project Settings → Editor → Version Control Mode
  3. Switch to Force Text in Editor → Project Settings → Editor → Asset Serialization Mode
  4. Save scene and project from File menu

Note that the only folders you need to keep under source control are Assets and ProjectSettigns.

More information about keeping Unity Project under source control you can find in this post.

3
  • 1
    Awesome, I updated my entry with your recommendations!
    – German
    Commented Feb 12, 2014 at 20:53
  • 3
    The "Packages" section is missing in the Preferences in Unity 4.5. What does this setting do actually? Commented Jul 23, 2014 at 12:01
  • 2
    Take a look at the selected answer above, the step "Enable External option in Unity → Preferences → Packages → Repository" is not necessary on Unity 4.5+
    – German
    Commented Sep 1, 2014 at 18:46

Not the answer you're looking for? Browse other questions tagged or ask your own question.