This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Basics
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API Reference
Animations-Related Classes
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
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Patching Project Files

Upgrading your project to a newer version may sometimes require changes to project files (such as adding new files) or source files (such as adding include directives). These changes are most commonly related to integrating new third-party libraries.

To save you from having to make these modifications manually, the SDK includes built-in functionality to assist with migration. When updating your project, you can select which files should be automatically patched.

By default, all files are selected for patching.

Manual Patching#

To upgrade the project or source files in the manual mode, do the following:

  1. Put the binary executable <UnigineSDK>/bin/usc_x64.exe to the <UnigineSDK>/utils/upgrade_project folder that contains the upgrade script.
    Notice
    Use usc_x64.exe from the SDK version you are migrating to.
  2. In the command prompt, run the upgrade.usc with the corresponding arguments.

The following arguments are available:

--project_path
Description:

Path to the project - the SDK version from which the project will be migrated is taken from this project.

Example:

usc_x64.exe upgrade.usc --project_path D:/SDK_Browser/projects/unigine_project/project_name_2_19_1.project

--vscode_paths
Description:

Path to the project - the SDK version from which the project will be migrated is taken from this project.

Example:

usc_x64.exe upgrade.usc --project_path D:/SDK_Browser/projects/unigine_project/project_name_2_19_1.project

--source_paths
Description:

Path to source files.

Example:

usc_x64.exe upgrade.usc --source_paths D:/SDK_Browser/projects/unigine_project/source

--csproj_path
Description:

Path to *.csproj files.

Example:

usc_x64.exe upgrade.usc --csproj_path D:/SDK_Browser/projects/unigine_project/source/unigine_project.csproj

--start_version
Description:
Set the SDK version from which the project will be migrated, if it can't be set by --project_path.
--skip_source_paths
Description:
C++ files won't be patched.
--skip_vscode_paths
Description:
VS Code files won't be patched.
--skip_csproj_path
Description:
*.csproj files won't be patched.

Here's an example with skipping several types of files:

Shell commands
usc_x64.exe upgrade.usc --project_path path/to/.project --skip_source_paths --skip_csproj_path

In this case, only VS Code files will be patched.

The information on this page is valid for UNIGINE 2.20 SDK.

Last update: 2025-06-17
Build: ()