抖音开放平台Logo
开发者文档
控制台
  • 下载
  • 概览
  • 开发辅助
  • 小游戏调试
  • 抖音云
  • 概览
    收藏
    我的收藏

    登录页

    小游戏开发者工具支持开发者使用手机号验证、邮箱&密码和抖音扫码登录,可以在 https://microapp.bytedance.com/ 注册账号。

    新建项目

    当满足以下条件可点击【+】创建一个新的小游戏。
    (1)已拥有一个字节跳动小游戏的 AppID
    (2)所登录的账号是该 AppID 所对应小游戏的开发者
    选择一个空目录,作为工程目录。当选择空目录时,可以选择是否在该目录下生成一个简单的项目。
    AppID 需要在小游戏开发者后台获取或者直接使用测试号(测试号只支持预览调试,不支持上传)。

    主界面功能介绍

    开发者主界面主要由工具栏、模拟器、编辑器、调试器四大部分组成

    工具栏

      编译:编译当前的小游戏项目
      刷新页面:刷新当前页面
      清除缓存:可以清除文件缓存、数据缓存、登录状态和授权数据
      上传:填入 app 版本号及更新日志,上传小游戏应用内容到服务器
      预览:生成二维码,预览已上传版本
      真机调试:生成真机调试的二维码,开发者使用抖音 APP 扫码后即可在安卓和iOS手机上进行断点调试。
      详情:展示当前小游戏的 appid、user_id、本地目录、文件系统、基础版本与编译版本,并可以设置是否校验网络请求的域名白名单
    💡 点击「模拟器」、「调试器」三个按钮可以隐藏/显示相应的模块,界面中至少有一个模块被显示

    模拟器

    模拟器可以模拟小游戏在客户端真实的逻辑表现,对于绝大部分的 API 均能够在模拟器上呈现出正确的状态。开发者可以选择不同的设备,调试小游戏在不同尺寸机型上的适配问题。

    编辑器

    编辑器模块内可以对当前项目进行代码编写和文件的添加、删除以及重命名等基本操作,并集成了 Git、插件等功能。
      文件格式:因 iOS 下仅支持 UTF8 编码格式,最新版本的开发者工具会在上传代码时候对代码文件做一次编码格式校验
      文件支持:工具目前可以支持市面上大部分文件类型的编辑以及图片文件的预览
      目录树:可以查看当前项目的目录结构

    调试器

    调试器包含如下功能模块:
      Console panel:开发者可以在此调试代码。
      Sources panel:Sources panel 用于显示当前项目的脚本文件,同浏览器开发不同,小游戏框架会对脚本文件进行编译的工作,所以在 Sources panel 中开发者看到的文件是经过处理之后的脚本文件,开发者的代码都会被包裹在 define 函数中,并且对于 Page 代码,在尾部会有 require 的主动调用。
      Network panel:Network Panel 用于观察和显示 request 和 socket 的请求情况。
      Storage panel:可以查看 Storage 存储情况。

    自定义编译条件

    编译条件会读取 project.config.json 中的 condition 字段下的相关配置,方便导入编译条件。点击工具栏的普通编译处,在下拉列表中,点击添加编译模式,会弹出填写编译条件窗口,添加自己的定制化的编译条件。在弹出的窗口中,添加模式名称,启动页面,启动参数(即通过 tt.getLaunchOptionsSync 获取的启动参数)以及进入场景几个字段,点击确认,生成新的编译条件。
    工具快捷键:
      Command + B(Windows: Ctrl + B):主动触发编译
      Command + R(Windows: Ctrl + R) :焦点在编辑器时,触发模拟器刷新,焦点在其他位置时,触发整个工作区刷新 。

    上传提审

    注意:平台新增审核预检,将基于接入规范检测游戏代码包中是否存在潜在驳回问题或缺失重点能力,帮助提高版本审核通过率。
    点击工具栏的“上传按钮”,填写版本号及更新日志,进入审核预检与上传流程。
    小游戏版本号规范建议:
    主版本号.子版本号 [.修正版本号];
    英文对照:Major_Version_Number.Minor_Version_Number[.Revision_Number];
      1.审核预检项目:将检测游戏内是否接入必接能力、重点推荐能力。若未接入必接能力,将导致版本上传失败;若未接入重点推荐能力,平台不会拦截版本上传,但会提示未接入重点能力。
    能力类型
    能力清单
    未接入是否会拦截上传
    检测原因
    必接能力
    侧边栏复访能力:点击查看接入指引
    侧边栏复访能力能带动小游戏大盘整体留存提升,平台要求所有小游戏都接入该能力。
    重点推荐能力
      1.添加至桌面:点击查看接入指引
      2.订阅消息:点击查看接入指引
      3.支付能力:点击查看接入指引
      4.广告能力:点击查看接入指引
    不会;
    会提示未接入重点能力
      添加至桌面、订阅消息能力能提升游戏留存,建议开发者接入;且有计划或正在进行广告投放的游戏,只有接入这些能力后才能获得商业化广告金;
      支付能力、广告能力作为游戏的变现能力,推荐所有具备相应资质的游戏都接入。
      2.审核预检原理:
    预检审核将检测开发者代码js文件中相关能力的调用。例如,必接能力侧边栏复访,要求开发者必须使用tt.navigateToScene 调用。其他重点推荐能力类似。
      3.多版本上传:为满足开发者多项目并行测试的需求,支持最多同时上传 25 个测试版本,上传时分为“默认通道”和“通道1-24”。
      a.未开启“选择测试通道”时,上传成功后,覆盖“默认通道”已有的测试版本
      b.开发者如需同时保留多个测试版本,可以开启“选择测试通道” ,并根据需求选择 默认通道 或 通道1 - 24 进行上传。上传成功后,将覆盖所选通道的测试版本。 默认通道 和 通道1 - 24 通道的测试版本互不影响。
      c.除开发者工具外,CLI 也支持指定测试通道进行上传。
      d.多测试版本能力只支持抖音、抖音极速版、抖音火山版(>=31.6.0)。如想在其他宿主上测试:
      需要保证默认通道上有上传测试版本。
      无论扫哪个测试通道的二维码,最终都只会打开默认通道上的测试版本,故请将要扫码体验的测试版本上传到默认通道。
      4.上传成功:上传完成后,进入抖音小游戏开发者平台,在版本管理页面进行版本提审。

    Lite模式

    更多Lite模式详情请参考文档

    设置

    设置页由以下功能组成模块组成: