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 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
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
Material Nodes Library
Miscellaneous
Input
Math
Textures
Art Samples
Tutorials

Content Migration

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

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

If your project contains at least one file with a higher version, upgrade to this version will be skipped, as the migration script would consider that the project is already upgraded to that version. Let's review an example case:

  • Your project is v. 2.11.
  • It contains a v. 2.12 node.
  • You plan to upgrade the project to 2.15.

When you start the upgrade process, the following will happen:

  • Upgrading to v. 2.12 is skipped as you have one v. 2.12 node, and the script assumes the whole project is already using this version.
  • Upgrading to v. 2.13 is successful.
  • Upgrading to v. 2.14 is successful.
  • Upgrading to v. 2.15 is successful.

Thus, for a correct migration, follow this recommendation: ensure that the project does not contain 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#

Warning
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".

Custom Base Materials Migration#

If you have custom-made base materials in your project, please read this passage carefully. Material texture declaration has changed with an argument renamed as follows: type -> source (this argument defines the type of the texture's source rather than the type of the texture itself).

Automatic migration in this case is not available. To migrate your custom base materials to 2.15 you should manually replace the type argument with source for every texture node in each custom base material file:

UNIGINE 2.14.1 UNIGINE 2.15
ULON
Texture2D screen_texture <type=procedural>
ULON
Texture2D screen_texture <source=procedural>

Object Water Global Migration#

Automatic migration doesn't update water. The Global Water object shall be created and customized manually from scratch. You can refer to the previously used settings in the Global Water node and material files — they are still available in the migrated project.

The updated water is not rendered limitlessly by default — if only a small part of water is rendered, check Visibility Distance for both water and camera.

Migration of Projects Based on IG Template#

The location of assets used in IG Template has changed:

UNIGINE 2.14.1 UNIGINE 2.15
%PROJECT%/data/ig %PROJECT%/ig_data/


When you migrate a project based on IG Template, a new folder with all the IG Template content is added automatically. However the old one won't be deleted because you might store extra data there. Please take care of these data, if any, and delete the /data/ig folder manually. Keeping this folder in the migrated project will cause errors and asset conflicts.

Warning
After migration, copy all modified and custom assets from /data/ig and delete this folder.

Migration of Projects Generated in Sandworm#

Successful automatic migration requires your Sandworm project to be located in the /data folder. If your Sandworm project is outside this folder, move it there or migrate manually.

Slots and Objects, which emerged in the latest release, will be created automatically during the migration, however, they will have autogenerated names. You can rename them manually for your convenience.

Buildings also migrate automatically: Tag becomes Slot and Floor Number TagFloor Attributes.

However, keep in mind that only the Sandworm project is migrated: already generated content, including materials and roofs, remains unchanged. If you want to update the exterior of autogenerated buildings, you need to regenerate the project.

If you have any unused filters in your project, which don't participate in the project generation process, they will not migrate to the new project and will be deleted.

Compression should be enabled manually for Landscape Terrain, if required.

Last update: 2021-12-13
Build: ()