shown in other instead.
Startup Command-Line Options
To launch the Unigine executable file, it is necessary to specify a number of required options on its start-up. They control what rendering API to use, what resolution to set for Unigine window, where resources for initializing the engine are stored, etc. These parameters are either set in the browser or manually via the command line.
The syntax of command-line options is as follows: the full name of the binary executable (32- or 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 Unigine executable or data path, as indicated below).
|video_mode||Video mode to set window resolution or size||
-1 is video_width×video_height
0 is 640x360
1 is 960x540
2 is 1024x576
3 is 1280x720
4 is 1366x768
5 is 1600x900
6 is 1920x1080
7 is 2560x1440
8 is 640x400
9 is 960x600
10 is 1024x640
11 is 1280x800
12 is 1440x900
13 is 1680x1050
14 is 1920x1200
15 is 2560x1600
16 is 640x480
17 is 800x600
18 is 1024x768
19 is 1280x960
20 is 1280x1024
21 is 1600x1200
22 is 2048x1536
23 is 2560x2048
Makes sense only if video_mode=-1
Makes sense only if video_mode=-1
|video_resizable||Allows to change a window size on the fly, without having to restart the application||
0 is a non-resizable mode
1 is a resizable mode
0 is a windowed mode
1 is a fullscreen mode
2 is a fullwindow mode when an application window is rendered without decorations
|video_app||Graphics API to be used for rendering:
|video_vsync||Vertical synchronization (synchronize FPS with monitor's refresh rate)||
0 is not to use synchronization
1 is to use synchronization
|video_refresh||Graphics refresh rate||0–200||0|
|video_multisample||Hardware anti-aliasing mode||
0 is no anti-aliasing
1 is 2x anti-aliasing
2 is 4x anti-aliasing
3 is 8x anti-aliasing
4 is 16x anti-aliasing
|video_gamma||Gamma correction value||0.5–3.5||1.0|
|data_path||Path to the data directory with all resources (specified relative to the binary executable). This is a required command-line option.||../|
|extern_package||UNG or ZIP package outside data directory to be added to the file system. This allows to access resources by specifying a relative path to the file only inside the package. Several packages are comma separated (no whitespace).
The path can be specified relative to the binary executable or as an absolute path.
|extern_directory||A directory outside the data directory. The path can be specified relative to the binary executable or as an absolute path.||"../RELATIVE_PATH/"
|engine_config||The configuration file used to read and store all global engine-related and project-related settings (the path is specified relative to the binary executable)||unigine.cfg|
|engine_log||The log file to be created and used (the path is specified relative to the binary executable)||log.html|
|system_script||Path to the system script (specified relative to the data directory)||core/unigine.cpp|
|editor_script||Path to the editor script (specified relative to the data directory)||core/editor/editor.cpp|
|gui_path||A path to a GUI skin to be used for the engine interface.||core/gui/|
|project_name||Forces the engine to store all changing data (a log file, cache files and the configuration file) in the User profile rather than in a directory with binaries. For that, a directory will be created with a specified PROJECT_NAME.||PROJECT_NAME|
|console_command||Console command to be used at the engine start-up. Several commands can be separated using the && sequence.||"command <its arguments>"|
|extern_plugin||Load a plugin library (the path is specified relative to the binary executable).
|extern_define||Extern #DEFINE to be used.
|sound_app||Sound API to be used: