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).

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

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

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:

usc_x* upgrade.usc DIR_0 DIR_1 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.

• 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