Skip to main content

Android build distribution

Last updated on February 12, 2024

Overview

Android Support in AccelByte Development Toolkit (ADT) enables you to upload your Android builds and distribute them to your team worldwide. This feature makes the testing process faster by storing the .apk file in the server, which can then be downloaded directly from ADT Hub and installed on Android devices.

Prerequisites

  • The Android SDK must be installed on the local machine.

  • The Android builds must be registered through the ADT CLI.

The following table contains the subcommands you can use when you register the Android builds.

Main commandSub commandOptions and Parameters
NameDescription
versionadd--nameAdd a new version name.
set--nameSet the version name to any existing version name.
--idSet the version ID to any existing version ID.
buildregister--namespaceSet the name of the namespace.
--apikeySet the ADT game's API key.
--platform-nameSet to Android.
--platform-archThere are four supported architectures: armeabi-v7a, arm64-v8a, x86_64, and x86.
--game-projectSet the directory of the game project, where the .project file is located.
--game-engineSet the directory of the Unreal Engine.

Create a new version

Run the following command to create a new version.

.\BlackBoxCLI.exe version add --name <version_name> --namespace <namespace> --apikey <apikey> --game-engine <game_engine> --game-project <game_project>

You can use an existing version instead of setting up a new one by using the following commands.

Run any of the following commands to use an existing version. Use the set command instead of add.

Using version_id:

.\BlackBoxCLI.exe version set --id <version_id> --namespace <namespace> --apikey <apikey> --game-engine <game_engine> --game-project <game_project>

Using version_name:

.\BlackBoxCLI.exe version set --name <version_name> --namespace <namespace> --apikey <apikey> --game-engine <game_engine> --game-project <game_project>

Create a new build

Run the following command to add a new build.

.\BlackBoxCLI.exe build register --platform-name android --platform-arch <platform_arch> --namespace <namespace> --apikey <apikey> --game-engine <game_engine> --game-project <game_project>

Uploading an Android builds using the ADT CLI

The following table contains the subcommands you can use when you upload Android builds:

Main commandSub commandOptions and Parameters
NameDescription
buildupload-binaries--namespaceSet the user namespace.
--apikeySet the ADT game's API key.
--game-projectSet the version ID to any existing version ID.
--game-projectSet the directory of the Game Project where the .project file is located.
--game-engineSet the directory of the Unreal Engine.
--game-archiveSet the directory of the .apk file that will be uploaded.
--entry-pointSet the entry point or the executable game name. Example: <game_name>.apk
--version-idSet the version ID.
--build-idSet the build ID.
--multipart-sizeOptional. Set the multipart size in megabytes or MB. The size can't be less than 5 MB.

Pair Android devices to the ADT Hub

The Android SDK must be installed on the local machine to pair Android devices to the ADT hub.

To install the Android SDK, follow these steps:

  1. Log in to the ADT Hub.

  2. Go to Connect Devkit, and then select the Android tab to open the Android Devkit Manager.

  3. On the message, select Repair.

  4. On the Browse window, locate and select the Android SDK installation folder.

  5. On the pop-up message, select Restart to restart the ADT Hub.

    How to pair android devices

Create the build channels

To create build channels on the ADT Hub, follow these steps:

  1. Log in to the ADT Hub.

  2. Go to Build Channels.

  3. Select the Add New Build Channel button.

  4. Enter the name of the new build channel.

  5. Select the Android platform of the new build channel based on the architecture type.

  6. Select the changelist.

  7. Specify the Android build.

  8. Click the Add button to create the build channels.

  9. Go to the Overview page and select the Configure New Builds button.

  10. Select the Android channels that have been created.

    How to creat build channels two

Deploy Android builds from the Versions page

Follow these steps:

  1. Log in to the ADT Hub.

  2. Go to Versions.

  3. Open the version where the Android builds are present.

  4. Connect the Android device to the local machine.

  5. Download the Android build, and then click the Deploy button.

  6. Select the Android device target.

  7. Click Deploy.

    Deploy builds from version page

Deploy Android builds from the Overview page

Follow these steps:

  1. Log in to the ADT Hub.

  2. Go to Overview.

  3. Connect the Android device to the local machine.

  4. Download the Android build set as a head of a Build Channel, and click the Deploy button.

  5. Choose the Android device target.

  6. Select Deploy.

    Deploy builds from overview page

FAQ

Q: Can I use the Crash Reporter feature on our Android Builds?

A: No. Currently, we only support build distribution for Android devices.

Q: What happens if I already have a newer game version installed on the Android device and deploy an older version from the ADT Hub?

A: The deployment process would lead to a failure because a newer version is already installed on the Android device.