UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
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 Migration

You can upgrade content of your project to UNIGINE 2.12 in the automatic or manual mode.

Warning
You cannot migrate the project that contains assets with a version higher than the project version.

Automatic Upgrade#

Automatic upgrade of the project's content can be performed via UNIGINE SDK Browser.

Notice
By default, the automatic mode is used to upgrade only binary executable files and content stored in the project's data folder. If you have content stored outside the data folder or in the additional data folders, you will have to upgrade it manually.

As a result, the binary executable and configuration files, meshes, terrains, worlds, nodes, splines, materials, properties, tracks, settings files will be upgraded to new formats (if any). The <unigine_project>/migration.log.html log file will be opened in the web browser. However, you can uncheck Migrate Content during automatic upgrading and perform content upgrading manually. In this case, only binary executable files will be upgraded.

Notice
The migration results depend on the version of UNIGINE SDK, from which you are going to migrate.

Manual Upgrade#

This mode should be used to upgrade content stored outside the project's data folder (such as mount points):

To upgrade the project's content in the manual mode, do the following:

  1. Put the binary executable <UnigineSDK>/bin/usc_x64.exe to the <UnigineSDK>/utils/upgrade 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 required options:
    Shell commands
    usc_x64.exe upgrade.usc path/to/additional_content_1 path/to/additional_content_2 ...
    If you have unchecked Migrate Content during automatic upgrading, add the path to the project's data folder to the list of arguments passed to the upgrade script. For example:
    Shell commands
    usc_x64.exe upgrade.usc <unigine_project>/data path/to/additional_content_1 path/to/additional_content_2 ...
    Here:
    • path/to/additional_content_* - paths to folders with content stored outside the data folder.
As a result, you will get your meshes, terrains, worlds, nodes, splines, materials, properties, tracks, configuration and settings files upgraded.

Notice
The migration results depend on the version of UNIGINE SDK, from which you are going to migrate.

As soon as migration is completed, run the Editor to have the project assets "indexed".

Particle System Material#

Automatic migration covers most of the aspects for the particles_base material. However, in case the Emission parameter was enabled in the parent material but was not overridden in the child material - this parameter should be migrated manually as follows:

  • Copy the Diffuse (Albedo) texture of the particles to the Emission texture field.
  • Copy Diffuse (Albedo) Color value to the Emission Color field.

The Attenuation texture was removed, as now this functionality is controlled via Curves. Automatic migration is not possible in this case. So, you should manually adjust particles attenuation via the new Curve-controlled Albedo texture, which enables you to adjust color changes as well.

Configuration files#

All global engine-related and project-related settings previously stored in the unigine.cfg file in the bin folder of your project, are now stored in separate files inside the data/configs.

The content of the bin folder cannot be migrated. To perform migration you should move the abovementioned configuration file to the data folder.

Using old-style configuration files may result in various issues or even crash the Engine.

Last update: 2020-07-28