Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Setting Up Development Environment
Usage Examples
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
Double Precision Coordinates
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes

Upgrade Script

UNIGINE upgrade script is a one-touch solution to upgrade data of a UNIGINE-based project to be consistent with updated engine builds.

The script recursively scans the project folders inside the data folder to upgrade the files located there. If the script fails to upgrade some files, it will generate an error log (errors.log file).

The same upgrade script is run when upgrading projects via UNIGINE SDK Browser.


The script is located in utils/Upgrade directory of UNIGINE SDK.

You need to properly set the development environment to get the script working.

To invoke the upgrade script, run upgrade.usc at the command prompt by using USC interpreter:

Shell commands
usc_x* upgrade.usc DIRS OPTIONS

  • If the content to be upgraded is stored only in the project's data folder, specify the path to this folder:
    Shell commands
    usc_x* upgrade.usc PATH_TO_DATA OPTIONS
    You can also specify only a particular folder inside the data folder, if necessary.
  • If the content to be upgraded is stored in external directories (several data_path options are specified on the project start-up), you can specify them for the upgrade script:
    Shell commands
    usc_x* upgrade.usc DIR_0 DIR_1 OPTIONS
    If you need to upgrade several projects, you should run the upgrade script for each of them separately.

Command Line Options

The upgrade script recognizes the following command line options:

  • --log - a path to the log file. If the option isn't specified, the log will be printed to the command prompt only.

If no options are set, the script will start upgrading with the default values.


  • To upgrade content of a UNIGINE-based project located in D:\my_project directory, type at the command prompt:
    Shell commands
    usc_x64 upgrade.usc D:\my_project\data
  • To run content upgrading of a UNIGINE-based project and save the log data into a file, run the upgrade script as follows:
    Shell commands
    usc_x64 upgrade.usc  D:\my_project\data --log D:\my_project\log.html
Last update: 2018-06-04