Manage your build

Last updated on August 28, 2023

Overview​

This guide shows you how to register and find your Unreal game builds and set build channels. We'll use the AccelByte Development Toolkit (ADT) CLI to set and find these values.

note

Builds should be unique so that you can attach other assets, such as crashes, to them.

Register the build​

Before building the game, register the game build for shipping builds.

When you create a build with the register command, the system doesn't produce a build name, which means it won’t be able to find the build later on. To fix this, use the find-or-register command (see below) to register a build name you can search for.

To register the build, execute this command:

Without inline configuration

BlackBoxCLI.exe build register --platform-name <platform> --platform-arch x64

With inline configuration

BlackBoxCLI.exe build register --namespace myawesomegame--apikey asdf1234 --game-project D:\path\to\myawesomegame --platform-arch x64 --platform-name <platform> --game-engine D:\UnrealEngine\UE4.25

Valid platform names​

Use the --platform-name command for these platform names:

  • windows
  • windows-server
  • windows-editor-ue5
  • linux
  • linux-server
  • xboxonegdk
  • xsx
  • ps4
  • ps5

Valid platform architecture​

note

We support x64 only .

Register an Editor build (Windows only)​

There may be times when you want to work with an Unreal Editor build instead of a standalone build. We cover that workflow next.

You can only register an Unreal Editor build for the Windows platform. To do this, add --editor-build when calling the build register command. To produce a valid build, add the windows platform name.

For example, without inline configuration:

BlackBoxCLI.exe build register --platform-name <platform> --platform-arch x64 --editor-build

Valid platform names​

You can only use one platform name: windows

Valid platform architecture​

note

We support x64 only.

Change build name​

Use this command to change the name of the build.

.\BlackBoxCLI.exe build add-metadata --key build-name --value <the new build name>

Set the Build ID​

To set a Build ID, use this command:

Without inline configuration

BlackBoxCLI.exe build set --id <build id uuid>

With inline configuration

BlackBoxCLI.exe build set --id <build id uuid> --namespace myawesomegame --apikey asdf1234  --game-project D:\path\to\myawesomegame

The ADT CLI adds Build ID information you can use to build your game to the BlackBox.ini file.

Get the Build ID​

Use this command to find a Build ID:

Without inline configuration

BlackBoxCLI.exe build get

With inline configuration

BlackBoxCLI.exe build get --game-project D:\path\to\myawesomegame

Set the branch and configuration metadata​

To set the branch and configuration metadata, use the following commands:

Add the branch name:

BlackBoxCLI.exe build register --platform-arch x64 --platform-name <platform> --branch-name <branch name>

Add the configuration with build-name:

BlackBoxCLI.exe build add-metadata --key <configuration> --value <Test, Development, Shipping> --build-id <build id> --version-id <version id>

You can only add the branch name when you use the build register command. Once you register the build, you can no longer use it.

Last updated on

On this page