This page has been translated automatically.
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Usage Examples
API Reference
Integration Samples
Usage Examples
C++ Plugins
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1
This version of documentation is OUTDATED! Please switch to the latest one.

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.

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

To invoke the upgrade script, run at the command prompt as follows:

Shell commands OPTIONS

Command Line Options

The upgrade script recognizes the following command line options:

  • --help — show help message.
  • --target TARGET — target directory to be upgraded. The default is current directory.
  • --meshes MESHES — whether to run MeshImport tool or not. Possible values are: yes/no or 1/0. The default is 0.

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


  • To upgrade a Unigine-based project located in D:\my_project directory, type at the command prompt:
    Shell commands --target=D:\my_project
  • To upgrade a Unigine-based project, including its mesh files, run the upgrade script with the following options:
    Shell commands --target=D:\my_project --meshes yes
    The upgrade script calls the meshimport script, which recursively searches for *.mesh, *.smesh or *.sanim files in project folders and upgrades them.
Last update: 2017-07-03
Build: ()