# SDK 配置
# 1、SDK 文件
Windows x64 运行目录至少包含以下文件:
Game.exe
DHSteamSDK.dll
steam_api64.dll
开发联调时可以在游戏 EXE 同目录放置 steam_appid.txt,文件内容为一行 Steam AppID,并且必须与 HostPlatformAppId 一致。正式通过 Steam 分发时不要发布开发用的 steam_appid.txt。
# 2、创建 SDK 句柄
#include "DHSteamSDK.h"
DHSteamSDKHandle *sdk = DHSteamSDK_Create();
if (sdk == nullptr) {
// 创建失败
}
DHSteamSDK_Create 没有参数,成功返回 SDK 句柄,失败返回 nullptr。创建句柄的线程为 SDK owner thread,后续句柄接口需要在该线程调用。
# 3、HostPlatform 配置
# 3.1、调用接口
int result = DHSteamSDK_SetHostPlatformParamJson(sdk, R"({
"DHAppId": "your-dh-app-id",
"DHChannelId": "your-dh-channel-id",
"DHInviteCode": "",
"HostPlatformAppId": "480",
"HostUrl": "debug",
"mainChannel": "100501",
"subChannel": "100502"
})");
必须在 DHSteamSDK_Init 前调用,初始化开始后不能切换配置。返回 0 表示配置解析成功,返回 1 表示 JSON 无效、必填字段缺失、AppID 或环境不合法、句柄无效或线程错误。
# 3.2、配置参数
| 参数 | 类型 | 必传字段 | 说明 |
|---|---|---|---|
DHAppId | string | 是 | 电魂开放平台分配的appId,不能为空。 |
DHChannelId | string | 是 | 电魂开放平台配置的渠道ID,不能为空。 |
DHInviteCode | string | 否 | 邀请码,未配置时传空字符串。 |
HostPlatformAppId | string | 是 | Steam AppID,必须是 1 到 4294967295 范围内的十进制数字。 |
HostUrl | string | 是 | 服务环境,默认为 debug。 |
mainChannel | string | 是 | 电魂开放平台配置的主渠道ID。 |
subChannel | string | 是 | 电魂开放平台配置的次渠道ID。 |
HostUrl 当前支持以下值:
| 值 | 说明 |
|---|---|
debug | 海外调试环境。 |
hongkong | 海外/香港正式环境。 |
chinaDebug | 国内调试环境。 |
china | 国内正式环境。 |
qiyuanDebug | 起源调试环境。 |
qiyuan | 起源正式环境。 |
# 3.3、设置存储目录
int result = DHSteamSDK_SetStoragePath(sdk, "C:/GameData/DHSteamSDK");
utf8_directory 为 UTF-8 本地目录。返回 0 表示接受,返回 1 表示目录为空、初始化已开始、句柄无效或线程错误。不调用时 SDK 使用 Windows 用户目录下的 DHSteamSDK 目录保存登录缓存、设备标识和待通知订单。
# 4、设置事件回调
void OnDHSteamEvent(const DHSteamSDKEvent *event, void *user_data);
int result = DHSteamSDK_SetEventCallback(sdk, OnDHSteamEvent, nullptr);
| 参数 | 说明 |
|---|---|
handle | DHSteamSDK_Create 返回的 SDK 句柄。 |
callback | 事件回调函数;传 nullptr 关闭回调。 |
user_data | SDK 原样传回回调的上下文指针,可以为 nullptr。 |
返回 0 表示设置成功,返回 1 表示句柄或线程错误。回调只在 owner thread 调用 DHSteamSDK_RunCallbacks 时触发。
# 5、设置网络诊断日志
DHSteamSDK_SetDebugLogLevel(sdk, DHSTEAMSDK_DEBUG_LOG_SAFE);
| level | 宏 | 说明 |
|---|---|---|
0 | DHSTEAMSDK_DEBUG_LOG_OFF | 关闭网络响应诊断事件。 |
1 | DHSTEAMSDK_DEBUG_LOG_SAFE | 输出脱敏网络诊断,开发联调推荐使用。 |
2 | DHSTEAMSDK_DEBUG_LOG_VERBOSE | 输出更完整的响应内容,可能包含敏感信息,不用于生产环境。 |
返回 0 表示设置成功,返回 1 表示设置失败。
← 其他接口 SDK 初始化(必接) →