Unreal Engine SDKs

Unreal Engine SDKs are used for integrating Xsolla products in your UE4 projects.

System Requirements

  • 64-bit OS
  • Windows 7 and higher
  • macOS 10.13.6 and higher
  • XCode 10.1 and higher (for macOS)
  • Visual Studio 2017 and higher
  • Unreal Engine 4.21 and higher

Target OS

  • iOS
  • Android
  • Linux
  • macOS
  • Windows 32-bit
  • Windows 64-bit

Prerequisites

  1. Download the Epic Games Launcher.
  2. Create a new UE4 project.
  3. Download the plugin from the Unreal Engine Marketplace or GitHub.

  1. Register an Xsolla Publisher Account.
  2. Create and set up a Publisher Account project:
    1. Go to Projects and click Create project.
    2. In setup mode, add Project name and click Create.
    3. Go to Project settings > Integration settings and check that Tokenless integration is disabled.

Login UE4 SDK

Login UE4 SDK is used to integrate Xsolla Login API methods with apps based on Unreal Engine. Main features:

  • Sign-in via login and password
  • Signup
  • Email confirmation
  • Password reset

The solution works for:

  • storing user data at Xsolla’s side
  • authentication via email/username and password

To integrate Login UE4 SDK:

  1. Set up Login in your Publisher Account. You will need a Login ID, shown in Login settings > Login ID in the UUID format.
  2. Set up the plugin for your UE4 project.

Setting up Login in Publisher Account

  1. Connect Login to your project.

  1. Open Login settings.
  2. Go to Login projects and create a New Login.

  1. Specify a Login name and click Create.

  1. Go to General settings > URL block and specify the Callback URL, to which the user is redirected after the email confirmation or password reset.
  2. Select the Xsolla storage in the User data storage block.
  3. Copy Login ID.

Setting up the Plugin for Your UE4 Project

  1. Open your UE project in Unreal Editor.
  2. For Blueprint projects only:
    1. Compile your UE project.
    2. Go to the Content Browser and add a New C++ Class with the None parent node.
  3. Go to Settings > Plugins > Installed > Xsolla Store SDK and put the tick to the Enabled checkbox, and save the settings by the Restart Now button.
  4. Go to Settings > Project Settings > Plugins > Xsolla Login and fill in the Login ID.

  1. Go to Content Browser > View Options and put the ticks to the Show Engine Content and Show Plugin Content checkboxes.

  1. Go to Content Browser > Xsolla Content > Maps and launch the Demo_Login map of the game.

  1. Create a new user and check for the confirmation email.

  1. Log in as a new user and change the password if necessary.

You can customize the integration demo settings if needed:

Store UE4 SDK

Xsolla Store UE4 SDK is used to integrate Xsolla Store API methods with apps based on Unreal Engine.

The solution works for:

  • selling virtual items
  • managing your in-game store

Before using the plugin, you need to set up Store and Login in your Publisher Account. For integration you will need a Project ID, shown in Project settings > Project ID and Login ID, shown in Login settings > Login ID in the UUID format.

To integrate Store UE4 SDK:

  1. Set up the Virtual Items module in your Publisher Account.
  2. Set up the plugin for your UE4 project.

Setting up the Virtual Items module in your Publisher Account

  1. Connect Store to your project.

  1. Connect Virtual Items.

  1. Create a group of items.

  1. Create items, specifying the following info for each of them:
    • One or more groups that the item should belong to;
    • SKU;
    • Name and short description;
    • Prices in real and virtual currencies;
    • Image (optional).

  1. Turn on the group display in Store after the items were created.

  1. Copy the Project ID.

Setting up the Plugin for Your UE4 Project

  1. Open your UE project in Unreal Editor.
  2. For Blueprint projects only:
    1. Compile your UE project.
    2. Go to the Content Browser and add a New C++ Class with the None parent node.
  3. Go to Settings > Plugins > Installed > Xsolla Store SDK and put the tick to the Enabled checkbox, and save the settings by the Restart Now button.
  4. Go to Settings > Project Settings > Plugins > Xsolla Login and fill in the Login ID and to Settings > Project Settings > Plugins > Xsolla Store and fill in the Project ID.

  1. Go to Content Browser > View Options and put the ticks to the Show Engine Content and Show Plugin Content checkboxes.

  1. Go to Content Browser > Xsolla Content > Maps and launch the Demo_Login map of the game. If you launch the Demo_Store first, user change is unavailable.

  1. Create a new user. The user’s email must match the Owner’s email at Publisher Account > Company settings > Users. Check for the confirmation email.

  1. Log in as a new user and change the password if necessary.

You can customize the integration demo settings if needed: