FOnline Engine
Current master GitHub
Документация Docs/ru/reference/buildtools/commands.md

Команды BuildTools

Сгенерированный справочник. Не редактируйте эту страницу напрямую. Обновите BuildTools/buildtools.py, затем выполните python BuildTools/docs_cli.py --write.

Индекс справочника Команды Каноническая JSON-модель Контракт генерации

Запускайте команды из корня репозитория движка через python BuildTools/buildtools.py <command>. Точные блоки usage и справки ниже созданы исполняемым парсером.

env

Определить окружение BuildTools.

Стабильный ID: cli.buildtools.command.env

usage: buildtools.py env [-h] [--shell {bash,cmd,plain}] [--summary] [--summary-only]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
cli.buildtools.command.env.argument.shell --shell option нет 1 bash, cmd, plain plain Синтаксис вывода окружения.
cli.buildtools.command.env.argument.summary --summary option нет 0 - false Добавить сводку определённого окружения.
cli.buildtools.command.env.argument.summary_only --summary-only option нет 0 - false Вывести только сводку определённого окружения.

Точный вывод --help

usage: buildtools.py env [-h] [--shell {bash,cmd,plain}] [--summary] [--summary-only]

options:
  -h, --help            show this help message and exit
  --shell {bash,cmd,plain}
                        environment output syntax
  --summary             append the resolved environment summary
  --summary-only        print only the resolved environment summary

build

Настроить и собрать цель.

Стабильный ID: cli.buildtools.command.build

usage: buildtools.py build [-h] platform target [config]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
cli.buildtools.command.build.argument.platform platform positional да 1 - - Ключ платформы движка, например linux, win64, web или android-arm64.
cli.buildtools.command.build.argument.target target positional да 1 - - Профиль цели BuildTools, например client, server, baker или unit-tests.
cli.buildtools.command.build.argument.config config positional нет ? - Release Конфигурация сборки CMake.

Точный вывод --help

usage: buildtools.py build [-h] platform target [config]

positional arguments:
  platform    engine platform key, such as linux, win64, web, or android-arm64
  target      BuildTools target profile, such as client, server, baker, or unit-tests
  config      CMake build configuration

options:
  -h, --help  show this help message and exit

validate

Настроить и проверить сценарии.

Стабильный ID: cli.buildtools.command.validate

usage: buildtools.py validate [-h] names [names ...]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
cli.buildtools.command.validate.argument.names names positional да + - - Одно или несколько имён сценариев проверки.

Точный вывод --help

usage: buildtools.py validate [-h] names [names ...]

positional arguments:
  names       one or more named validation scenarios

options:
  -h, --help  show this help message and exit

setup-mono

Подготовить runtime Mono.

Стабильный ID: cli.buildtools.command.setup-mono

usage: buildtools.py setup-mono [-h] os_name arch config
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
cli.buildtools.command.setup-mono.argument.os_name os_name positional да 1 - - Ключ операционной системы runtime.
cli.buildtools.command.setup-mono.argument.arch arch positional да 1 - - Ключ архитектуры runtime.
cli.buildtools.command.setup-mono.argument.config config positional да 1 - - Конфигурация сборки runtime.

Точный вывод --help

usage: buildtools.py setup-mono [-h] os_name arch config

positional arguments:
  os_name     runtime operating-system key
  arch        runtime architecture key
  config      runtime build configuration

options:
  -h, --help  show this help message and exit

format-source

Форматировать исходники движка.

Стабильный ID: cli.buildtools.command.format-source

usage: buildtools.py format-source [-h]

У команды нет собственных аргументов.

Точный вывод --help

usage: buildtools.py format-source [-h]

options:
  -h, --help  show this help message and exit

toolset

Собрать существующую цель toolset.

Стабильный ID: cli.buildtools.command.toolset

usage: buildtools.py toolset [-h] target
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
cli.buildtools.command.toolset.argument.target target positional да 1 - - Цель из настроенного дерева сборки toolset.

Точный вывод --help

usage: buildtools.py toolset [-h] target

positional arguments:
  target      target from the configured toolset build tree

options:
  -h, --help  show this help message and exit

build-auxiliary

Собрать отдельно упаковываемый вспомогательный инструмент.

Стабильный ID: cli.buildtools.command.build-auxiliary

usage: buildtools.py build-auxiliary [-h] {effekseer-editor} [{Debug,Release}]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
cli.buildtools.command.build-auxiliary.argument.target target positional да 1 effekseer-editor - Собираемый вспомогательный инструмент.
cli.buildtools.command.build-auxiliary.argument.config config positional нет ? Debug, Release Release Конфигурация сборки (по умолчанию: Release).

Точный вывод --help

usage: buildtools.py build-auxiliary [-h] {effekseer-editor} [{Debug,Release}]

positional arguments:
  {effekseer-editor}  auxiliary tool to build
  {Debug,Release}     build configuration (default: Release)

options:
  -h, --help          show this help message and exit

prepare-workspace

Подготовить общие части рабочего каталога.

Стабильный ID: cli.buildtools.command.prepare-workspace

usage: buildtools.py prepare-workspace [-h] [--check] {toolset,emscripten,android-sdk,android-ndk,dotnet,xwin,wix,msan-libcxx} [{toolset,emscripten,android-sdk,android-ndk,dotnet,xwin,wix,msan-libcxx} ...]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
cli.buildtools.command.prepare-workspace.argument.parts parts positional да + toolset, emscripten, android-sdk, android-ndk, dotnet, xwin, wix, msan-libcxx - Подготавливаемые компоненты рабочего каталога.
cli.buildtools.command.prepare-workspace.argument.check --check option нет 0 - false Проверить доступность без установки или сборки.

Точный вывод --help

usage: buildtools.py prepare-workspace [-h] [--check] {toolset,emscripten,android-sdk,android-ndk,dotnet,xwin,wix,msan-libcxx} [{toolset,emscripten,android-sdk,android-ndk,dotnet,xwin,wix,msan-libcxx} ...]

positional arguments:
  {toolset,emscripten,android-sdk,android-ndk,dotnet,xwin,wix,msan-libcxx}
                        workspace components to prepare

options:
  -h, --help            show this help message and exit
  --check               check availability without installing or building

repair-checkout-case

Привести регистр имён элементов рабочего дерева в соответствие с индексом Git.

Стабильный ID: cli.buildtools.command.repair-checkout-case

usage: buildtools.py repair-checkout-case [-h] [--check]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
cli.buildtools.command.repair-checkout-case.argument.check --check option нет 0 - false Проверить расхождения регистра, не переименовывая элементы.

Точный вывод --help

usage: buildtools.py repair-checkout-case [-h] [--check]

options:
  -h, --help  show this help message and exit
  --check     check for case drift without renaming entries

package-web-debug

Упаковать локальный Web-клиент для отладки.

Стабильный ID: cli.buildtools.command.package-web-debug

usage: buildtools.py package-web-debug [-h] devname configs [configs ...]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
cli.buildtools.command.package-web-debug.argument.devname devname positional да 1 - - Краткое имя проекта для имён бинарных файлов и каталогов (например, LF).
cli.buildtools.command.package-web-debug.argument.configs configs positional да + - - Имена упаковываемых конфигураций (например, RemoteSceneLaunch LocalTest).

Точный вывод --help

usage: buildtools.py package-web-debug [-h] devname configs [configs ...]

positional arguments:
  devname     short project name for binary/directory naming (e.g. LF)
  configs     config names to package (e.g. RemoteSceneLaunch LocalTest)

options:
  -h, --help  show this help message and exit

package-android-debug

Упаковать локальный Android-клиент для отладки.

Стабильный ID: cli.buildtools.command.package-android-debug

usage: buildtools.py package-android-debug [-h] devname {android-arm32,android-arm64,android-x86} configs [configs ...]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
cli.buildtools.command.package-android-debug.argument.devname devname positional да 1 - - Краткое имя проекта для имён бинарных файлов и каталогов (например, LF).
cli.buildtools.command.package-android-debug.argument.platform platform positional да 1 android-arm32, android-arm64, android-x86 - Целевая платформа Android (например, android-arm64).
cli.buildtools.command.package-android-debug.argument.configs configs positional да + - - Имена упаковываемых конфигураций (например, LocalTest).

Точный вывод --help

usage: buildtools.py package-android-debug [-h] devname {android-arm32,android-arm64,android-x86} configs [configs ...]

positional arguments:
  devname               short project name for binary/directory naming (e.g. LF)
  {android-arm32,android-arm64,android-x86}
                        Android target platform (e.g. android-arm64)
  configs               config names to package (e.g. LocalTest)

options:
  -h, --help            show this help message and exit

host-check

Проверить зависимости host-системы.

Стабильный ID: cli.buildtools.command.host-check

usage: buildtools.py host-check [-h] {linux,macos,windows}
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
cli.buildtools.command.host-check.argument.host host positional да 1 linux, macos, windows - Проверяемая host-платформа.

Точный вывод --help

usage: buildtools.py host-check [-h] {linux,macos,windows}

positional arguments:
  {linux,macos,windows}
                        host platform to inspect

options:
  -h, --help            show this help message and exit

prepare-host-workspace

Подготовить рабочий каталог и зависимости host-системы.

Стабильный ID: cli.buildtools.command.prepare-host-workspace

usage: buildtools.py prepare-host-workspace [-h] [--check]
                                            {linux,windows,macos}
                                            [{common-packages,linux-packages,web-packages,android-packages,windows-cross-packages,msi-packages,all-packages,linux,web,android-arm32,android-arm64,android-x86,toolset,dotnet,windows-cross,wix,msan-libcxx,all} ...]
Стабильный ID Аргумент Вид Обязателен Значения Варианты По умолчанию Описание
cli.buildtools.command.prepare-host-workspace.argument.host host positional да 1 linux, windows, macos - Подготавливаемая host-платформа.
cli.buildtools.command.prepare-host-workspace.argument.features features positional нет * common-packages, linux-packages, web-packages, android-packages, windows-cross-packages, msi-packages, all-packages, linux, web, android-arm32, android-arm64, android-x86, toolset, dotnet, windows-cross, wix, msan-libcxx, all - Подготавливаемые группы возможностей; не указывайте их, чтобы использовать значения host-системы по умолчанию.
cli.buildtools.command.prepare-host-workspace.argument.check --check option нет 0 - false Проверить доступность без установки или сборки.

Точный вывод --help

usage: buildtools.py prepare-host-workspace [-h] [--check]
                                            {linux,windows,macos}
                                            [{common-packages,linux-packages,web-packages,android-packages,windows-cross-packages,msi-packages,all-packages,linux,web,android-arm32,android-arm64,android-x86,toolset,dotnet,windows-cross,wix,msan-libcxx,all} ...]

positional arguments:
  {linux,windows,macos}
                        host platform to prepare
  {common-packages,linux-packages,web-packages,android-packages,windows-cross-packages,msi-packages,all-packages,linux,web,android-arm32,android-arm64,android-x86,toolset,dotnet,windows-cross,wix,msan-libcxx,all}
                        feature groups to prepare; omit to use the host defaults

options:
  -h, --help            show this help message and exit
  --check               check availability without installing or building
Введите запрос.