Version Control

Updated: 2018-09-26

Bolt plugin files should be excluded from version control. This minimizes the size of your commits and keeps things cleaner.

If you're using a public repository for your project, you must exclude Bolt files with the instructions below. If you don't, you are effectively illegally redistributing Bolt online and breaking the Unity Asset Store EULA and ToS.

Excluding Files

To exclude files from your version control solution, the standard approach is to include a file that specifies which files and folder to exclude.

You should place this file at the root of the project folder, above the Assets folder.

  • If you are using Git, name this file .gitignore
  • If you are using Unity Collab, name this file .collabignore
  • If you are using Subversion, you will need to ignore the files manually

On Windows, creating files without a filename is forbidden in explorer. Follow these instructions to create the file.

Ignore File Template

This template will ignore all core Bolt files while preserving your project settings and variables. It also includes the standard Unity ignore directives for files that shouldn't be versioned.

The transient section can be commented on or off depending on your needs. If you're unsure, you can leave it enabled.

## Bolt

# Always exclude these files, because they are part of the plugin

Assets/Ludiq/Assemblies
Assets/Ludiq/Assemblies.meta
Assets/Ludiq/Ludiq
Assets/Ludiq/Ludiq.meta
Assets/Ludiq/*/LICENSES.txt
Assets/Ludiq/*/LICENSES.txt.meta
Assets/Ludiq/*/Documentation
Assets/Ludiq/*/Documentation.meta
Assets/Ludiq/*/IconMap
Assets/Ludiq/*/IconMap.meta
Assets/Ludiq/Ludiq.Core/DotNetDocumentation
Assets/Ludiq/Ludiq.Core/DotNetDocumentation.meta
Assets/Ludiq/*/*.root
Assets/Ludiq/*/*.root.meta

# Optionally exclude these transient (generated) files, 
# because they can be easily re-generated by the plugin

Assets/Ludiq/Bolt.Flow/Generated/UnitOptions.db
Assets/Ludiq/Bolt.Flow/Generated/UnitOptions.db.meta
Assets/Ludiq/Ludiq.Core/Generated/Property Providers
Assets/Ludiq/Ludiq.Core/Generated/Property Providers.meta

## Unity
# From: https://github.com/github/gitignore/blob/master/Unity.gitignore

[Ll]ibrary/
[Tt]emp/
[Oo]bj/
[Bb]uild/
[Bb]uilds/
Assets/AssetStoreTools*

# Visual Studio cache directory
.vs/

# Autogenerated VS/MD/Consulo solution and project files
ExportedObj/
.consulo/
*.csproj
*.unityproj
*.sln
*.suo
*.tmp
*.user
*.userprefs
*.pidb
*.booproj
*.svd
*.pdb
*.opendb

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

# Unity3D Generated File On Crash Reports
sysinfo.txt

# Builds
*.apk
*.unitypackage

Removing Ignored Files

If you previously committed files that should be exluded, you can use the following Git commands to create a commit that removes them:

git rm -r --cached . 
git add .
git commit -am "Remove ignored files"

If you had pushed these files to a public repository, this will not erase them from the commit history. Therefore, you would still be illegally redistributing the Bolt files. Either make your repository private or start a new repository with a fresh tree that never included the Bolt files.

Was this article helpful?
This article was helpful for 4 people.
Yes, helpful
No, not for me