Параметры командной строки при запуске
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. Параметры командной строки запуска можно указать при запуске исполняемого файла UNIGINE. Эти параметры определяют, какой API рендеринга использовать, какое разрешение установить для окна Unigine, где хранятся ресурсы для инициализации движка и т.д. Параметры задаются либо в UNIGINE SDK Browser , либо вручную через командную строку .
ПримечаниеIf no command-line options is specified, the options with default values will be used when launching the application. Если параметры командной строки не указаны, при запуске приложения будут использоваться параметры со значениями по умолчанию.
If no command-line options is specified, the options with default values will be used when launching the application. Если параметры командной строки не указаны, при запуске приложения будут использоваться параметры со значениями по умолчанию. 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. Синтаксис параметров командной строки следующий: сначала указывается полное имя двоичного исполняемого файла (64-разрядная версия для разработки или производственная версия), а затем параметры запуска.
Shell-команды
main_* -command argumentShell-команды
main_* -command "argument,argument"Shell-команды
main_* -console_command "command argument"All paths are specified as absolute or relative to the binary executable or the data directory. Все пути указаны как абсолютные или относительно двоичного исполняемого файла или каталога data.
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: Если одна и та же команда указана несколько раз, движком будет учтена только последняя команда. Например, в следующем случае движком будет использоваться только argument3:
Shell-команды
-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 SettingsНастройки видео#
Graphics SettingsНастройки графики#
| Имя | Описание | Аргументы | По умолчанию |
|---|---|---|---|
| -video_app | Graphics API to be used for rendering:
|
"null"
"auto" "direct3d11" or "dx" "opengl" or "gl" "direct3d12" or "dx12" "vulkan" or "vk" |
"auto" |
| -video_adapter | In case of several GPUs, allows selecting a GPU to be used.
Примечание
Available for DirectX only.В случае нескольких графических процессоров позволяет выбрать используемый графический процессор.
Available for DirectX only.Available for DirectX only.Примечание
Available for DirectX only. Доступно только для DirectX. |
The number of the GPU to be used. Номер используемого графического процессора. |
0 |
| -video_debug | Enables or disables the debug context of OpenGL or DirectX.
Примечание
Enabling the debug context may cause performance drop (~30-40%).Включает или отключает контекст отладки OpenGL или DirectX.
Enabling the debug context may cause performance drop (~30-40%).Enabling the debug context may cause performance drop (~30-40%).Примечание
Enabling the debug context may cause performance drop (~30-40%). Включение контекста отладки может привести к падению производительности (~ 30-40%). |
DirectX:
|
0 |
| -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).
Включает или отключает отладочные шейдеры для приложения независимо от типа сборки (debug или release). Этот параметр следует включить, если вы используете средства отладки графики (например, отладчик RenderDoc).
|
0 to disable debug shaders (release shaders are used)
1 to enable debug shaders0 отключить отладочные шейдеры (использутся релизные) 1 включить отладочные шейдеры |
0 |
| -video_quad_buffer | Enables or disables quad buffered stereo. Включает / отключает стерео с четырехкратной буферизацией . |
0 to disable quad buffering
1 to enable quad buffering 0 для отключения четырехъядерной буферизации 1, чтобы включить четырехкратную буферизацию |
0 |
| -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.Включает внеэкранный режим рендеринга для приложения, что позволяет запускать UNIGINE Engine в облаке и использовать мощные серверы (например, с целью создания фотореалистичных наборов данных для глубокого обучения и проверки алгоритмов ИИ). Все окна в этом режиме виртуальные, так же как и дисплей, пользовательский ввод недоступен. |
||
| -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.1 чтобы включить создание главного окна. 0 чтобы отключить создание главного окна. |
1 |
| -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.1 чтобы включить принудительное закрытие движка. Это значение должно быть установлено, когда в -main_window передается 0. 0 чтобы отключить принудительное закрытие движка. |
0 |
File SystemФайловая система#
| Имя | Описание | Аргументы | По умолчанию |
|---|---|---|---|
| -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. Путь к каталогу data со всеми ресурсами . Путь может быть указан как абсолютный путь или относительно двоичного исполняемого файла.
Указанный каталог -data_path можно получить с помощью функции getDataPath(). |
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. Путь к каталогу, содержащему плагины. Все плагины в этом каталоге будут загружены автоматически при запуске.
Путь может быть указан относительно двоичного исполняемого файла или как абсолютный путь. Список указанных каталогов -plugin_path можно получить с помощью методов getNumPluginPaths() и getPluginPath(int num). |
The arguments can be passed as follows:
|
plugins/ |
ПримечаниеUnlike other command-line options, the plugin_path option can accumulate all specified values. It allows specifying multiple paths, each of which will be used by the Engine. В отличие от других параметров командной строки, параметр plugin_path может накапливать все указанные значения. Он позволяет указать несколько путей, каждый из которых будет использоваться движком.
Unlike other command-line options, the plugin_path option can accumulate all specified values. It allows specifying multiple paths, each of which will be used by the Engine. В отличие от других параметров командной строки, параметр plugin_path может накапливать все указанные значения. Он позволяет указать несколько путей, каждый из которых будет использоваться движком. 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_PATHOther DataПрочие данные#
| Имя | Описание | Аргументы | По умолчанию |
|---|---|---|---|
| -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.Путь к стартовому файлу конфигурации, содержащему настройки запуска. Путь может быть указан как абсолютный путь или относительно -data_path. |
The arguments can be passed as follows:
|
configs/default.boot |
| -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. Примечание For this parameter to take effect you should either delete existing system and editor cache files or move them to the new specified location.Путь для хранения файлов кэша системы и редактора (указывается system_cache а также editor_cache соответственно). Путь может быть указан как абсолютный путь или относительно -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). Путь к файлу кеша, который будет использоваться UnigineEditor. Путь может быть указан как абсолютный путь или относительно -data_path, или к -cache_path (если есть). |
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). Путь к файлу кеша, который будет использоваться движком. Путь может быть указан как абсолютный путь или относительно -data_path, или к -cache_path (если есть). |
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). Файл журнала, который будет создан и использован. Путь может быть указан как абсолютный путь или относительно двоичного исполняемого файла. Для относительных путей, если установлено -project_name , файл журнала с указанным именем будет создан в соответствующем каталоге в профиле пользователя (будет использоваться только имя , оставшаяся часть относительного пути будет отброшена). |
log.txt | |
| -editor_script | Path to the editor script (specified relative to the data directory) Путь к скрипту редактора (указан относительно каталога data ) |
||
| -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. Путь к оболочке GUI, которая будет использоваться для интерфейса движка. Путь может быть указан как абсолютный путь или относительно -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 или путем к каталогу проекта относительно профиля пользователя (например, unigine_projects/my_project). |
PROJECT_NAME, namely:
C:/Users/<username>/my_project/
/home/<username>/.my_project/ Windows:Linux:A path to the project directory relative to the User profile. For example, -project_name unigine_projects/my_project will create my_project directory in the following directory:
C:/Users/<username>/unigine_projects/
/home/<username>/.unigine_projects/ Примечание
Windows:Linux:The specified unigine_projects folder must exist in the User profile.PROJECT_NAME, а именно:
The specified unigine_projects folder must exist in the User profile.The specified unigine_projects folder must exist in the User profile.
|
|
| -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.Движок игнорирует файл guids.db и ищет идентификаторы GUID среди всех файлов .meta внутри папки данных и всех смонтированных внешних каталогов и пакетов.
UnigineEditor uses this argument by default to avoid errors, and always re-generates the guids.db file to ensure its validity.UnigineEditor uses this argument by default to avoid errors, and always re-generates the guids.db file to ensure its validity.Примечание
UnigineEditor uses this argument by default to avoid errors, and always re-generates the guids.db file to ensure its validity. UnigineEditor использует этот аргумент по умолчанию, чтобы избежать ошибок, и всегда повторно генерирует файл guids.db, чтобы гарантировать его достоверность. |
Engine-Related SettingsНастройки, относящиеся к движку#
| Имя | Описание | Аргументы |
|---|---|---|
| -console_command | Console command to be used at the engine start-up. Several commands can be separated using the && sequence. Консольная команда для использования при запуске двигателя. Несколько команд можно разделить с помощью последовательности &&. |
command <arguments> |
| -console_history |
|
<path_to_file/console_history_file_name>
|
| -extern_plugin | Load a plugin library (the path is specified relative to the binary executable).
(For example, libNetwork_x64d.so should be passed as "Network".) Several plugins are comma separated (no whitespace).If you want to clear the list of plugins (they are automatically loaded by the engine once specified on the start-up), simply pass "" as an argument to this command. Загрузите библиотеку плагинов (путь указывается относительно исполняемого двоичного файла).
|
The arguments can be specified as follows:
|
| -extern_define | External definition to be used.
(For example, -extern_define "TEST=42" .) If you want to clear all definitions, simply pass "" as an argument to this command. 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.Включает инструмент Microprofile. |
1 to enable the Microprofile tool. 0 to disable the Microprofile tool.1 чтобы включить инструмент Microprofile. 0 чтобы отключить инструмент Microprofile. |
Sound SettingsНастройки звука#
| Имя | Описание | Аргументы | По умолчанию |
|---|---|---|---|
| -sound_app | Sound API to be used:
|
null
auto openal |
auto |
Последнее обновление:
19.04.2023
Помогите сделать статью лучше
Была ли эта статья полезной?
(или выберите слово/фразу и нажмите Ctrl+Enter