Ignore files

Some files never need to be edited or checked in, so you can add them to the ignored list so that Unity Version Control (UVCS) doesn’t track them.

Note: When you add items to the ignore list, UVCS creates an ignore.conf file. You can also add this file to the ignored list.

Configure the ignored files list

You can configure your ignored files in the Unity DevOps Version Control application:

  1. In the Workspace Explorer tab, right-click the item.
  2. Select Add to ignored list and select the specific path or item.
  3. Select Apply rules to all workspaces to add the item to the ignored list in every workspace.
  4. Select OK.

Note: To configure the ignore files list, refer to filter pattern files in UVCS

Share ignore configuration

There are multiple ways you can share the ignore.conf file with your coworkers:

  • Add the ignore.conf file to the repository and check it in so that your coworkers recieve it when they next update their workspace.
  • Add the ignore.conf file to the plastic-global-config repository to deploy the file on every client.

Be aware of certain files and directories in Unity Editor projects that you might or might not want to ignore.

Directories to ignore

Unity recommends that you ignore all directories and files that automatically regenerate in you Unity project. For example, the Library and Temp directories are the most populated paths in your Unity project. They can hold thousands of files and weigh several GBs, and if you delete them, Unity creates them again.

Directories not to ignore

Don't add the following directories to your ignore file:

  • Assets directory
  • Project settings directory

Without these directories, your coworkers can't open the Unity project.

Example Unity ignore file

The following is an example of an ignore file that works with a Unity project:

#Common directories
Library
library
Temp
temp
Obj
obj
Build
build
Builds
builds
UserSettings
usersettings
MemoryCaptures
memorycaptures
Logs
logs
**/Assets/AssetStoreTools
**/assets/assetstoretools
**/Assets/AddressableAssetsData/*/*.bin*
**/assets/addressableassetsdata/*/*.bin*
**/Assets/StreamingAssets/aa.meta
**/assets/streamingassets/*/aa/*
.collabignore

# Builds
*.apk
*.unitypackage

#Plastic SCM related
/ignore.conf
*.private
*.private.meta
^*.private.[0-9]+$
^*.private.[0-9]+.meta$

# Gradle cache directory
.gradle

# Autogenerated project files
/Assets/Plugins/Editor/JetBrains*
/assets/Plugins/Editor/JetBrains*
.vs
ExportedObj
.consulo
*.csproj
*.unityproj
*.sln
*.suo
*.tmp
*.user
*.userprefs
*.pidb
*.booproj
*.svd
*.pdb
*.mdb
*.opendb
*.VC.db

# Unity3D generated meta files
*.pidb.meta
*.pdb.meta
*.mdb.meta

# Unity3D Generated File On Crash Reports
sysinfo.txt

# Crashlytics generated file
crashlytics-build.properties

#Mac
.DS_Store*
Thumbs.db
Desktop.ini