跳到主要内容

开始接入

本文介绍如何快速接入世游发行平台，以及接入前的一些准备工作。

创建游戏​

世游运营人员请通过 KOA -> 行政办公 -> 金山世游系统权限申请 -> 世游发行平台 发起游戏创建申请。

申请通过后，运营人员可登录 世游发行平台 Console 完成游戏参数、发行版本等信息配置。

接入参数​

游戏创建完成后，会在世游发行平台生成游戏基本信息。

在游戏项目的对接过程中，您会使用到以下接入参数：

  1. 世游发行平台的 Endpoint
  2. 游戏的唯一标识 Game ID
  3. 一组 API 密钥 Build Key, Publishable Key, Secret Key
提示

新接入世游发行平台的游戏，请联系对接的运营人员获取这些接入参数。

环境要求​

通用环境要求​

  • Unity 2019.4.38 或更高版本
  • 团结引擎 1.6.0 或更高版本
  • API Compatibility 最低 .NET Standard 2.0

导出目标平台工程要求​

  • Android SDK 仅支持 Android 6.0 (API level 23) 及以上版本
  • 仅支持 IL2CPP
  • 仅支持 arm64
  • Gradle 仅支持 8.11.x 及以下版本（推荐 8.11.0）
  • 支持 Java 17 及以下版本（推荐 Java 17）
  • 导出 Android 工程后需要通过 命令行工具 CLI 初始化项目配置

获取 Combo SDK​

游戏客户端​

请从 更新日志 中下载最新版本。

游戏服务端​

信息

combo-sdk-go 是世游为 Go 提供的 SDK。

面向游戏服务端提供以下功能：

SDK 会将 API 的请求响应结构、签名计算与签名验证、HTTP 状态码等实现细节封装起来，提供 Go 的强类型 API，降低游戏侧接入世游系统时出错的可能性，提高接入的速度。

请从 更新日志 中获取最新版本。

项目集成​

SDK 目前仅支持手动导入。

将获取的 Combo SDK 解压后， 将 com.seayoo.sdk 文件夹拷贝到 Unity 项目的 Packages 目录下。

危险
  • 每次替换新版本请删除再替换 Packages/com.seayoo.sdk
  • 不要主动删除 Combo SDK 所包含的 meta 文件

Android​

通过 Unity 导出 Android 工程​

Build Settings

  • 勾选 Export Project。

Build Settings -> Player Settings -> Other Settings

  • Minimum API Level，确保 API level 设置为 21 或以上版本（Combo SDK 最低兼容 Android 版本为 Android 5.0）。
  • Scripting Backend，选择 IL2CPP。
  • Target Architectures，勾选 ARM64，同时取消勾选 ARMv7。
信息

在 Unity 导出 Android 工程时，Combo SDK 会通过 IPostGenerateGradleAndroidProject 进行项目导出的后处理工作，此过程将对导出工程的 AndroidManifest.xml 以及 build.gradle 等文件进行修改，以实现自动化配置相关依赖。详细内容请 参考 FAQ。

开始构建​

导出安卓工程后，使用 命令行工具 CLI 进行进一步的 Setup 配置和并完成构建。

更多内容请参阅 命令行工具 CLI。

iOS​

Combo SDK 支持两种集成方式，开发者可根据项目需求选择：

  • 方式 A：通过 Unity PostBuild 自动装配（需手动下载 iOS SDK）
  • 方式 B：通过 CLI 工具自动配置 Xcode 工程（无需手动下载 iOS SDK）
提示

Combo CLI 从v2.9.0 开始支持方式 B。已接入项目推荐升级至该版本或更高版本，以便直接使用方式 B 集成。

方式 A：Unity PostBuild 自动装配​

1. 下载 XCFrameworks 组件​
信息

请从 iOS 更新日志 中下载 iOS Combo SDK 的最新版本。

iOS Combo SDK 是组件化架构，组件详情如下：

组件名称是否必接组件描述
ComboSDK必接Combo SDK 核心组件，提供了对外接口和一系列通用功能和工具
ComboSDKSeayooAccount
必接金山世游统一账号认证系统
ComboSDKAppStoreConnect
必接苹果商店内购
- App Store Connect
ComboSDKSentry
必接Sentry 错误追踪系统
- Sentry iOS 7.31.5
ComboSDKSignInWithApple
可选Apple 账号登录
ComboSDKGuest可选游客账号登录
ComboSDKTopOn可选TopOn 广告聚合平台
- TopOn iOS 6.2.96
ComboSDKTrackingIO可选TrackingIO 广告监测平台
- TrackingIO 1.9.17
ComboSDKUpush可选友盟消息推送 SDK U-Push
- U-Push
ComboSDKBDASignal可选巨量引擎 SDK
- BDASignalSDK
ComboSDKAgora可选小红书分享 SDK
- XiaoHongShuOpenSDK
ComboSDKWeixin可选微信开放平台 SDK
- WechatOpenSDK
ComboSDKWeibo可选微博开放平台 SDK
- Weibo_SDK
ComboSDKDouyinOpen可选抖音开放平台 SDK
- DouyinOpenSDK
ComboSDKQQ可选腾讯 QQ 互联开放平台 SDK
- QQ SDK
ComboSDKSolarEngine可选热力引擎 SDK
- SolarEngine
ComboSDKDouyin可选抖音游戏全官服促活分账 SDK
- OSDK
ComboSDKDouyinUG可选抖音游戏全官服促活分账 SDK - 投广能力
ComboSDKTapTap可选TapTap 账号登录
- TapSDK
ComboSDKGDT可选广点通转化 SDK
- GDTAction SDK
2. 生成 SDK 参数文件​

通过 命令行工具 CLI 生成 ComboSDK.json 文件。

提示

若游戏需要集成 ComboSDKDouyinOpen，则还会生成 UOPSDKConfig.json 参数文件。

3. Unity 导出 Xcode 工程​

将 步骤1 中下载的 iOS SDK 产物解压后与 步骤2 中生成的 SDK 参数文件放在同一目录下。

集成 Combo SDK for Unity 后，在 Wizard 面板 Combo SDK Dir 中指定将该目录路径，构建过程中 Combo SDK 会自动装配参数文件和所需的 XCFrameworks 组件至 Xcode 工程中。

提示
  • Enable iOS PostBuild 默认为开启状态。
  • iOS PostBuild 会根据 ComboSDK.json 文件配置自动化装配所需的 XCFramework 组件，因此需要将下载的 所有 iOS XCFrameworks 都放入装配目录中。
  • 若不启用 Combo SDK iOS PostBuild，请使用方式 B 集成 iOS SDK。

img

iOS PostBuild 参数说明

ParameterRequiredTypeDescription
enableIOSPostBuildFalsebool是否开启 IOS PostBuild，默认为关闭
关闭 - 无法配置地址且不会开启该功能
开启 - 将参数文件和 XCFrameworks 自动装配至 Xcode Project
Combo SDK DirFalsestring包含 Combo SDK 参数文件及 XCFrameworks 组件的目录路径

方式 B：CLI 自动配置 Xcode 工程​

1. 导出 Xcode 工程​

在 Wizard 面板中取消勾选 Enable iOS PostBuild（该选项默认开启）后，从 Unity 构建 iOS Xcode 工程。

img

2. 执行 CLI 命令​

在 Xcode 工程根目录下执行 Combo CLI setup 命令： combo ios setup --xcode-autoconf。

Windows​

导入 Configuration 配置文件​

将通过 命令行工具 CLI 生成的 ComboSDK.json 文件并手动导入至 Unity 工程 ./Assets/Resources 目录下。

提示

若游戏对 ComboSDK.json 文件路径有特殊要求，可自定义该文件路径：

  • 创建 ./Assets/XXX/Resources/ 目录（XXX 可替换为自定义名称）。
  • 将 ComboSDK.json 文件放入该目录。
  • 在 Wizard/Windows 面板中指定 ComboSDK.json 文件的自定义路径。

img

导入 WebView 插件​

请联系世游技术团队获取 WebView 插件，并将其导入至工程中。

生成 .exe 执行文件​

构建产出 .exe 格式的可执行文件。

WebGL​

微信小游戏​

1. 集成微信小游戏提供的 Unity 插件​

将微信小游戏提供的 微信 Unity 插件 导入至项目工程中。

2. 使用微信转换工具导出微信小游戏工程​

按照微信提供的 适配方案 导出微信小游戏工程。

3. 生成 SDK 配置文件​

导出微信小游戏工程后，在微信小游戏工程的 minigame 目录下执行 CLI setup 命令，CLI 会在 minigame 目录下生成 combosdk 目录，combosdk 目录内包含 SDK 配置文件（ComboSDK.json）。

提示

使用 Combo CLI v2.18.0 或更高版本时，CLI setup 命令会自动下载并完成 SDK 产物的工程配置，因此可跳过 步骤 4 操作。建议升级至最新版本。

4. 下载 Combo SDK for WebGL​
信息

请从 WebGL 更新日志 中下载 Combo SDK for WebGL 的最新版本。

将下载的 WebGL SDK 产物解压后，放入到 步骤3 中生成的 combosdk 目录下。

5. 添加安全域名​

请登录 微信公众平台 开发者后台，进入 “开发 > 开发管理 > 开发设置”，在“服务器域名（request 合法域名）”一栏中添加游戏业务所需的安全域名。

抖音小游戏​

1. 集成抖音小游戏提供的 Unity 插件​

安装抖音小游戏提供的 抖音 Unity 插件。

2. 使用抖音转换工具导出抖音小游戏工程​

使用抖音 Unity 插件提供的抖音转换工具构建抖音小游戏工程。

3. 配置 SDK 配置文件及产物​

导出抖音小游戏工程后，在工程的 tt-minigame 目录下执行 CLI setup 命令，CLI 会在 tt-minigame 目录下生成 combosdk 目录，combosdk 目录内包含 SDK 配置文件（ComboSDK.json）及所需的 SDK 产物。

提示

抖音小游戏需要使用 Combo CLI v2.18.0 或更高版本。

4. 配置域名白名单​

在 抖音开放平台 开发者后台配置游戏业务所需的 域名白名单。

HarmonyOS​

1. 通过团结引擎导出 OpenHarmony 平台工程​

Build Settings

2. 开始构建​

导出 OpenHarmony 工程后，使用命令行工具 Combo CLI 进行构建。

更多内容请参阅命令行工具 Combo CLI。

初始化​

提示

导入 Combo SDK 后，需要通过菜单 ComboSDK/Wizard 配置参数

参数说明

ParameterRequiredTypeDescription
gameIdTrueString由世游侧为游戏分配，用于标识游戏的业务代号
publishableKeyTrueString由世游侧为游戏分配，游戏侧和世游侧共享的密钥
endpointFalseString游戏请求世游服务端的端点
若未指定该参数，则默认使用国内端点
国内 — https://api.seayoo.com
海外 — https://api.seayoo.io

img

接入功能​

Combo SDK 提供 账号与登录、内购与支付、游戏内广告、游戏内分享、数据分析、权限合规、错误追踪、防沉迷与实名认证 、更新唤起等多种功能。 请在 SDK 初始化完成后，根据项目需要，参考对应的功能文档，接入相应功能。 调用异步 API 前，请先阅读 异步 API 调用约束。

由于大部分功能都会包含登录，因此我们推荐从 账号与登录 开始接入。

最后于 更新