Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and 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
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 project folders to upgrade the files located there. If the script fails to upgrade some files, it will generate an error log (errors.log file).

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

Usage

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

Notice
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 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
Notice
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.
  • --dry - a flag indicating that the original project files won't be changed during upgrading. It can be used for test launching of the upgrade script.

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

Examples

  • To upgrade a Unigine-based project located in D:\my_project directory, type at the command prompt:
    Shell commands
    usc_x64 upgrade.usc D:\my_project
  • To run test 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 --dry --log D:\my_project\log.html
Last update: 2017-12-21