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.
Usage#
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:
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:
You can also specify only a particular folder inside the data folder, if necessary.
usc_x* upgrade.usc PATH_TO_DATA OPTIONS
- If the content to be upgraded is stored outside the data folder, you can specify the corresponding folders for the upgrade script:
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.
Examples#
- To upgrade content of a UNIGINE-based project located in D:\my_project directory, type at the command prompt:
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:
usc_x64 upgrade.usc D:\my_project\data --log D:\my_project\log.html
Last update:
2021-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)