A game about forced loneliness, made by TACStudios
1# Version control systems
2
3To avoid any problems with automatically generated files, exclude some Visual Scripting files from your version control solution.
4
5To exclude files from version control, include a file or configure your settings to specify which files and folders to exclude:
6
71. Create a new file at the root of your project directory.
8
9 >[!TIP]
10 > The root of your project directory is at the level above your **Assets** folder.
11
122. Name the file based on your chosen version control system:
13
14 - **Git**: `.gitignore`. For more information, see [Git's documentation on gitignore](https://git-scm.com/docs/gitignore).
15
16 - **Unity Collab**: `.collabignore`. For more information, see the [Unity User Manual](https://docs.unity3d.com/Manual/UnityCollaborateIgnoreFiles.html).
17
18 - **Subversion**: Ignore the files from your `svn:ignore` property or runtime configuration options. For more information, see Subversion's documentation on [Ignoring Unversioned Items](https://svnbook.red-bean.com/en/1.7/svn.advanced.props.special.ignore.html).
19
203. Open the file in a text editor.
21
224. Add the appropriate files or file patterns to your ignore file or configuration. For an example and more information, see [Ignore file template](#ignore-file-template).
23
24> [!NOTE]
25> If you have an issue when you try to create a `.gitignore` file on Windows, refer to Microsoft's documentation on [how to create a .gitignore file from the command line](https://docs.microsoft.com/en-us/azure/devops/repos/git/ignore-files?view=azure-devops&tabs=command-line#create-a-gitignore).
26
27## Ignore file template
28
29The following template ignores all core Visual Scripting files, but preserves your project settings and variables. It also includes the standard Unity ignore directives for files that you can exclude from version control. For more information, see the `Unity.gitignore` file included in [GitHub's gitignore template repository](https://github.com/github/gitignore/blob/master/Unity.gitignore).
30
31Refer to the comments in the template for which lines to comment or remove.
32
33```
34 # Optionally exclude these transient (generated) files,
35 # because they can be easily re-generated by the package
36
37 Assets/Unity.VisualScripting.Generated/VisualScripting.Flow/UnitOptions.db
38 Assets/Unity.VisualScripting.Generated/VisualScripting.Flow/UnitOptions.db.meta
39 Assets/Unity.VisualScripting.Generated/VisualScripting.Core/Property Providers
40 Assets/Unity.VisualScripting.Generated/VisualScripting.Core/Property Providers.meta
41
42 ## Unity
43 # From: https://github.com/github/gitignore/blob/master/Unity.gitignore
44
45 /[Ll]ibrary/
46 /[Tt]emp/
47 /[Oo]bj/
48 /[Bb]uild/
49 /[Bb]uilds/
50 /[Ll]ogs/
51 /[Uu]ser[Ss]ettings/
52
53 # MemoryCaptures can get excessive in size.
54 # They also could contain extremely sensitive data
55 /[Mm]emoryCaptures/
56
57 # Asset meta data should only be ignored when the corresponding asset is also ignored
58 !/[Aa]ssets/**/*.meta
59
60 # Uncomment this line if you want to ignore the asset store tools plugin
61 # /[Aa]ssets/AssetStoreTools*
62
63 # Autogenerated Jetbrains Rider plugin
64 /[Aa]ssets/Plugins/Editor/JetBrains*
65
66 # Visual Studio cache directory
67 .vs/
68
69 # Gradle cache directory
70 .gradle/
71
72 # Autogenerated VS/MD/Consulo solution and project files
73 ExportedObj/
74 .consulo/
75 *.csproj
76 *.unityproj
77 *.sln
78 *.suo
79 *.tmp
80 *.user
81 *.userprefs
82 *.pidb
83 *.booproj
84 *.svd
85 *.pdb
86 *.opendb
87 *.VC.db
88
89 # Unity3D generated meta files
90 *.pidb.meta
91 *.pdb.meta
92 *.mdb.meta
93
94 # Unity3D Generated File On Crash Reports
95 sysinfo.txt
96
97 # Builds
98 *.apk
99 *.aab
100 *.unitypackage
101
102 # Crashlytics generated file
103 crashlytics-build.properties
104
105 # Packed Addressables
106 /[Aa]ssets/[Aa]ddressable[Aa]ssets[Dd]ata/*.*.bin*
107
108 # Temporary auto-generated Android Assets
109 /[Aa]ssets/[Ss]treamingAssets/aa.meta
110 /[Aa]ssets/[Ss]treamingAssets/aa/*
111
112```
113
114## Remove previously committed files
115If you committed any files to a version control solution that you want to exclude:
116
117- See Git's documentation on [the `git-rm` command](https://git-scm.com/docs/git-rm).
118- See Subversion's documentation on [the `svn delete` command](https://svnbook.red-bean.com/en/1.6/svn.ref.svn.c.delete.html).