Allows you to build Unreal Engine projects
Adds an UnrealEngine build step
@see UnrealEngine
Engine detection mode
Command to run
Select a single build target or list multiple required targets separated by "+".
This option should be used for projects with multiple targets of identical types.
Set this parameter to `skipCook()` to skip the project cook stage of a build.
Set this parameter to `skipStage` to skip project staging
(the build phase that places the executables and the content of the build in a stage directory).
Allows you to put all assets into a single ".pak" file instead of copying individual files.
This approach reduces the number of transferred files that benefits projects with a large amount of asset files.
The default value is "true".
Allows you to compress the build content. File compression decreases the deployment size, but may increase the loading time.
The default value is "true".
Specifies whether to include an installer for packaged game prerequisites
(such as redistributable operating system components) on supported platforms.
The default value is "true".
"
A package for the target platform. The default value is "true".
Set this parameter to `skipArchive` to prevent TeamCity from putting this build in the archive directory.
Specifies whether rendering is disabled. The default value is "true".
Use `runAutomationTests` option instead
Specifies whether rendering is disabled. The default value is "true".
Specify additional command line arguments.
Runs the specified "foo-project/build.xml" BuildGraph script located in the root of a checkout directory,
executing the node "BuildProject" in a distributed fashion (converting graph of nodes into a proper TeamCity build chain).
It also parses all the badges defined in the script and posts their status to the specified metadata server
(http://localhost:1111/ugs-metadata-server).
The root folder that contains "Engine" is expected to be located within the "engine-root"
folder of a checkout directory. Essentially, it assumes that the engine is in the source code.
unrealEngine {
engineDetectionMode = manual {
rootDir = "engine-root"
}
command = buildGraph {
script = "foo-project/build.xml"
targetNode = "BuildProject"
options = """
Option1=Value1
Option2=Value2
""".trimIndent()
executionMode = distributed {
badges = enableBadges {
metadataServer = "http://localhost:1111/ugs-metadata-server"
}
}
}
}
Runs a bunch of tests within the specified "foo.uproject" project while disabling rendering.
These tests include all those starting from "JsonConfig" and also include the "Input.Triggers.Released" test.
unrealEngine {
engineDetectionMode = automatic {
identifier = "5"
}
command = runAutomationTests {
project = "foo.uproject"
execCommand = runTests {
tests = """
StartsWith:JsonConfig
Input.Triggers.Released
""".trimIndent()
}
nullRHI = true
}
additionalArguments = "-utf8output -buildmachine -unattended -noP4 -nosplash -stdout -NoCodeSign"
}
Runs BuildCookRun with the specified options.
unrealEngine {
engineDetectionMode = automatic {
identifier = "5.3"
}
command = buildCookRun {
project = "foo.uproject"
buildConfiguration = standaloneGame {
configurations = "Development+Shipping"
platforms = "Mac"
}
cook = cookConfiguration {
maps = "FooMap+BarMap"
cultures = "FooCulture+BarCulture"
unversionedContent = true
}
stage = stageConfiguration {
directory = "./staged"
}
packageProject = true
pak = true
compressed = true
prerequisites = true
archive = archiveConfiguration {
directory = "./archived"
}
}
additionalArguments = "-utf8output -buildmachine -unattended -noP4 -nosplash -stdout -NoCodeSign"
}
Runs a commandlet to compile all blueprints in a native project "Cropout"
(only the project name is specified, not the full path)
using the command-line version of the Unreal Editor.
unrealEngine {
engineDetectionMode = manual {
rootDir = "engine-root"
}
command = runCommandlet {
editorExecutable = "UnrealEditor-Cmd"
project = "Cropout"
commandlet = "CompileAllBlueprints"
arguments = "-DirtyOnly"
}
additionalArguments = "-buildmachine -unattended"
}
Build feature example.
Adds build status publication to the specified UGS metadata server.
Note that this is only applicable for Perforce VCS roots, all other VCS roots will be ignored.
buildType {
// Other Build Type settings ...
features {
// Other Build Features ...
commitStatusPublisher {
vcsRootExtId = "${<VCS root object>.id}" // optional, publishes for all attached VCS roots if omitted
publisher = ugsMetadataServer {
serverUrl = "http://metadata-server"
badge = "Foo Badge"
project = "//depot/stream/Project"
}
}
}
}