Version Control

In any project there are files and folders that are not subject to version control. These can be files created by the compiler, *.obj, *.tlog, or an output folder used to store binary executables.

The following files and folders in you project's root can be ignored, as they are generated automatically on your disk:

Common ignore list for every API and IDE#

.thumbnails
bin
data/microprofile_dump_html
junk
obj
source/x64
CMakeCache.txt
source/**/*.obj
unigine_editor.cfg
*.cache
*.modified
*.tlog

Additional ignore list for C++ (CMake) projects#

build-*
CMakeFiles
CMakeScripts
CMakeCache.txt
cmake_install.cmake
CMakeUserPresets.json
compile_commands.json
CTestTestfile.cmake

Additional ignore list for C++ (Visual Studio 2015+) projects#

.vs
*.vcxproj.user
*.VC.db
*.opendb
*.opensdf
*.pro.user
*.sdf
*.suo

The following files and folders should be subject to version control:

• data folder with all its contents

  Notice

  If you do not want to share the editor and application settings with other team members, add the following configuration files to .gitignore:

  • data/configs/unigine.user
  • data/configs/default.user
  • data/.editor2/*

• source folder contents except for the elements mentioned above

  Notice

  This folder is created only for projects that use C++ or C# API.

• *.cache files containing compiled shader cache

  Notice

  When team members develop a project using different GPUs or/and driver’s version for their machine configuration, it is better to add the shader cache files to .gitignore since these file will be recompiled by an end developer’s computer.
• *.project file (and *.csproj for C# projects)