概述

在 H5/网页浏览器游戏中集成Tudada服务的 SDK 使用指南

SDK 版本: 0.1.5 最后更新: 2026-03-30 目标读者: H5 网页游戏开发者 (Cocos Creator、Phaser、PixiJS 等) 支持平台: iOS、Android

概述

TudadaSDK 是用于在 H5/网页浏览器环境中连接游戏与Tudada服务的 SDK。它还提供与 WeChat Mini Game(wx) API 的旧版兼容，使 WeChat 游戏可以通过最少的修改移植到Tudada平台。新项目开发时请直接使用 TudadaSDK API。

主要特点

TudadaSDK 原生 API: 以 TudadaSDK.login() 形式直接调用（推荐）
WeChat API 兼容（旧版）: 为现有 WeChat 移植游戏提供 wx 对象兼容支持
自动初始化: SDK 加载后自动初始化，通过 waitForReady() 等待完成
TypeScript 支持: 通过 tudada-sdk-types npm 包提供类型自动补全
移动端优化: 在 iOS、Android 环境中提供最佳性能

API 调用方式

SDK 支持两种方式调用 API：

// 方法 1: TudadaSDK 直接调用（推荐）
TudadaSDK.login({
  success: (res) => console.log(res.code),
});

// 方法 2: wx 兼容调用（旧版 — 仅用于 WeChat 移植游戏）
wx.login({
  success: (res) => console.log(res.code),
});

wx 兼容旧版说明

通过 wx 对象的 API 调用是为现有 WeChat 游戏移植而提供的旧版兼容功能。

新项目必须使用 TudadaSDK 直接调用。

仅 v0.1.2 之前注册的 API 可通过 wx 对象使用。v0.1.3 起新增的 API（加速度计、checkFeature、getLaunchOptions 等）仅限 TudadaSDK 使用。

今后 wx 兼容功能仅进行维护，不会添加新功能。

wx 兼容 API 完整列表（v0.1.2 基准，已固定）

分类	API	类型
认证	`login`	异步
	`checkSession`	异步
	`getUserInfo`	异步
存储（同步）	`getStorageSync`	同步
	`setStorageSync`	同步
	`removeStorageSync`	同步
	`clearStorageSync`	同步
	`getStorageInfoSync`	同步
存储（异步）	`setStorage`	异步
	`getStorage`	异步
	`removeStorage`	异步
	`clearStorage`	异步
云存储	`getTudadaStore`	同步（实例）
系统信息（同步）	`getSystemInfoSync`	同步
	`getWindowInfo`	同步
	`getAppBaseInfo`	同步
	`getDeviceInfo`	同步
系统信息（异步）	`getSystemInfo`	异步
	`getWindowInfoAsync`	异步
	`getAppBaseInfoAsync`	异步
	`getDeviceInfoAsync`	异步
UI	`getMenuButtonBoundingClientRect`	同步
键盘	`showKeyboard`	异步
	`hideKeyboard`	异步
	`onKeyboardInput` / `offKeyboardInput`	回调注册
	`onKeyboardConfirm` / `offKeyboardConfirm`	回调注册
	`onKeyboardComplete` / `offKeyboardComplete`	回调注册
剪贴板	`setClipboardData`	异步
	`getClipboardData`	异步
设备	`vibrateShort`	异步
	`vibrateLong`	异步
生命周期	`onShow` / `offShow`	回调注册
	`onHide` / `offHide`	回调注册
	`exitMiniProgram`	异步
	`restartMiniProgram`	异步
音频	`createInnerAudioContext`	同步（实例）
广告	`showRewardedAd`	异步回调（推荐）
	`showRewardedAdAsync`	异步 Promise
	`createRewardedVideoAd`	同步（实例，旧版）

不支持的 API: 不支持 wx.request()、wx.downloadFile() 等网络 API，请直接使用浏览器 fetch/XMLHttpRequest。也不支持 wx.authorize()、wx.getSetting() 等 WeChat 专用权限 API。加速度计通过与 wx API（wx.startAccelerometer 等）不同的 TudadaSDK 独立接口（startAccelerometerSensor 等）提供，无法通过 wx 对象使用。广告（showRewardedAd、showRewardedAdAsync）也必须通过 TudadaSDK 实例直接调用。

概述​

主要特点​

API 调用方式​

概述

主要特点

API 调用方式