Skip to content
Tools
/
SDKs and Tools
/
/
Unreal Engine SDK Quickst...
Last updated

Unreal Engine SDK

This plugin behaves as an Analytics Provider for Unreal Engine. It enables you to track in-game events using Treasure Data. Common use cases for this plugin are to track things like currency buys, item trades, and game progression.

You can start sending data from your Unreal Engine app to Treasure Data using our Unreal Engine SDK.

Prerequisites

  • The Unreal Engine has been compiled from source with all dependencies so third party plugins can build
  • The Unreal Engine has been installed on your machine
  • Blueprints plugin is in place and enabled
  • Treasure Data plugin is in place and enabled
  • You have a Treasure Data Write-Only API Key

Treasure Data strongly recommends that you use a write-only API key for ingest and import operations and whenever using Treasure Data SDKs.

How to get a Write-Only API Key
  1. Login to the Treasure Data Console and go to the API Key page.
  2. If you don't already have a write-only API key, then create one. From the top right, select Actions > Create API Key.
  3. Name the new API Key.
  4. From the Type drop-down menu, select Write-only.
  5. Select Save.
  6. Copy your new Write-Only API Key and use it to authenticate the APIs in your project.

Setup

Setting Up Unreal Engine 5

  1. Sign up for an Unreal Engine account in order to access the GitHub repository for Unreal Engine 5.
  2. On the Unreal Engine website, use the Personal > Apps and Accounts page to connect your Unreal Account to GitHub.
  3. Clone the Unreal repository from GitHub to your local machine.
  4. Compile the Unreal Engine with all dependencies.

Download and Place the Plugin

Get a copy of the plugin from the main GIT repository:

git clone https://github.com/treasure-data/td-ue4-sdk

Checkout the branch that matches your Unreal Engine version:

Unreal Engine 5.3
git checkout UE-5.3
Unreal Engine 4.x
git checkout master

Copy the new td-ue4-sdk to your Unreal Engine plugins folder. The target path looks something like this:

UnrealEngine/Engine/Plugins/td-ue4-sdk

Alternatively, you can copy the plugin content inside your Project Plugin directory. However, this approach does not work in a Linux Development environment.

Build the Plugin

To build the plugin, you need to generate the build-rules. The UE Engine provides a script called GenerateProjectFiles:

  • GenerateProjectFiles.bat (Windows)
  • GenerateProjectFiles.sh (Unix/Linux/Mac)

Depending on your system (Unix-based or Windows), run the proper script from the command line:

  • If the plugin is inside the Project directory (Project/Plugins), go to the Project root directory and run the script.
  • If the plugin is inside the Engine, run the command from the Unreal Engine source root directory.

When the command finishes, type the make command:

make

After a few seconds, the plugin binary is available.

Speed Up Plugin Build Phase

In some cases you may need to re-build only the plugin. Using a normal make command can take some minutes as it parses and runs scripts to fix dependencies. To speed up the process, add the following options:

make UE4Editor ARGS=-canskiplink

Enable the Analytics Plugins for Your Project

  1. In the Unreal Engine Editor, select Edit > Plugins.
  2. Open your project and the plugins window.
  3. Enable the two required plugins:
    • Blueprints: located at Built-in > Analytics
    • Treasure Data: located at Installed > Analytics

Configure Project Settings

From your project directory, open and edit the Config/DefaultEngine.ini file and append the following content at the bottom:

[Analytics]
ProviderModuleName=TreasureData
TDApiKey=TD-WRITE-ONLY-KEY
TDDatabase=DATABASE_NAME
TDRegion=[US01,AP01,AP02,AP03,EU01]
SendInterval=10

[AnalyticsDevelopment]
ProviderModuleName=TreasureData
TDApiKey=TD-WRITE-ONLY-KEY
TDDatabase=DATABASE_NAME
TDRegion=[US01,AP01,AP02,AP03,EU01]
SendInterval=10

[AnalyticsTest]
ProviderModuleName=TreasureData
TDApiKey=TD-WRITE-ONLY-KEY
TDDatabase=DATABASE_NAME
TDRegion=[US01,AP01,AP02,AP03,EU01]
SendInterval=10

The combined length of database name and table name must be shorter than 129 characters.

After making your changes, save the file and restart the Unreal Engine Editor.

Gathering Metrics with Blueprints

In the Editor, select Blueprints > Open Level Blueprint.

In the Event graphs window, different events can now be connected to Analytics functions. The following image demonstrates how to track the Session Start, Session End, and Record Event w/Attributes events:

After a Game starts, the plugin will send the events to Treasure Data.

Viewing Data on Treasure Data

To query game events:

  1. From the Treasure Data Console, select Databases from the workbench.
  2. Open the database used in the game (specified in Config/DefaultEngine.ini > TDDatabase).

By default two tables are created:

  • Sessions: start and stop sessions
  • Events: All events with or without attributes

To query records, select a table name and then select the Query button at the top of the screen. By default you can issue SQL queries similar to this:

SELECT * FROM events;

Previous page
Next page