Small build script for UE project that can also upload to itch.io
The easiest way to use the script is copying it in your project's directory, opening the terminal and running the following:
.\BuildProject.ps1This will find the .uproject file in the script's directory, build the game in the Development configuration for the Win64 platform, and output the build to $ProjectRoot/ArchivedBuilds.
You can find all the command's parameters documented in the file or lower in this page.
-ProjectRoot:<string>
Where to find the .uproject file.
Default value: The script's directory (or $EngineRoot/$ProjectName for native projects with a -ProjectName specified)
-ProjectName:<string>
Name of the .uproject file to build.
Default value: Will try to find a .uproject file in $ProjectRoot and will use it's filename.
-TargetName:<string>
Name of the build target.
Default value: $ProjectName
-TargetType:<string>
Type of target that will get built. Only used to find the output directory.
Accepted values: Game, Client, Server
Default value: unset
-Configuration:<string>
Target configuration. Debug and Test are only supported in source builds.
Accepted values: Debug, DebugGame, Development, Test, Shipping
Default value: Development
-Platform:<string>
Platform to build and cook
Accepted values: Win64, Linux
Default value: Win64
-Prerequisites:<string>
If set, will bundle Unreal Engine prerequisites either as an installer or local DLLs.
Aliases: -Prereqs
Accepted values: Installer, Local
-IncludeCrashReporter
If set, will include the crash reporter in the build.
Aliases: -CrashReporter
-ArchiveRoot:<string>
Where to output the build.
Default value: $ProjectRoot/ArchivedBuilds
-TimestampedArchiveFolder
If set, will output the builds to $ArchiveRoot\$TargetName-$Configuration+yyyymmddThhmm instead of just $ArchiveRoot.
Default value: unset
-EngineVersion:<string>
Unreal version that is used. Only used for launcher installs auto-root folder "detection".
Default value: 5.6
-NativeProject
Whether this is a native project. See this article for more information. If you don't know what this means, you probably don't need it!
Default value: unset
-EngineRoot:<string>
Path to Unreal Engine.
Default value: C:/Program Files/Epic Games/UE_$EngineVersion (or $ProjectRoot/.. for native projects)
To upload a build in the Shipping configuration, to the channel windows, run the following command:
.\BuildProject.ps1 -Configuration:Shipping -PublishToItch -ItchUsername:ITCH_USERNAME -ItchGame:ITCH_GAMETip
For game jams, you will probably want to add -Prerequisites:Local so that the Visual C++ and other dependencies' DLLs are copied alongside the game's exe. You can also use -Prerequisites:Installer to bundle the installer instead.
Important
By default, the script will block you from uploading non-Shipping builds to itch.io, to prevent mistakes. You can add the -AllowPublishNonShipping parameter to override that behaviour.
See itch.io's documentation for more info about channel names and the pushing process.
-PublishToItch
Whether to upload the game to itch using butler. See the butler docs to learn about the upload process.
Default value: unset
-AllowPublishNonShipping
Enables uploading of non-shipping games.
Default value: unset
-ItchUsername:<string>
Username under which the game is hosted. See the butler docs for more info.
Required if -PublishToItch is set
Default value: none
-ItchGame:<string>
Name of the game being uploaded. See the butler docs for more info.
Required if -PublishToItch is set
Default value: none
-ItchChannel:<string>
Name of the channel where it should upload. See the butler docs for more info.
Default value: windows for the Win64 platform and linux for the Linux platform.
-ItchCredentialsPath:<string>
If set, will use a custom credentials file. Useful if you need multiple users. See the butler docs for more info.
Default value: unset