Unreal Cloud Docs

Get Started

From signup to your first downloadable build in six steps.

Unreal Cloud builds your Unreal Engine project in the cloud. Connect a GitHub repository, pick a platform and engine version, and get packaged builds — triggered manually or automatically on every push or pull request.

GitHub pushes and pull requests trigger builds on Unreal Cloud, which produce downloadable artifacts and report check runs back to GitHub

This guide takes you from signup to your first downloadable build.

Create an account

Sign up at the Unreal Cloud dashboard with your email address, then verify your email. Every account belongs to at least one organization — the workspace that holds your projects, members, and billing.

Create a project

A project maps to one Unreal Engine game repository.

  1. Open your organization and go to Projects.
  2. Click Create project and give it a name.

Connect your GitHub repository

Builds pull your code from GitHub, so each project needs a connected repository.

  1. Open your project's Settings tab.
  2. Under Version control, click Connect GitHub. A GitHub window opens asking you to install the Unreal Cloud GitHub App.
  3. Install the app on the account or organization that owns your repository, granting access to the repository you want to build.
  4. Back in Unreal Cloud, select the repository for this project.

The connection status is shown on the project page. You can disconnect or change the repository at any time from project settings.

Create a preset

A preset is a reusable build configuration: platform, engine version, trigger, and test settings. You need at least one preset to build.

  1. Open your project's Presets tab and click Create preset.

  2. Give it a name (for example Windows – main).

  3. Choose a platform (Windows 64-bit, Linux, or Android).

  4. Choose an Unreal Engine version from the supported versions list.

  5. Choose a trigger:

    TriggerBuilds when
    NoneOnly when you trigger it manually
    PushA branch is pushed
    Pull RequestA PR is opened or updated (optionally filtered by base branch)
  6. Optionally enable Run tests to run your project's automation tests after each successful build.

See Presets for the full reference.

Trigger your first build

  1. Go to the project's Builds tab and click Trigger build.
  2. Select a preset and confirm.

The build appears in the list and moves through its lifecycle — queued, scheduled, running — until it passes or fails. Click the build to follow the logs live. See Build lifecycle for what each status means.

Download the result

When the build passes, its packaged output is attached as an artifact. Open the build's menu in the builds table and choose the artifact to download it.

Next steps

Questions or feedback? Contact us at support@unrealcloud.io.

On this page