Skip to content

Introduction to Unreal SDK

Welcome to the Beamable Unreal SDK Documentation!

The Beamable Unreal SDK provides all of the functionality to integrate Beamable's systems into your Project. It includes features like Authentication, Content, Events, Inventory, Microservices and much more.

SDK design principles

  • Source-available and modifiable inside your project
  • Simple by default, with clear extension points
  • Explicit about assumptions when they exist
  • Full parity between Blueprint and C++ APIs (except when otherwise notated in docs)

Platform support roadmap

The Beamable Unreal SDK is designed to work across multiple platforms. Below is a table outlining the current support status and estimated time of arrival (ETA) for each platform.

Platform Client Support Dedicated Server Support ETA
Windows ✅ — Released
Android ✅ — Released
iOS ✅ — Released
Linux — ✅ Released

Console support is not currently available. If you need it, let Beamable know.

Beamable CLI

Most Beamable workflows run through the Beamable CLI. Editor integrations use the CLI to create Engine-specific workflows. In general the Beamable CLI is invisible where it needs to be and explicit where needed.

The SDK is tightly integrated with the CLI, in some ways more than others. For example:

  • Content, being designer-focused, has its own UE-familiar content editing UI so you can edit the various JSON blobs that define your game's content
  • Microservices, more engineer focused, leans more directly on the CLI

Required Versions for the CLI will be noted in the documentation where relevant, but here is a quick reference for the latest versions:

SDK Version CLI
v2.3 v7.1
v2.2 v6.2

Where to start?

New users should start with:

After this, it depends on what your game is and what you are looking to do.

  • The most-used backend systems include:
    • Inventory for items and currency management
    • Stats for player-scoped key-value stores
  • Custom features are explored in the Content and Microservices documentation with consideration to data structuring and writing custom code with Beamable

For support, email support@beamable.com or visit the Beamable support page.