Mods Sample

用于展示与模组商城各类交互的示例

阅读时间5分钟

来自 Epic在线服务（EOS）SDK 的 模组示例（Mods Sample） 演示了 模组商城（Mod Marketplace） 的各种交互功能，包括:

  • 枚举所有可供应用使用的模组。
  • 枚举用户已安装的模组。
  • 安装或卸载模组。
  • 升级模组。

本文将带领你了解如何设置并运行模组示例，并对上述功能进行介绍。

开始之前

使用模组示例前，你需要准备好以下先决条件：

  • EOS-SDK.zip
  • 必须安装Epic Game商城启动器客户端
  • 一个Epic Game商城测试应用，并且必须在开发者门户上配置以下内容：
    • 产品ID（productid）
    • 沙盒ID（sandboxid）
    • 部署ID（deploymentid）
    • 客户端ID（clientid）
    • 客户端密钥（clientsecret）

Win64 / Win32上的设置方法

本节介绍了在Windows 32位和64位操作系统上编译并运行模组示例应用的方法。

在Win64 / Win32上编译模组示例应用

  1. 将 EOS-SDK.zip 解压缩到你选择的目录中。

  2. 导航到 \EOS-SDK\Samples\。

  3. 双击 Samples.sln。Visual Studio会在解决方案浏览器中打开它。

  4. 将 启动项目（StartUp Project） 设置为 模组（Mods） 项目。

  5. 打开 SampleConstants.h ，根据你的测试应用的参数更新 ProductId、SandboxId、DeploymentId、ClientCredentialsId 和 ClientCredentialsSecret。

  6. 选择解决方案配置。使用 Release_DX 或 Debug_DX

    在解决方案配置中选择Release_DX。

  7. 选择解决方案平台： x64 (Win64) 或 x86 (Win32)

    win64选择x64，win32选择x86

  8. 在 解决方案资源管理器 中，右键点击模组示例，并选择 编译（Build）。

    在Visual Studio中编译解决方案

  9. 编译成功后，你应该在 \EOS-SDK\Samples\Mods\Bin\Win64\Release_DX\ 目录中找到以下文件

    Win64/Release_DX目录中的EOS模组示例

你现在可以运行应用示例了。

在Win64 / Win32上运行模组示例应用

如需运行示例应用，你需要按照开始之前一节中的内容准备好先决条件，并且测试应用必须按照上文指示构建。你还必须安装启动程序并指向测试版本。请按照以下步骤运行该应用：

  1. 打开指向测试版本的启动程序，安装测试应用。

  2. 导航至你的本地EOS SDK： \EOS-SDK\。它应该包含你刚才构建的示例。

  3. 重新打开一个文件浏览器，找到测试应用的 安装位置。

  4. 在你的本地 EOS-SDK 中将下列文件复制到应用的安装位置：

    • \Mods\Bin\Win64\Release_DX\EOSSDK-Win64-Shipping.dll
    • \Mods\Bin\Win64\Release_DX\Mods.exe
    • \Shared\Assets\*.*
    测试应用的目录

  5. 在命令行工具中，用 cd 命令导航至 Mods.exe 的所在目录。例如： C:\Program Files\Epic Games\TestApp\Samples\Mods\Bin\Win64\Release_DX\

  6. 运行命令：start ./Mods.exe 可以打开示例应用

运行中的示例应用

图：上述设置完成后，模组示例的运行效果。点击查看大图。

示例应用程序将会打开，你可以继续进行测试。请参阅运行在示例应用程序获取更多信息。

MacOS上的设置方法

本节介绍了在MasOS上安装并运行模组示例应用的方法。

设置先决条件

如需在Mac上编译模组示例应用，你需要安装以下依赖项：

  • SDL2
  • SDL2_ttf
  • GLEW
  • cmake
  • gcc（通过Xcode的命令行工具）

以上是开始之前一节中所述要求外额外需要你准备的内容。

在MacOS上编译模组示例应用

  1. 将 EOS-SDK.zip 解压到你选择的目录。

  2. 在终端中，导航至 \EOS-SDK\Samples\Mods\。

  3. 打开 SampleConstants.h 并根据你的应用的参数来更新 ProductId、SandboxId、DeploymentId、ClientCredentialsId 和 ClientCredentialsSecret。

  4. 运行 ./Build.sh。

  5. 编译成功完成后，你会在 \EOS-SDK\Samples\Mods\Build\ 目录中找到编译好的新文件。

    “EOS-SDK\Samples\Mods\Build\”目录下的编译文件

你现在可以运行示例应用啦！

运行模组示例应用

  1. 打开指向测试版本的启动程序。

  2. 安装测试应用。

  3. 导航至你的本地EOS SDK： \EOS-SDK\。它应该包含你刚才构建的示例。

  4. 重新打开一个访达（Finder）窗口，找到测试应用的安装位置。

  5. 在你的本地 EOS-SDK 中将下列文件复制到应用的安装位置：

    • /Build/Mods
    • /Build/Assets/*.*
    Build/Assets 和 Build/Mods 目录的位置

  6. 在终端中，用 cd 命令导航至应用安装路径下的 Build 文件夹。例如： ~/Users/Shared/Epic Games/TestApp/Build/

  7. 打开示例应用，执行以下命令： ./Mods

运行中的示例应用

图：上述设置完成后，模组示例的运行效果。点击查看大图。

示例应用程序将会打开，你可以继续进行测试。请参阅运行在示例应用程序获取更多信息。

使用模组示例应用

如需通过 开发者验证工具 登录，请选择 开发者验证（Dev Auth） 选项并选择 登录（Log In）。登录后，模组示例应用会提供以下功能：

枚举所有模组

选中 枚举所有模组 后，你可以拉取应用可用的所有模组的信息，并用列表显示它们。列表还包含各个模组的安装状态（无论用户是否有权使用该模组）。用户可以 安装、更新 和 卸载 此视图中的模组。

“枚举所有模组”功能会显示某个应用程序的所有可用模组，包括那些用户没有权限使用的。

“枚举所有模组”功能会显示某个应用程序的所有可用模组，包括那些用户没有权限使用的。点击查看大图。

枚举已安装的模组

选中 枚举已安装的模组 后，会显示所有用户当前已安装的模组，并用列表显示它们。列表还包含各个模组的安装状态，包括用户是否有权使用该模组。用户可以通过此视图 更新 和 卸载 模组。

“枚举已安装的模组”功能会显示用户能为应用安装的所有模组，并让用户管理这些模组。

“枚举已安装的模组”功能会显示用户能为应用安装的所有模组，并让用户管理这些模组。点击查看大图。