This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Objects
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Art Samples
Tutorials

Version Control

Version Control Systems or VCS (Git, SVN, Perforce, Mercurial, Bazaar, CVS, TFS, etc.) are used to manage changes to code and data, and enable teams to coordinate their development efforts. To make tracking of changes efficient and reduce the amount of disk space required, you should know which files must be tracked by the VCS and which can be ignored.

Ignore List#

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
    Notice
    Add this folder to version control before updating the engine’s version or reconfiguring the project in SDK Browser to provide the updated bin to all developers.
  • data/microprofile_dump_html
  • junk
  • obj
  • source/x64
  • CMakeCache.txt
  • source/**/*.obj
  • unigine_editor.cfg
  • *.cache
  • *.modified
  • *.tlog

.gitignore
.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#

Add these entries to the common .gitignore specified above when developing projects based on C++ (CMake).

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

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

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

Add these entries to the common .gitignore specified above when developing projects based on C++ (Visual Studio 2015+).

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

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

Files and Folders to Add to Version Control#

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)
Last update: 2021-04-29
Build: ()