# Unreal Engine Quick Start

This guide will show you how to integrate the Frameplay plugin into your Unreal Engine project.

We officially support:

Unreal Engine 4.26
Windows, Android & iOS platforms

# Prerequisites

# Getting Started

# Download and Install the Frameplay Plugin

Download and unzip the latest version of the Frameplay Unreal Engine plugin from the downloads page (opens new window)

# Install to Engine

The Frameplay plugin is pre-compiled with the source code removed, and should be installed as an 'Engine Plugin'.

Go to the Unreal Engine Plugins folder ~Epic Games > UE_4.xx > Engine > Plugins
Copy the Frameplay folder into the Plugins folder

See the Unreal Engine manual (opens new window) for more information on Plugins

# Reload Your Project

Code projects will need to regenerate the Visual Studio Project Files (opens new window)
Open your Unreal Project and enable the Frameplay plugin (opens new window) from the Plugins Window.

If the plugin fails to build, see our FAQ page for common issues.

# Setup Project Name and Version

To setup the project name and version for Frameplay SDK go to Edit > Project Settings
Then in Project > Description there will be Project Name and Project Version.
Enter in your Project Name and current Project Version.

# Setup the Frameplay Data Asset

The Frameplay Data Asset is an asset used to maintain the link between your project and the Developer Dashboard.

Create a new Frameplay Data Asset using the Content Browser. Add new > Frameplay > Data Asset

Open the new Data Asset file and set the Developer API Key and Game ID with the corresponding values found on your Game Page (opens new window)

3. Under Project Settings navigate to Plugins > Frameplay and select the newly created Data Asset.

See the Unreal Engine manual (opens new window) for more information on Data Assets.

# Initialize the Frameplay SDK

Before loading Ads, initialize the Frameplay SDK by calling Frameplay.StartSession() and register a Camera Component or Camera Manager. This only needs to be done once, in either a Blueprint or code, ideally at launch.

The Frameplay Session requires knowledge of the active Camera to use for gathering metrics and triggering advertisements colliders. More information on Registered Cameras

# Blueprint Example

Open the Level Blueprint by clicking the Blueprints button in the Level Editor Toolbar and select Open Level Blueprint.

To search for nodes right click and begin typing

Setup the flow to start a Frameplay Session on Begin Play, and register a Camera Manager
Under the Start Session node, select the newly created Frameplay Data Asset

# Code Example

# .h

#pragma once
#include "FrameplayManager.h"
#include "TestActor.generated.h"

UCLASS(Blueprintable)
class ATestActor : public AActor
{
	GENERATED_BODY()

UPROPERTY(EditAnywhere)
UFrameplayDataAsset* FPDataAsset;

public:
	ATestActor();
protected:
	void BeginPlay() override;
};

# .cpp

#include "TestActor.h"
#include "FrameplayManager.h"
#include "Kismet/GameplayStatics.h"

ATestActor::ATestActor()
{
	PrimaryActorTick.bCanEverTick = true;
}

void ATestActor::BeginPlay()
{
	Super::BeginPlay();

	UFrameplayManager::StartSession(this, FPDataAsset, -1, FPlayerSex::Unknown, "newPlayer,", "en");

	auto cam = UGameplayStatics::GetPlayerCameraManager(this, 0);

	UFrameplayManager::RegisterCameraManager(cam);
}

# .Build.cs

Reference the Frameplay module in your project.


using UnrealBuildTool;

public class UnrealProject : ModuleRules
{
	public UnrealProject(ReadOnlyTargetRules Target) : base(Target)
	{
		PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;

		PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore", "Frameplay" });

		PrivateDependencyModuleNames.AddRange(new string[] {  });
	}
}

The Frameplay SDK is now included in your project and will be initialized at run-time. You're now ready to implement an Ad Space.

More information on the Frameplay API.

More information on the Frameplay Session & Cameras.

See the Unreal Engine manual for information on Blueprints (opens new window) C++ (opens new window) and Cameras (opens new window).

# Create an Ad Space

A Frameplay Ad Space is an Actor that displays intrinsic advertisements to the player. They can be created through the editors Place Actor menu or in a Blueprint.

# In World

Using the Place Actors Mode, drag and drop a Frameplay Ad Space Actor into the Viewport.

The new unregistered Ad Space will display red debug text.

# Blueprint

Create a new Ad Space Blueprint class using the Content Browser. Add new > Frameplay > Ad Space Blueprint

If the Blueprint will be loaded at runtime with multiple concurrent instances, set ActorInstanceType to Multiple.

See Unreal Engine manual (opens new window) for more information on Actors.

More information on Frameplay Activation Colliders.

# Register an Ad Space

For an Ad Space to request and display advertisements, it needs to first be registered.

Select the Ad Space in the World Outliner and click the Register Ad Space button in the Details panel.
Enter a description so the Ad Space is easily identifiable.
Pick your preferred ratio then position and scale the Ad Space in your world to your liking.
Click the Register Ad Space button.

The debug text will change from red to white as the Ad Space is now registered and linked to the Frameplay servers. When activated it will download mock advertisements.

Once an Ad Space has been registered, it cannot be unregistered. It can however be modified by using the Replace Ad Space button inside the Inspector window. Previous versions of a modified Ad Space will remain on the Frameplay dashboard. This ensures Ad Spaces from previous build versions will receive metrics and generate revenue.

Ad Spaces cannot be registered at runtime.

# Load a Mock Advertisement

Enter Play In Editor Mode and upon activation the Ad Space will request, download and display a mock advertisement.

Ad Spaces will activate either on spawn or if an Activation Trigger is used, on collision with the registered camera. More information on Ad Space Activation

Congratulations! You have created your first intrinsic advertisement.

# Packaging Builds

# DebugGame & Development Builds

When playing in Editor, DebugGame and Development Build configurations, mock advertisements will be loaded at runtime.

To create a build select File > Package Project > Build Configuration and toggle DebugGame or Development while in development.

# Release Build

Before monetizing your release build, you must first submit your account and game for approval on the Frameplay Platform:

The current wait time for game approval is 48 hours. No advertisements will load in non-development builds until both your account and game is approved.

When you are ready to package a production version of your project, set Test Mode off, in the Frameplay Data Asset (This can be done in the Data Asset UI or programmatically from code). Ad Spaces will now request and load real revenue raising advertisements.

See the Unreal Engine manual (opens new window) for more information on Packaging Builds.

# Best Practices

We highly recommend you check out the Best Practices Guide to maximize revenue, impression quality and user experience!

Ad Spaces →