虚幻引擎SDK

您可以使用虚幻引擎SDK将艾克索拉产品与您的UE4项目集成。

系统要求

  • 64位操作系统
  • Windows 7及更高版本
  • macOS 10.13.6及更高版本
  • XCode 10.1及更高版本(用于macOS)
  • Visual Studio 2017及更高版本
  • 虚幻引擎4.21及更高版本

终端操作系统

  • iOS
  • Android
  • Linux
  • macOS
  • Windows 32位
  • Windows 64位

前提条件

  1. 下载Epic Games启动器
  2. 新建一个UE4项目。
  3. 虚幻商城GitHub中下载插件。

  1. 如需要,可试用登录管理器演示商店演示项目。
  2. 创建您的艾克索拉发布商帐户
  3. 设置创建发布商帐户后自动创建的发布商帐户项目:
    1. 项目部分单击My game,然后前往项目设置
    2. 在设置模式下,指定项目名称,然后单击保存
    3. 前往集成设置,确保已启用集成新商店管理方法开关。

可通过在项目部分单击+图标创建一个新项目。

Login UE4 SDK

Login UE4 SDK用于将Xsolla Login API方法与基于虚幻引擎的应用集成。主要功能:

  • 通过用户名和密码进行认证
  • 注册
  • 邮箱确认
  • 密码重置
  • 通过Steam session_ticket进行认证
  • 通过Steam帐户进行认证(通过在游戏内浏览器打开登录表单)
  • 管理用户属性
  • 跨平台帐户关联。要启用此功能,请发送邮件与艾克索拉集成团队联系(integration@xsolla.com)。请按照说明在演示项目中尝试帐户关联

该解决方案适用于:

  • 用户数据存储在艾克索拉侧
  • 通过电子邮箱/用户名和密码进行认证
  • 通过Steam进行认证

演示

集成演示位于Content Browser > Xsolla Content > Maps文件夹。可用其作为示例。

演示默认使用一个预置发布商帐户项目的艾克索拉登录管理器ID

Demo_Login Map的默认值如下:

  • 登录管理器ID:e6dfaac6-78a8-11e9-9244-42010aa80004
  • 用户名:xsolla
  • 邮箱:support@xsolla.com
  • 密码:xsolla

集成

要集成Login UE4 SDK:

  1. 在您的发布商帐户中设置登录管理器。后续需要用到登录管理器ID,可在登录管理器设置 > 登录管理器ID中找到,格式为UUID

  1. 为UE4项目设置插件。

在发布商帐户中设置登录管理器

  1. 前往您的项目,然后在登录管理器部分单击连接

  1. 打开登录管理器设置。
  2. 前往登录管理器项目,然后单击新建登录管理器

  1. 指定登录管理器名称,然后单击创建

  1. 前往常规设置 > URL部分,然后指定回调URL(用户完成邮箱确认或密码重置后将重定向到该URL)。
  2. 用户数据存储部分选择艾克索拉存储

为UE4项目设置插件

  1. 在Unreal Editor中打开您的UE项目。
  2. 仅对于蓝图项目:
    1. 编译您的UE项目。
    2. 前往Content Browser,添加一个New C++ ClassNone父节点。
  3. 前往Settings > Plugins > Installed > Xsolla Store SDK,勾选Enabled复选框,然后通过单击Restart Now按钮保存设置。
  4. 前往Settings > Project Settings > Plugins > Xsolla Login,填写Project ID(可在发布商帐户 > 帐户设置 > 项目ID中找到)和Login ID(可在发布商帐户 > 登录管理器设置 > 登录管理器ID中找到,格式为UUID)。

  1. 前往Content Browser > View Options,然后勾选Show Engine ContentShow Plugin Content复选框。

  1. 前往Content Browser > Xsolla Content > Maps,然后启动游戏的Demo_Login映射。

  1. 创建一个新用户并检查邮箱查看确认邮件。

  1. 作为新用户登录并更改密码(如需要)。

如需要,可以自定义集成演示设置:

Store UE4 SDK

艾克索拉Store UE4 SDK用于将Xsolla Store API方法与基于虚拟引擎的应用集成。

该解决方案用于:

  • 销售虚拟物品
  • 管理游戏内商店
  • 管理用户物品库
  • 管理虚拟货币

使用该插件之前,需先在您的发布商帐户中设置商店和登录管理器模块。集成过程中需要用到:

  • 项目ID,可在项目设置 > 项目ID中找到。

  • 登录管理器ID,可在登录管理器设置 > 登录管理器ID中找到,格式为UUID

演示

集成演示位于Content Browser > Xsolla Content > Maps文件夹。可用其作为示例。

演示默认使用一个已完整配置了商店的预置发布商帐户项目的艾克索拉项目ID登录管理器ID

我们提供了三个演示Map:

  • 只使用了登录管理器模块的Demo_Login
  • 只使用了商店模块的Demo_Store。测试商店模块无需注册。
  • 连接了登录管理器和商店模块的Demo

演示Map的默认值如下:

  • 登录管理器ID:e6dfaac6-78a8-11e9-9244-42010aa80004
  • 用户名:xsolla
  • 邮箱:support@xsolla.com
  • 密码:xsolla
  • 项目ID:44056

集成

要集成Store UE4 SDK:

  1. 在发布商帐户中设置虚拟物品模块。
  2. 为您的UE4项目设置插件。

在发布商帐户中设置虚拟物品模块

  1. 前往您的项目,然后在商店部分单击连接

  1. 虚拟物品部分单击连接

  1. 单击创建一个组

  1. 指定组代码组名称,打开“在商店中显示组”开关。然后单击创建组

  1. 创建物品并指定以下信息:
    • 该物品所属的一个或多个组
    • SKU
    • 名称和简短描述
    • 以真实货币和虚拟货币表示的价格
    • 图像(可选)

  1. 确保组状态为已启用

为UE4项目设置插件

  1. 在Unreal Editor中打开您的UE项目。
  2. 仅对于蓝图项目:
    1. 编译您的UE项目。
    2. 前往Content Browser,添加一个New C++ ClassNone父节点。
  3. 前往Settings > Plugins > Installed > Xsolla Store SDK,勾选Enabled复选框,然后通过单击Restart Now按钮保存设置。
  4. 前往Settings > Project Settings > Plugins > Xsolla Login,填写Login ID(登录管理器ID);然后前往Settings > Project Settings > Plugins > Xsolla Store,填写Project ID(项目ID)。

  1. 前往Content Browser > View Options,然后勾选Show Engine ContentShow Plugin Content复选框。

  1. 前往Content Browser > Xsolla Content > Maps,然后启动游戏的Demo_Login映射。如果先启动的是Demo_Store,则用户更改不可用。

  1. 创建一个新用户。检查邮箱查看确认邮件。

  1. 作为新用户登录并更改密码(如需要)。

如需要,可以自定义集成演示设置:

如何在演示项目中尝试帐户关联

通过将玩家在不同平台上的帐户与主帐户关联,可实现以下功能:

  • 在不同平台上自动识别玩家身份
  • 通过单一跨平台物品库管理不同平台上的物品库

您可以使用演示Map来检查将平台帐户关联至一个预置发布商帐户项目中主帐户的效果。

Info: 每个平台只能关联一个帐户至主帐户。

要在演示项目中尝试帐户关联:

  1. 在Unreal Editor中前往您的UE项目。
  2. 将演示Map设置为通过平台帐户登录应用程序:
    1. 前往Settings > Project Settings > Plugins > Xsolla Login。启用Use Cross-Platform Account Linking选项。指定PlatformPlatform Account ID
    2. 前往Settings > Project Settings > Plugins > Xsolla Store。启用Use Cross-Platform Account Linking选项。选择与Xsolla Login中相同的Platform
  3. Content Browser > Xsolla Content > Maps文件夹启动Demo演示Map。演示项目模拟通过平台帐户进行认证,因此您将自动完成认证并进入游戏内商店。
  4. 在演示Map中单击Account linking。演示项目将在默认浏览器中打开,模拟在其他平台上启动应用程序。
  5. 单击Create an account
  6. 指定邮箱和密码。单击Accept and create
  7. 在目录中选择一个商品,然后单击Buy on Xsolla。使用测试银行卡购买该商品。关闭付款凭证。
  8. 单击屏幕顶部的邮件打开菜单。单击Inventory。确保所购商品出现在物品库中。
  9. 单击Get code。在打开的窗口中单击Request the code。记录收到的帐户关联码。
  10. 前往UE演示Map。
  11. 输入收到的帐户关联码(见步骤9),然后单击Confirm
  12. 平台帐户即与主帐户完成关联。请确保所购商品出现在演示Map的物品库中。
  13. 由于帐户现在已经与主帐户关联,因此可从该帐户获得帐户关联码。单击Get linking code。记录收到的关联码。
  14. 将演示Map设置为通过其他平台帐户登录应用程序(见步骤2)。Publishing platform需与步骤2中所选的平台不同。
  15. Content Browser > Xsolla Content > Maps文件夹启动Demo演示Map。
  16. 确保玩家物品库为空。
  17. 单击Account linking。然后留在UE演示Map中。
  18. 输入收到的帐户关联码(见步骤13),然后单击Confirm
  19. 该新平台的帐户即也与主帐户完成关联。请确保所购商品出现在UE演示Map的物品库中。

请按照高级诀窍的说明为您的项目配置帐户关联。