Skip to content

Automation tool.md

Latest commit

 

History

History
42 lines (36 loc) · 2.29 KB

Automation tool.md

File metadata and controls

42 lines (36 loc) · 2.29 KB

2020-08-27_20:25:41

Automation Tool

A program used for automating Unreal Engine related tasks such as building, cooking, packaging, automation tests, … Not for doing stuff inside the editor. Use Editor Scripting for that. Automation tasks are written in C#. Automation tasks are stored in .Automation.csproj projects. Automation tasks are implemented as classes deriving from BuildCommand. Automation tasks are run from the command line, from the Engine/Build/BatchFiles directory. Run the task with ./RunUAT.sh <COMMAND> where <COMMAND> is the name of the class inheriting from BuildCommand. Arguments can be passed to the command by adding -<PARAMETER> after the name. Multiple commands can be queued from the same command line. Parameters bind to the closest command to the left. ./RunUAT.sh Command1 -Arg1 -Arg2 Command2 -Arg1 -Arg2 Global options:

  • -Help: Print help either for the command the parameter is passed to, or for AutomationTool in general if there is no command to the left of -Help.
  • -List: List the available commands.
  • -Submit: Allow file submit. No idea what this means. Submit to version control? To a build process? To some server somewhere?
  • -NoCompile: Disable compilation of .Automation.csproj projects on startup.

Creating a new automation project

Project-specific tasks can be created by placing a C# project where Automation Tool can find it. Must use a source build of Unreal Engine. The project must be placed in one of the directories listed in <UE_ROOT>/UE4Game.uprojectdirs. The project cannot be in a folder with a .Build.cs or .Target.cs file. Do:

  • Open Visual Studio.
  • Right-click project folder.
  • Add > New Project…
  • Select Class Library (.NET Framworkd) Visual C#.
  • Set Name to end with .Automation.
  • Set Location to the Build directory inside the Unreal Engine project.
    The Build directory and the .uproject file should be siblings.
  • Set Framework to whatever the current version of Unreal Engine is using.
    Not sure how to determine that.

There are many more steps, I won't repeat them here.

AddingAutomationProjects@docs.unrealengine.com

[[2020-09-28_07:47:55]] Command line