{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://catalog.lintel.tools/schemas/schemastore/uet-buildconfig-json/_shared/latest--2024.1338.318.json", "description": "Represents a build configuration for UET, which can be used to specify how to build an Unreal Engine plugin or project, or Unreal Engine itself.", "x-lintel": { "source": "https://raw.githubusercontent.com/RedpointGames/uet-schema/main/2024.1338.318.json", "sourceSha256": "7b6b0eb9f0c62b87e700d6c5e46a47c4c47554c3c21e96fd604173c3678cf11a" }, "type": "object", "properties": { "$schema": true, "Type": { "description": "Specifies the type of thing that this BuildConfig.json file builds, such as whether this is for building a plugin, project or Unreal Engine itself.", "enum": [ "Project", "Plugin", "Engine" ] } }, "required": [ "Type" ], "allOf": [ { "if": { "properties": { "Type": { "const": "Project" } } }, "then": { "properties": { "Distributions": { "description": "A list of distributions.", "type": "array", "items": { "type": "object", "description": "Specifies how to build, cook, test and deploy an Unreal Engine project.", "properties": { "Name": { "description": "The name, as passed to the --distribution argument.", "type": "string" }, "FolderName": { "description": "The relative path that the .uproject file is located underneath.", "type": "string" }, "ProjectName": { "description": "The name of the .uproject file underneath the folder, without the .uproject extension.", "type": "string" }, "Prepare": { "description": "Specifies the preparation scripts to run before various steps. You can specify multiple preparation entries.", "type": "array", "items": { "type": "object", "description": "A dynamically driven preparation, test or deployment step.", "properties": { "Name": { "description": "The name of the job/step as it would be displayed on a build server. This must be unique amongst all tests defined.", "type": "string" }, "Manual": { "description": "If set, this will be emitted as a manual job on build servers. Only applies to deployments. Defaults to false.", "type": "boolean" }, "Type": { "enum": [ "Predefined" ] } }, "required": [ "Name" ], "allOf": [ { "if": { "properties": { "Type": { "const": "Predefined" } } }, "then": { "required": [ "Predefined" ], "properties": { "Predefined": { "type": "string", "description": "The predefined name defined earlier in configuration." } }, "type": "object" } } ] } }, "Build": { "type": "object", "properties": { "Editor": { "type": "object", "properties": { "Target": { "description": "The editor target to build.", "type": "string" } }, "additionalProperties": false }, "Game": { "type": "object", "properties": { "Targets": { "description": "A list of targets to build.", "type": "array", "items": { "description": "A list of targets to build.", "type": "string" } }, "Platforms": { "description": "A list of platforms to build the project for.", "type": "array", "items": { "type": "object", "properties": { "Platform": { "description": "The platform name to build the project for.", "type": "string" }, "CookFlavors": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "array", "items": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "string" } } }, "additionalProperties": false } }, "Configurations": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "array", "items": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "string" } } }, "additionalProperties": false }, "Client": { "type": "object", "properties": { "Targets": { "description": "A list of targets to build.", "type": "array", "items": { "description": "A list of targets to build.", "type": "string" } }, "Platforms": { "description": "A list of platforms to build the project for.", "type": "array", "items": { "type": "object", "properties": { "Platform": { "description": "The platform name to build the project for.", "type": "string" }, "CookFlavors": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "array", "items": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "string" } } }, "additionalProperties": false } }, "Configurations": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "array", "items": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "string" } } }, "additionalProperties": false }, "Server": { "type": "object", "properties": { "Targets": { "description": "A list of targets to build.", "type": "array", "items": { "description": "A list of targets to build.", "type": "string" } }, "Platforms": { "description": "A list of platforms to build the project for.", "type": "array", "items": { "type": "object", "properties": { "Platform": { "description": "The platform name to build the project for.", "type": "string" }, "CookFlavors": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "array", "items": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "string" } } }, "additionalProperties": false } }, "Configurations": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "array", "items": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false }, "Tests": { "description": "A list of tests to run for the project.", "type": "array", "items": { "type": "object", "description": "A dynamically driven preparation, test or deployment step.", "properties": { "Name": { "description": "The name of the job/step as it would be displayed on a build server. This must be unique amongst all tests defined.", "type": "string" }, "Manual": { "description": "If set, this will be emitted as a manual job on build servers. Only applies to deployments. Defaults to false.", "type": "boolean" }, "Type": { "enum": [ "Predefined" ] } }, "required": [ "Name" ], "allOf": [ { "if": { "properties": { "Type": { "const": "Predefined" } } }, "then": { "required": [ "Predefined" ], "properties": { "Predefined": { "type": "string", "description": "The predefined name defined earlier in configuration." } }, "type": "object" } } ] } }, "Deployment": { "description": "A list of deployments to run for the project.", "type": "array", "items": { "type": "object", "description": "A dynamically driven preparation, test or deployment step.", "properties": { "Name": { "description": "The name of the job/step as it would be displayed on a build server. This must be unique amongst all tests defined.", "type": "string" }, "Manual": { "description": "If set, this will be emitted as a manual job on build servers. Only applies to deployments. Defaults to false.", "type": "boolean" }, "Type": { "enum": [ "Predefined" ] } }, "required": [ "Name" ], "allOf": [ { "if": { "properties": { "Type": { "const": "Predefined" } } }, "then": { "required": [ "Predefined" ], "properties": { "Predefined": { "type": "string", "description": "The predefined name defined earlier in configuration." } }, "type": "object" } } ] } }, "MobileProvisions": { "description": "A list of mobile provisions to install to the local machine before building this project.", "type": "array", "items": { "type": "object", "properties": { "BundleIdentifierPattern": { "type": "string" }, "PrivateKeyPasswordlessP12Path": { "type": "string" }, "CertificateSigningRequestPath": { "type": "string" }, "MobileProvisionPath": { "type": "string" }, "AppleProvidedCertificatePath": { "type": "string" }, "KeychainPasswordEnvironmentVariable": { "type": "string" } }, "required": [ "PrivateKeyPasswordlessP12Path", "CertificateSigningRequestPath", "MobileProvisionPath", "AppleProvidedCertificatePath" ], "additionalProperties": false } } }, "required": [ "Name", "FolderName", "ProjectName" ], "additionalProperties": false } } } } }, { "if": { "properties": { "Type": { "const": "Plugin" } } }, "then": { "properties": { "PluginName": { "description": "The name of your plugin. It must be such that \"PluginName/PluginName.uplugin\" exists.", "type": "string" }, "Copyright": { "type": "object", "properties": { "Header": { "description": "Used for Marketplace/Fab submissions and update-copyright command.", "type": "string" }, "ExcludePaths": { "description": "If set, these files will not have their headers updated during packaging.", "type": "array", "items": { "description": "If set, these files will not have their headers updated during packaging.", "type": "string" } } }, "additionalProperties": false }, "Tests": { "description": "A list of predefined tests that you can use with `uet test` or in other \"Tests\" sections for distributions.", "type": "array", "items": { "type": "object", "description": "A dynamically driven preparation, test or deployment step that is defined outside of a distribution, where dependencies need to be specified.", "properties": { "ShortName": { "description": "For tests defined outside of distributions, an optional shorter name that can be used with `uet test`.", "type": "string" }, "Dependencies": { "type": "object", "description": "Specifies how to how to package and build the plugin so this test can be run.", "properties": { "EnvironmentVariables": { "description": "A list of environment variables to set during the build.", "type": "object", "additionalProperties": { "description": "A list of environment variables to set during the build.", "type": "string" } }, "Build": { "type": "object", "properties": { "Editor": { "type": "object", "properties": { "Platforms": { "description": "A list of platforms to build the plugin for on the editor target.", "type": "array", "items": { "description": "A list of platforms to build the plugin for on the editor target.", "enum": [ "Win64", "Mac", "Linux" ] } } }, "additionalProperties": false }, "Game": { "type": "object", "properties": { "Platforms": { "description": "A list of platforms to build the plugin for on the target.", "type": "array", "items": { "type": "object", "properties": { "Platform": { "description": "The platform name to build the project for.", "type": "string" }, "CookFlavors": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "array", "items": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "string" } } }, "additionalProperties": false } }, "Configurations": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "array", "items": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "string" } } }, "additionalProperties": false }, "Client": { "type": "object", "properties": { "Platforms": { "description": "A list of platforms to build the plugin for on the target.", "type": "array", "items": { "type": "object", "properties": { "Platform": { "description": "The platform name to build the project for.", "type": "string" }, "CookFlavors": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "array", "items": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "string" } } }, "additionalProperties": false } }, "Configurations": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "array", "items": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "string" } } }, "additionalProperties": false }, "Server": { "type": "object", "properties": { "Platforms": { "description": "A list of platforms to build the plugin for on the target.", "type": "array", "items": { "type": "object", "properties": { "Platform": { "description": "The platform name to build the project for.", "type": "string" }, "CookFlavors": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "array", "items": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "string" } } }, "additionalProperties": false } }, "Configurations": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "array", "items": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "string" } } }, "additionalProperties": false }, "StrictIncludes": { "description": "Forces --strict-includes for builds.", "type": "boolean" } }, "additionalProperties": false }, "Package": { "type": "object", "properties": { "Type": { "description": "Defines the package type, such as whether it is being packaged for Marketplace or Fab submission. One of 'Generic', 'Marketplace' or 'Fab'. If not set, defaults to 'Generic'.", "enum": [ "Generic", "Marketplace", "Fab" ] }, "Marketplace": { "description": "DEPRECATED. Use the 'Type' setting instead.", "type": "boolean" }, "OutputFolderName": { "description": "If not set, defaults to \"Packaged\".", "type": "string" }, "Filter": { "description": "The path to the FilterPlugin.ini file used for packaging.", "type": "string" } }, "additionalProperties": false } }, "required": [ "Build", "Package" ], "additionalProperties": false }, "Name": { "type": "string" }, "Manual": { "type": "boolean" }, "Type": { "enum": [ "Predefined" ] } }, "required": [ "Name" ], "allOf": [ { "if": { "properties": { "Type": { "const": "Predefined" } } }, "then": { "required": [ "Predefined" ], "properties": { "Predefined": { "type": "string", "description": "The predefined name defined earlier in configuration." } }, "type": "object" } } ] } }, "Distributions": { "description": "A list of distributions.", "type": "array", "items": { "type": "object", "description": "Specifies how to build, package, test and deploy an Unreal Engine plugin.", "properties": { "Name": { "description": "The name, as passed to the --distribution argument.", "type": "string" }, "EnvironmentVariables": { "description": "A list of environment variables to set during the build.", "type": "object", "additionalProperties": { "description": "A list of environment variables to set during the build.", "type": "string" } }, "Clean": { "type": "object", "properties": { "Filespecs": { "description": "A list of filespecs that should be cleaned. Use * as a wildcard for a single path component, or ... as a wildcard for multiple path components.", "type": "array", "items": { "description": "A list of filespecs that should be cleaned. Use * as a wildcard for a single path component, or ... as a wildcard for multiple path components.", "type": "string" } } }, "additionalProperties": false }, "Prepare": { "description": "Specifies the preparation scripts to run before various steps. You can specify multiple preparation entries.", "type": "array", "items": { "type": "object", "description": "A dynamically driven preparation, test or deployment step.", "properties": { "Name": { "description": "The name of the job/step as it would be displayed on a build server. This must be unique amongst all tests defined.", "type": "string" }, "Manual": { "description": "If set, this will be emitted as a manual job on build servers. Only applies to deployments. Defaults to false.", "type": "boolean" }, "Type": { "enum": [ "Predefined" ] } }, "required": [ "Name" ], "allOf": [ { "if": { "properties": { "Type": { "const": "Predefined" } } }, "then": { "required": [ "Predefined" ], "properties": { "Predefined": { "type": "string", "description": "The predefined name defined earlier in configuration." } }, "type": "object" } } ] } }, "Build": { "type": "object", "properties": { "Editor": { "type": "object", "properties": { "Platforms": { "description": "A list of platforms to build the plugin for on the editor target.", "type": "array", "items": { "description": "A list of platforms to build the plugin for on the editor target.", "enum": [ "Win64", "Mac", "Linux" ] } } }, "additionalProperties": false }, "Game": { "type": "object", "properties": { "Platforms": { "description": "A list of platforms to build the plugin for on the target.", "type": "array", "items": { "type": "object", "properties": { "Platform": { "description": "The platform name to build the project for.", "type": "string" }, "CookFlavors": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "array", "items": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "string" } } }, "additionalProperties": false } }, "Configurations": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "array", "items": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "string" } } }, "additionalProperties": false }, "Client": { "type": "object", "properties": { "Platforms": { "description": "A list of platforms to build the plugin for on the target.", "type": "array", "items": { "type": "object", "properties": { "Platform": { "description": "The platform name to build the project for.", "type": "string" }, "CookFlavors": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "array", "items": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "string" } } }, "additionalProperties": false } }, "Configurations": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "array", "items": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "string" } } }, "additionalProperties": false }, "Server": { "type": "object", "properties": { "Platforms": { "description": "A list of platforms to build the plugin for on the target.", "type": "array", "items": { "type": "object", "properties": { "Platform": { "description": "The platform name to build the project for.", "type": "string" }, "CookFlavors": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "array", "items": { "description": "The flavors to cook an Android platform for. e.g. ASTC, DXT, ETC2, Multi.", "type": "string" } } }, "additionalProperties": false } }, "Configurations": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "array", "items": { "description": "If not specified, defaults to [\"Development\", \"Shipping\"].", "type": "string" } } }, "additionalProperties": false }, "StrictIncludes": { "description": "Forces --strict-includes for builds.", "type": "boolean" } }, "additionalProperties": false }, "Tests": { "description": "A list of tests to run for the plugin.", "type": "array", "items": { "type": "object", "description": "A dynamically driven preparation, test or deployment step.", "properties": { "Name": { "description": "The name of the job/step as it would be displayed on a build server. This must be unique amongst all tests defined.", "type": "string" }, "Manual": { "description": "If set, this will be emitted as a manual job on build servers. Only applies to deployments. Defaults to false.", "type": "boolean" }, "Type": { "enum": [ "Predefined" ] } }, "required": [ "Name" ], "allOf": [ { "if": { "properties": { "Type": { "const": "Predefined" } } }, "then": { "required": [ "Predefined" ], "properties": { "Predefined": { "type": "string", "description": "The predefined name defined earlier in configuration." } }, "type": "object" } } ] } }, "Package": { "type": "object", "properties": { "Type": { "description": "Defines the package type, such as whether it is being packaged for Marketplace or Fab submission. One of 'Generic', 'Marketplace' or 'Fab'. If not set, defaults to 'Generic'.", "enum": [ "Generic", "Marketplace", "Fab" ] }, "Marketplace": { "description": "DEPRECATED. Use the 'Type' setting instead.", "type": "boolean" }, "OutputFolderName": { "description": "If not set, defaults to \"Packaged\".", "type": "string" }, "Filter": { "description": "The path to the FilterPlugin.ini file used for packaging.", "type": "string" } }, "additionalProperties": false }, "Deployment": { "description": "Specifies the deployment steps.", "type": "array", "items": { "type": "object", "description": "A dynamically driven preparation, test or deployment step.", "properties": { "Name": { "description": "The name of the job/step as it would be displayed on a build server. This must be unique amongst all tests defined.", "type": "string" }, "Manual": { "description": "If set, this will be emitted as a manual job on build servers. Only applies to deployments. Defaults to false.", "type": "boolean" }, "Type": { "enum": [ "Predefined" ] } }, "required": [ "Name" ], "allOf": [ { "if": { "properties": { "Type": { "const": "Predefined" } } }, "then": { "required": [ "Predefined" ], "properties": { "Predefined": { "type": "string", "description": "The predefined name defined earlier in configuration." } }, "type": "object" } } ] } }, "Gauntlet": { "type": "object", "properties": { "ConfigFiles": { "description": "Configuration files to apply to the project that hosts Gauntlet tests.", "type": "array", "items": { "description": "Configuration files to apply to the project that hosts Gauntlet tests.", "type": "string" } } }, "required": [ "ConfigFiles" ], "additionalProperties": false }, "MobileProvisions": { "description": "A list of mobile provisions to install to the local machine before building.", "type": "array", "items": { "type": "object", "properties": { "BundleIdentifierPattern": { "type": "string" }, "PrivateKeyPasswordlessP12Path": { "type": "string" }, "CertificateSigningRequestPath": { "type": "string" }, "MobileProvisionPath": { "type": "string" }, "AppleProvidedCertificatePath": { "type": "string" }, "KeychainPasswordEnvironmentVariable": { "type": "string" } }, "required": [ "PrivateKeyPasswordlessP12Path", "CertificateSigningRequestPath", "MobileProvisionPath", "AppleProvidedCertificatePath" ], "additionalProperties": false } } }, "required": [ "Name" ], "additionalProperties": false } } }, "required": [ "PluginName" ], "type": "object" } }, { "if": { "properties": { "Type": { "const": "Engine" } } }, "then": { "properties": { "Distributions": { "description": "A list of distributions.", "type": "array", "items": { "type": "object", "properties": { "Name": { "type": "string" }, "Source": { "type": "object", "properties": { "Type": { "type": "string" }, "Repository": { "type": "string" }, "Ref": { "type": "string" }, "ConsoleZips": { "type": "array", "items": { "type": "string" } } }, "required": [ "Type", "Repository", "Ref" ], "additionalProperties": false }, "Build": { "type": "object", "properties": { "TargetTypes": { "type": "array", "items": { "type": "string" } }, "EditorPlatforms": { "type": "array", "items": { "type": "string" } }, "Platforms": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "Cook": { "type": "object", "properties": { "GenerateDDC": { "type": "boolean" } }, "additionalProperties": false }, "Deployment": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string" }, "Platform": { "type": "string" }, "Target": { "type": "string" } }, "additionalProperties": false } }, "MobileProvisions": { "type": "array", "items": { "type": "object", "properties": { "BundleIdentifierPattern": { "type": "string" }, "PrivateKeyPasswordlessP12Path": { "type": "string" }, "CertificateSigningRequestPath": { "type": "string" }, "MobileProvisionPath": { "type": "string" }, "AppleProvidedCertificatePath": { "type": "string" }, "KeychainPasswordEnvironmentVariable": { "type": "string" } }, "required": [ "PrivateKeyPasswordlessP12Path", "CertificateSigningRequestPath", "MobileProvisionPath", "AppleProvidedCertificatePath" ], "additionalProperties": false } } }, "additionalProperties": false } } } } } ] }