shown in other instead.
Startup Command-Line Options
Startup command-line options can be specified on the UNIGINE executable file launching. These options control what rendering API to use, what resolution to set for Unigine window, where resources for initializing the engine are stored, etc. The options are either set in UNIGINE SDK Browser or manually via the command line.
The syntax of command-line options is as follows: the full name of the binary executable (64-bit development or production version) is specified first and then the start-up options.
main_* -command argument
main_* -command "argument,argument"
main_* -console_command "command argument"
All paths are specified as absolute or relative to the binary executable or the data directory.
If the same command is specified multiple times, only the last command will be taken into account by the engine. For example, in the following case, only the argument3 will be used by the Engine:
-command "argument1" -command "argument2" -command "argument3"
- An exception is file system command-line options: they can accumulate all the specified values.
- The CLI options specified on the application start-up always take precedence over the ones stored in the configuration files. Some of the CLI options can be changed through the console. Such options are automatically stored in the configuration files (this way, after the application is quit, they will be restored on the next start-up). All other CLI options don't change the configuration files.
|-video_app||Graphics API to be used for rendering:
"direct3d11" or "dx"
"opengl" or "gl"
"direct3d12" or "dx12"
"vulkan" or "vk"
|-video_adapter||In case of several GPUs, allows selecting a GPU to be used.
Available for DirectX only.
|The number of the GPU to be used.||0|
Enables or disables the debug context.
Enabling the debug context may cause performance drop (~30-40%).
|-video_debug_shader||Enables or disables debug shaders for the application regardless of its binary type (debug or release). This option should be enabled in case you use graphics debugging tools (e.g., the RenderDoc debugger).||0 to disable debug shaders (release shaders are used)
1 to enable debug shaders
|-video_quad_buffer||Enables or disables quad buffered stereo.||0 to disable quad buffering
1 to enable quad buffering
|-video_offscreen||Enables the offscreen mode for the application, making it possible to run UNIGINE Engine in a cloud and use powerful servers (e.g., to generate photorealistic datasets for deep learning and verification of AI algorithms). All windows in this mode are virtual, just like the display, user input is not available.|
|-main_window||Enables creating a main window during the application start-up. After starting up the application any window can be created and will work normally. For example, this can be useful in a custom editor or any other application, where there should be no main Engine window.||1 to enable creating a main window.
0 to disable creating a main window.
|-auto_quit||Enables force closing of the Engine when all windows are closed.||1 to enable force closing of the Engine. This value should be set when 0 is passed to -main_window.
0 to disable force closing of the Engine.
|-data_path||A path to the data directory with all resources. The path can be specified as an absolute path or relatively to the binary executable. The specified -data_path directory can be obtained via the getDataPath() function.||The argument can be passed as follows:
|-plugin_path||Path to a directory that contains plugins. All of the plugins in this directory will be loaded automatically on the start-up. The path can be specified relatively to the binary executable or as an absolute path. The list of the specified -plugin_path directories can be obtained via the getNumPluginPaths() and getPluginPath(int num) methods.||The arguments can be passed as follows:
For several directories or packages you should specify each item separately without commas, for example:
-plugin_path ../RELATIVE_PATH_1/ -plugin_path ../RELATIVE_PATH_2/ -plugin_path ABSOLUTE_PATH
|-boot_config||Path to Startup Configuration File containing the engine start-up options. The path can be specified as an absolute path or relative to the -data_path or <project_name> folder if the -project_name is set.||The arguments can be passed as follows:
|-cache_path||A path to store system and editor cache files (specified by system_cache and editor_cache respectively). The path can be specified as an absolute path or relatively to the -data_path.||data/|
|-editor_cache||A path to a cache file to be used by the UnigineEditor. The path can be specified as an absolute path or relatively to the -data_path, or to the -cache_path (if any).||editor.cache|
|-system_cache||A path to a cache file to be used by the Engine. The path can be specified as an absolute path or relatively to the -data_path, or to the -cache_path (if any).||unigine.cache|
|-engine_log||The log file to be created and used. The path can be specified as an absolute path or relatively to the binary executable. For relative paths, if the -project_name is set, the log file with the specified name will be created in the corresponding directory in the User profile (only the name will be used, the remaining part of the relative path will be discarded).||log.txt|
|-gui_path||A path to a GUI skin to be used for the engine interface. The path can be specified as an absolute path or relatively to the -data_path.||core/gui/|
|-project_name||Forces the engine to store all changing data (a log file, cache files and configuration files) in the User profile rather than in a directory with binaries. For that, a directory will be created with a specified PROJECT_NAME or a path to the project directory relative to the User profile (for example, unigine_projects/my_project).||PROJECT_NAME, namely:
|-system_script||Path to the system script (specified relative to the data directory).||core/unigine.usc|
|-skip_guidsdb||The Engine ignores the guids.db file and searches for GUIDs among all .meta files inside the data folder and all mounted external directories and packages.
UnigineEditor uses this argument by default to avoid errors, and always re-generates the guids.db file to ensure its validity.
|-console_command||Console command to be used at the engine start-up. Several commands can be separated using the && sequence.||command <arguments>|
Sets the path to the file that stores the console command input history. The path to the file and its name should be specified.
If the path to the file is not specified, the file will be searched in directories the following sequence:
If the file name is also not specified, the file with the default name console_history will be searched in the above-mentioned order.
(the default is "bin/console_history")
|-extern_plugin||Load a plugin library (the path is specified relative to the binary executable).
||The arguments can be specified as follows:
External definition to be used.
Affects UnigineScript only.
The current value of -extern_define can be obtained via the getExternDefine() method of Unigine API.
|The arguments can be specified as follows:
|-microprofile_enabled||Enables the Microprofile tool.||1 to enable the Microprofile tool.
0 to disable the Microprofile tool.
|-sound_app||Sound API to be used:
|-vr_app||VR to be used: