抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台

PC 抖音小游戏接入指南

收藏
我的收藏

接入说明

抖音小游戏目前已支持在 PC 端游玩体验,游戏的线上包可直接运行在 PC 抖音客户端上,但为了 PC 端更好的游戏体验,本文会指引开发者为 PC 端进行专项的优化和适配。

支持范围

支持的客户端版本

客户端
支持版本
Mac 抖音
暂不支持
Windows 抖音
>= 6.8.0

支持的游戏方案

方案
是否支持
普通小游戏(cocos/laya/egret/原生)
Unity WebGL
Unity Native

来源判断

游戏内如果有需要判断 PC 抖音或者系统的场景,可以使用以下方式:
    1.判断环境:根据 tt.getSystemInfoSync 返回的 appName 判断,PC 抖音作为新宿主会返回 douyin_web
    2.判断系统:根据 tt.getSystemInfoSync 返回的 platform 判断,会返回当前的系统,如 windows
    3.判断场景值:根据 tt.getLaunchOptionsSync 返回的 scene 判断,PC 抖音各个入口的场景值参考 场景值列表

能力支持

PC 已支持游戏常用的能力,但有部分能力在 PC 无法适配或者表现与移动端存在差异:
能力
接口
表现
广告
目前抖音 PC 未支持广告能力,调用广告相关接口时会返回不支持的错误信息和错误码。
支付
支付接口与 Android 一致,但支持钻石支付,详细说明见接口文档。
订阅
订阅该小游戏能力建设中。
收藏
收藏该小游戏能力建设中。
录屏
暂不支持小游戏内的录屏和录屏分享功能。
分享
暂不支持小游戏分享、转发功能。
群聊
暂不支持从小游戏内拉起群聊功能。
日历
暂不支持从小游戏内拉起日历、设置日历等功能。
扫码
暂不支持小游戏内扫码能力。
侧边栏
PC端不支持跳转侧边栏能力。
震动
PC端不支持震动体验。
陀螺仪
PC端不支持陀螺仪能力。
罗盘
PC端不支持罗盘能力。
麦克风
PC端不支持语音输入等操作。
相机
PC端不支持相机能力。
人脸检测
PC端不支持人脸识别等操作。
手势识别
PC端不支持手势识别等操作。
对于不支持的接口,抖音会自动弹出 toast 提示给到玩家,同时会返回特定错误码和错误信息给开发者:
errNo
errMsg
10301
%s:fail The feature is not supported in app
为了让 PC 端用户获得更好的小游戏体验,我们提供了下列额外接口与功能,可在适配 PC 端时选择使用:
能力
接口
说明
键盘
监听/取消监听键盘的点击事件
鼠标
监听/取消监听鼠标的点击事件
滚轮
监听/取消监听鼠标滚轮的滚动事件
光标
设置光标样式或者隐藏光标

调试方式

添加调试设备

在后台「开发-开发设置-测试管理-调试设备」处,添加账号到调试白名单;

IDE 打开抖音预览/调试

更新 IDE 到最新版本,在「预览-推送预览-使用 PC 端预览」处可以打开抖音并打开小游戏;

游戏上线

目前抖音小游戏仍在灰度测试中,命中灰度的小游戏会自动上线到 PC 抖音。
游戏上线后,命中灰度的玩家在 windows 抖音有侧导航小游戏和搜索入口,点击后使用与移动端一样的小游戏版本启动。

问题排查

如果游戏在 PC 调试发现无法正常运行,可以根据下面的能力说明进行自测和适配。

性能问题

可以参考 PC 性能优化文档 进行自查和优化;

Socket

tt.connectSocket PC 版本按 WebSocket 标准实现,对比移动端需要注意:
如果入参 protocols 传了子协议数组,那么服务端应该返回Sec-WebSocket-Protocol ,且取值与游戏发起连接时传的 protocol 取值一致,否则客户端会直接关闭连接。

Video

PC 小游戏使用 createVideo/createOffscreenVideo 接口时需要注意:Video 只支持 paintTo canvas2d context,不支持 paintTo WebGL context,请自行使用 webgl 纹理绘制视频。

音频

浏览器针对mp3mp4资源文件的请求默认会在 header 中带上accept-encoding=identity;q=1, *;q=0,服务器响应需要做好适配。
建议在 IDE 或者利用直播伴侣调试验证游戏运行正常后上线。

录屏/录音

录音/录屏基础能力已经支持,但有部分子功能暂不支持。例如不支持裁剪视频,生成的文件类型与移动端可能有出入等。

其他能力

游戏转发分享、收藏、群聊、侧边栏以及强依赖移动端设备的能力,如罗盘、加速度计等能力目前均不支持。
此类能力在进行调用时会出现相应的提示——“能力暂不支持”,理论上不影响游戏的正常游玩,如出现特殊情况请做针对性处理。