Skip to main content

manage_build

Auto-generated from the Python tool registry. Do not hand-edit outside <!-- examples:start --><!-- examples:end --> blocks — the generator (tools/generate_docs_reference.py) will overwrite them.

Group: core  ·  Module: services.tools.manage_build

Description

Manage Unity player builds — trigger builds, switch platforms, configure settings, manage build scenes and profiles, run batch builds across platforms. Actions: build, status, platform, settings, scenes, profiles, batch, cancel.

Parameters

NameTypeRequiredDescription
actionstryesAction: build, status, platform, settings, scenes, profiles, batch, cancel
targetstr | NoneBuild target: windows64, osx, linux64, android, ios, webgl, uwp, tvos, visionos
output_pathstr | NoneOutput path for the build
scenesstr | NoneJSON array of scene paths, or comma-separated paths
developmentstr | NoneDevelopment build (true/false)
optionsstr | NoneJSON array of BuildOptions: clean_build, auto_run, deep_profiling, compress_lz4, strict_mode, detailed_report
subtargetstr | NoneBuild subtarget: player or server
scripting_backendstr | NoneScripting backend: mono or il2cpp (persistent change)
profilestr | NoneBuild Profile asset path (Unity 6+ only)
propertystr | NoneSettings property: product_name, company_name, version, bundle_id, scripting_backend, defines, architecture
valuestr | NoneValue to set for the property (omit to read)
activatestr | NoneActivate a build profile (true/false)
targetsstr | NoneJSON array of targets for batch build
profilesstr | NoneJSON array of profile paths for batch build (Unity 6+)
output_dirstr | NoneBase output directory for batch builds
job_idstr | NoneJob ID for status/cancel

Returns

A dict containing the Unity response. The exact shape depends on the action.

Examples

No examples yet. Add usage examples here — they will be preserved across regenerations.