Upload game binaries using CLI

Last updated on October 23, 2024

Prerequisites​

Get your namespace​

You can find the namespace in the invitation email from ADT. Note that namespaces are written in lowercase.

Find namespace

Get your API Key​

The system creates an API Key and shows it to you once after creating a game. The system won't show the API key to you again. If you created your game already and didn't record the API key, follow the steps below to get a new one.

  1. Go to ADT Web.

  2. Type your namespace in lowercase in the Namespace field, and then click Continue.

    Type in Namespace

  3. Log in with your username and password.

    Log in with username and password

  4. Select your game.

    Select your game

  5. Go to the Game Settings page, then go to API Key Management. The API Key the system created for onboarding appears.

  6. To create a new API Key, click Add New. The Add New API Key pop-up appears.

  7. Type a descriptive name for the new key in the API Key Name field.

  8. Click Add New Resource, then add NAMESPACE:{namespace}:* to the resource field. Enable the checkboxes for Create, Read, Update, and Delete.

  9. When you're done, click Add.

    Name and add new API Key

  10. A pop-up appears showing the API Key. You must save it, as it only appears in this pop-up once.

    Pop-up showing API Key

Get the ADT CLI​

  1. On ADT Web, go to the Downloads page.

  2. In the ADT SDK panel, click Download. The ADT CLI is in the zipped SDK folder, in the Tools folder.

    Get ADT CLI

  3. Unzip the ADT CLI folder.

  4. Run the Powershell app and set the directory path to the unzipped ADT CLI folder.

    Run Powershell application

    Set directory path to ADT CLI folder

Upload your game with ADT CLI​

  1. Run the Powershell application, and then run these commands from the unzipped ADT CLI folder.

Create a game version

Sample command:

./blackboxcli version add --name 0.0.6
--namespace avengers
--apikey 0e1dc3ef83d04eaeb1672bfd44889c04_UXm5R52wAfjcEnQOzVw99oAl1uQ1hRZ
--game-project "C:\Users\setya_accelbyte\Documents\Unreal Projects\MyProject"

Register the build

Sample command:

./blackboxcli build register --platform-name windows --platform-arch x64
--namespace avengers
--apikey 0e1dc3ef83d04eaeb1672bfd44889c04_UXm5R52wAfjcEnQOzVw99oAl1uQ1hRZ
--game-engine "D:\Epic Games\UE_5.0"
--game-project "C:\Users\setya_accelbyte\Documents\Unreal Projects\MyProject"
info

If you want to upload console builds, you must register them by changing the --platform-name value to the console you're working with: ps4, ps5, xboxonegdk, xsx, android, or nintendo-switch.

Upload the build

Sample command:

./blackboxcli build upload-binaries --entry-point MyGame.exe
--namespace avengers
--apikey 0e1dc3ef83d04eaeb1672bfd44889c04_UXm5R52wAfjcEnQOzVw99oAl1uQ1hRZ
--game-engine "D:\Epic Games\UE_5.0"
--game-project "C:\Users\setya_accelbyte\Documents\Unreal Projects\MyProject"
--game-archive "C:\Users\setya_accelbyte\Documents\Unreal Projects\MyProject\Packaged\0.0.2-Windows"
NOTE
  • Use quotation marks if there is a space in the directory path.
  • Namespace: The namespace for the game.
  • GameEngine: The game engine root path (e.g. C:\Program Files\Epic Games\UE_4.21) for the Epic Launcher installation.
  • GameArchive: The location of the executable for a packaged game.
  • GameProject: The game project root folder, where the .uproject file is located.
Last updated on

On this page