Introduction
Overview of the platform and how it works
Infrastructure Overview
The diagram above shows a high-level overview of the platform’s architecture.
Let’s walk through each component from top to bottom.
In the cloud
Infrastructure
All the underlying cloud components required to operate the platform, including: compute, databases, storage, and networking.
The infrastructure is fully managed and shared across tentnats by default. For teams that need isolated environments or self-hosted setups, we also provide Custom Plans.
Web Dashboard
The web dashboard provides a central place to manage your organizations, monitor analytics, and configure platform features.
This is where you can generate API Keys used by the Unreal Plugin and the CLI.
API
The API acts as the central communication layer, enabling the Unreal Plugin and the CLI to send and retrieve data.
Both use API Keys for authentication to securely data transfer.
This will be used both by your internal team and external users (players).
On your machine
Unreal Plugin
The Unreal Plugin is responsible for communicating with the API at both runtime (for end-users) and editor-time (for developers).
The configuration settings accepts different API Keys for each case and gives you the flexibility to enable or disable the features you want.
CLI
A developer friendly utility CLI used for operations that need to run outside Unreal, for example: monitoring the UBT process
The CLI is typically downloaded and executed automatically by the Unreal plugin.
However, you can also run it manually in specific scenarios, such as on build coordinator agents or within your CI/CD pipeline to upload debug symbols.