Unreal Engine SDKs

You can use Unreal Engine SDKs for integrating Xsolla products with 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. Try Login Demo or Store Demo if needed.
  2. Create your Xsolla Publisher Account.
  3. Set up a Publisher Account project created automatically after creating the Publisher Account:
    1. Click My game in Projects block and go to Project settings.
    2. In setup mode specify Project name and click Save.
    3. Go to Integration settings and check that the Integrate new Store management methods toggler is enabled.

You can create a new project by clicking the + icon in the Projects block.

Login UE4 SDK

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

  • authenticating via username and password
  • signup
  • email confirmation
  • password reset
  • authenticating via Steam session_ticket
  • authenticating via Steam account by opening a login form in the in-game browser
  • managing user attributes
  • cross-platform account linking. To enable this feature, please email the Xsolla integration team (integration@xsolla.com)

The solution works for:

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

Demo

The integration demo is available in the Content Browser > Xsolla Content > Maps folder. You can use it as an example.

By default, the demo uses the Xsolla Login ID of a pre-set Publisher Account project.

Default values for the Demo_Login map:

  • login ID: e6dfaac6-78a8-11e9-9244-42010aa80004
  • username: xsolla
  • email: support@xsolla.com
  • password: xsolla

Integration

To integrate the Login UE4 SDK:

  1. Set up Login in your Publisher Account. You will need a Login ID, found in Login settings > Login ID. It has the UUID format.

  1. Set up the plugin for your UE4 project.

Setting up Login in Publisher Account

  1. Go to your project and click Connect in the Login block.

  1. Open Login settings.
  2. Go to Login projects and click New Login.

  1. Specify a Login name and click Create.

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

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 Project ID found in Publisher Account > Project settings > Project ID, and the Login ID found in Publisher Account > Login settings > Login ID which has the UUID format.

  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

The 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
  • managing user inventory
  • managing virtual currencies

Before using the plugin, you need to set up Store and Login modules in your Publisher Account. For integration you will need:

  • Project ID found in Project settings > Project ID.

  • Login ID found in Login settings > Login ID. It has the UUID format.

Demo

The integration demo is available in the Content Browser > Xsolla Content > Maps folder. You can use it as an example.

By default, the demo uses the Xsolla Project ID and Login ID of a pre-set Publisher Account project that has a fully configured store.

Three demo maps are provided:

  • Demo_Login with the use of the Login module only.
  • Demo_Store with the use of the Store module only. No registration required to test the Store module.
  • Demo with Login and Store modules connected.

Default values for demo maps:

  • login ID: e6dfaac6-78a8-11e9-9244-42010aa80004
  • username: xsolla
  • email: support@xsolla.com
  • password: xsolla
  • project ID: 44056

Integration

To integrate the 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. Go to your project and click Connect in the Store block.

  1. Click Connect in the Virtual Items block.

  1. Click Create a group.

  1. Specify Group code and Group name, turn on the group display in Store. Click Create group.

  1. Create items, specifying the following info for each of them:
    • one or more groups that the item should belong to
    • SKU
    • name and a short description
    • prices in real and virtual currencies
    • image (optional)

  1. Make sure that the group status is Enabled.

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. 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: