跳到主要内容
版本：v4

PC C++ SDK 接入概览

产品介绍​

TapSDK PC 版是专为通过 TapTap 启动器运行的 PC 游戏设计的 C++ SDK。 它提供了与 TapTap 平台深度集成的功能，包括用户授权、正版验证（买断制游戏）、一致性随机数等基础功能，与及合规认证、成就、排行榜、云存档、好友、多人联机等扩展功能。

基础功能​

启动校验​

  • 游戏所有权验证：验证用户是否拥有游戏

用户授权​

  • TapTap 登录授权：获取用户授权
  • 用户信息获取：查询用户当前授权的权限范围、获取用户 OpenID 等基础信息

正版验证（买断制游戏）​

  • DLC 所有权验证：检查用户是否拥有特定 DLC
  • DLC 商店展示：引导用户购买 DLC
  • 游戏、DLC 状态监控：监听游戏和 DLC 的可玩状态变化

一致性随机数​

  • 跨设备一致性随机数：确保在不同设备上运行应用时，生成相同的随机数序列

扩展功能​

合规认证​

  • 实名认证：通过 TapTap 客户端引导未实名用户完成实名
  • 游戏时间限制：限制未成年人的游戏时间
  • 充值额度限制：限制未成年人的付费额度

成就​

  • 成就解锁：支持普通成就直接解锁，以及分步成就按步长累加解锁。
  • 成就展示：在 TapTap 内打开成就展示页，玩家可查看成就及达成情况。

排行榜​

  • 分数上报：批量上报玩家在自定义维度上的分数
  • 榜单拉取：支持总榜 / 好友榜切换、按周期查询、分页
  • 当前用户排名：拉取当前用户排名，或获取用户相近分数
  • 打开榜单页：在 TapTap 内打开排行榜展示页

云存档​

  • 存档保存到 TapTap 云端：玩家可从任意设备读取存档继续游戏，避免因存档丢失导致玩家流失。

好友​

  • 关系列表：拉取玩家游戏内的互关好友/关注/粉丝列表，支持分页查询。
  • 未读消息数/新增粉丝数：拉取玩家在 TapTap 的未读消息数/新增粉丝数，以便游戏内展示。支持监听事件实时感知数量变化。
  • 用户名片：激活 TapTap 启动器的用户名片窗口，显示指定用户的基本信息。可在用户名片窗口执行关注、取关、邀上线操作。
  • 好友聊天：激活 TapTap 启动器的好友聊天窗口，与好友进行点对点聊天。支持文本、表情、图片等多种消息类型。
  • 邀请好友：激活 TapTap 启动器的邀请上线/邀请组队窗口，邀请指定好友启动游戏或加入指定队伍。

多人联机​

  • 房间管理：支持创建房间、自动匹配和加入指定房间，提供完善的房间内玩家管理功能。
  • 玩家通信：房间内玩家之间可以自由发送和接收消息，支持点对点通信和广播。开发者可以基于此开发状态同步游戏。
  • 高级特性：针对高实时性竞技游戏，SDK 还提供了帧同步功能，帧率 30 FPS。

环境要求​

  • 操作系统：Windows 7 或更高版本的 64 位操作系统
  • 运行环境：游戏必须通过 TapTap 启动器启动
  • 网络要求：需要网络连接
  • SDK 类型：动态链接库（DLL）

集成准备​

1. 获取开发者资源​

在开始集成前，您需要：

  1. 在TapTap 开发者中心注册开发者账号
  2. 创建游戏应用并在「你的游戏」→「游戏服务」→「应用配置」获取以下信息：
    • Client ID：应用的唯一标识符
    • Client Public Key：用于 SDK 初始化的公钥字符串

2. 下载 SDK​

访问 TapSDK PC C++ Releases 页面下载最新版本的 SDK。

SDK 包含以下文件：

  • taptap_api.h：初始化、注册回调、用户授权、正版验证、一致性随机数等基础功能 API 头文件
  • taptap_achievement.h：成就功能 API 头文件
  • taptap_cloudsave.h：云存档功能 API 头文件
  • taptap_compliance.h：合规认证功能 API 头文件
  • taptap_leaderboard.h：排行榜功能 API 头文件
  • taptap_onlinebattle.h：多人联机功能 API 头文件
  • taptap_relation.h：好友功能 API 头文件
  • taptap_api.dll：动态库文件（Windows）
  • taptap_api.lib：导入库文件（Windows）

基本集成步骤​

语言支持说明​

PC SDK 以动态链接库（DLL）形式提供，支持多种编程语言集成：

  • C++
    • 如果只需要用户授权、正版验证、一致性随机数等基础功能，请包含头文件taptap_api.h。具体集成方式，请参考快速开始。
    • 如果需要使用合规认证功能，请包含头文件taptap_compliance.h。具体集成方式，请参考合规认证快速接入。
    • 如果需要使用成就功能，请包含头文件taptap_achievement.h。具体集成方式，请参考成就快速接入。
    • 如果需要使用排行榜功能，请包含头文件taptap_leaderboard.h。具体集成方式，请参考排行榜快速接入。
    • 如果需要使用云存档功能，请包含头文件taptap_cloudsave.h。具体集成方式，请参考云存档快速接入。
    • 如果需要使用好友功能，请包含头文件taptap_relation.h。具体集成方式，请参考好友快速接入。
    • 如果需要使用多人联机功能，请包含头文件taptap_onlinebattle.h。具体集成方式，请参考多人联机快速接入。
  • 其他语言：通过各自语言的 DLL 调用机制实现。

添加 SDK 文件​

将下载的 SDK 文件添加到您的项目中：

C++ 项目：

#include "taptap_api.h" // 必须包含基础功能头文件
#include "taptap_achievement.h" // 如果需要成就功能
#include "taptap_cloudsave.h" // 如果需要云存档功能
#include "taptap_compliance.h" // 如果需要合规认证功能
#include "taptap_leaderboard.h" // 如果需要排行榜功能
#include "taptap_onlinebattle.h" // 如果需要多人联机功能
#include "taptap_relation.h" // 如果需要好友功能

其他语言：

  • 将 taptap_api.dll 放置在可执行文件同目录或系统路径中
  • 根据语言特性加载 DLL 并声明函数签名

文档结构​

本文档包含以下内容：

  1. 基础功能：SDK 基础功能集成、基础配置，与及详细 API 文档和使用示例
  2. 合规认证：实名认证、防沉迷、支付限额功能集成、详细 API 文档和使用示例
  3. 成就：成就功能集成、详细 API 文档和使用示例
  4. 排行榜：分数上报、榜单拉取、打开榜单页等功能集成、详细 API 文档和使用示例
  5. 云存档：云存档功能集成、详细 API 文档和使用示例
  6. 好友：关系列表、用户名片、好友聊天、邀请等功能集成、详细 API 文档和使用示例
  7. 多人联机：多人联机功能集成、详细 API 文档和使用示例

开始使用前，请先阅读快速开始了解集成流程。