SDK使用说明

我的收藏

一、插件安装

•

下载 zip 包并解压后，将 ttsdk 和 ttsdk.editor 放到项目的addons目录，从 Project Settings 中勾选激活插件即可。

Godot 插件安装方法请参考官方文档

版本号	更新日期	更新说明	下载链接
1.0.1	2025/12/22	•fix：旧版本抖音加载卡住问题	douyin_godot_sdk_1.0.1_281137a.zip
1.0.0	2025/11/27		版本废弃不再使用

二、TTSDK 使用基础

•

示例工程：

douyin_godot_sdk_1.0.1_281137a.zip

1.接口说明

ttsdk 插件激活后会注入一个名为 tt 的全局对象（Autoload），SDK 接口都通过该对象提供。

`func is_run_in_tt() -> bool`

•

▪

当前是否运行在抖音小游戏环境中

`func mount_ttpkg_file(path: String) -> void`

•

说明

▪

访问包内文件之前须先调用 mount_ttpkg_file 将包内文件挂在到虚拟文件系统中

•

参数

▪

path

•

调用示例

tt.mount_ttpkg_file("in/package/file.pck")
ProjectSettings.load_resource_pack("in/package/file.pck")

2.调用开放能力

Godot TTSDK 对抖音小游戏 JavaScript API 进行了调用封装，相关接口说明直接参考 API 文档即可。

•

目前已支持的接口清单请查看 tt.gd，其余接口也会陆续上线。

•

代码示例：获取用户信息

extends Node
class_name CallTTSdkSample

func _on_button_pressed():
    var res = await tt.login()
    if res.is_success:
        res = await tt.get_user_info()
        if res.is_success:
            var user_info := res.get_result_success();
            print(user_info)

2.1 类型转换

•

通过 Godot SDK 调用 API 时，需要注意参数类型转换。具体规则如下：

◦

大部分情况下，SDK 已经替开发者完成了类型转换，有少数情况需要开发者自行关注

JS 类型	Godot 类型	是否直接使用	备注说明
`number`	`Variant`	直接使用	•JS 不区分 int 和 float
`string`	`String`	直接使用
`boolean`	`bool`	直接使用
`Object`	`JavaScriptObject`		•Godot -> JS 方向：向 SDK 传入 `Dictionary` 类型即可 •JS -> Godot 方向：没有显式标注为其它类型的，可以用 `TTUtils.dictionary_from_js` 方法转成 `Dictionary`
`Array`	`JavaScriptObject`		•Godot -> JS 方向：向 SDK 传入 `Array` 类型即可 •JS -> Godot 方向：没有显式标注为其它类型的，可以用 `TTUtils.array_from_js` 方法转成 `Array`
`Function`	`JavaScriptObject`		•Godot -> JS 方向：向 SDK 传入 `Callable` 即可
`ArrayBuffer`	`JavaScriptObject`		•暂无此类接口

•

举例说明

◦

tt.createBannerAd

▪

对应的 JavaScript API 方法签名为：

function createBannerAd (param: {
    adIntervals?: number;
    style?: { width: number; left: number; top: number };
    adUnitId: string;
  }): BannerAd;

▪

Godot 接口调用格式为：

# Godot API 调用
var param : Dictionary = {
    "adIntervals": 1,
    "adUnitId": "ad-unit-id",
    "style": {
       "width": 120
    }
}
# param 在 SDK 内部被转换为 JavaScriotObject
tt.create_banner_ad(param)

2.2 接口格式

•

遵循 Godot 代码风格，Godot API 均以 snake-case 格式命名；

◦

例如 JS 的 tt.createBannerAd 接口在 Godot 中通过 tt.create_banner_ad 方法进行调用。

•

Godot TTSDK 目前有 3 种接口调用格式，分别是 同步、异步、以及 signal；

◦

格式一：同步接口调用，所有同步返回的 JavaScript API 可以直接调用

var system_info := tt.get_system_info_sync()
print(system_info)

var banner_ad := tt.create_banner_ad({
    ""
})

get_tree().root.add_child(banner_ad)
banner_ad.on_load.connect(...)
banner_ad.show()
banner_ad.destroy()
banner_ad.queue_free()

◦

格式二：异步接口调用，Godot SDK 对异步返回的 JavaScript API 进行了二次封装（TTAsyncTask），开发者可以采用下面任意的格式进行调用，底层实现是相同的。

▪

以方法形式调用：使用 Dictionary 作为入参，不支持监听回调。请注意 Dictionary 内字段命名应与 JavaScript 接口文档定义保持一致（camel-case）

await tt.report_event({
    "event": "event-name",
    "extra": {
        "field 1": "abc"
    }
})

▪

以对象形式调用：提供显式的字段定义，支持监听回调，也支持协程格式

var task := await tt.login_async() # 方法名多了 _async 后缀

# 提供显式参数字段名，snake-case
task.force = true

# 协程格式调用
await task.invoke()
if task.is_success:
    var res := task.get_result_success();
else:
    print (task.get_result_fail())

var task: TTAsyncTask = await tt.login_manual()
# 非协程格式
task.invoke()
if task.is_done:
    if task.is_success:
        _on_login_success(task.get_result_success())
    else:
        _on_login_fail(task.get_result_fail()）
else:
    task.on_success.connect(_on_login_success, CONNECT_ONE_SHOT)
    task.on_fail.connect(_on_login_fail, CONNECT_ONE_SHOT)

◦

格式三：事件监听类接口，Godot SDK 对 onXXX/offXXX 格式的 JavaScript API 提供了 signal 封装。

tt.on_show.connect(_on_show)    # 对应 JavaScript tt.onShow 接口
tt.on_show.disconnect(_on_show) # 对应 JavaScript tt.offShow 接口

func _on_show(res: TT.OnShowRes) {
    print(res)
}

2.3 内存管理

•

调用 JavaScript API 时涉及到 Godot 与 JS 之间的内存交换，内存管理的关键是意识到 Godot 的内存对象管理是基于引用计数（RefCounted）而 JavaScript 则是基于垃圾回收的，Godot 引擎会在 JavaScriptObject 引用结束时释放 JS 对象。

•

通常情况下，开发者无需关注接口调用内存管理的细节。

◦

特别的，TTBannerAd 这类带生命周期的对象是基于 Node 实现的，开发者可以像普通节点一样管理其生命周期，这类对象需要开发者手段管理生命周期（在合适的实际调用 destroy）。

三、导出工具

Godot SDK 提供工具将 Godot 项目导出为抖音小游戏格式，导出后使用抖音开发者工具运行调试与上传发布
参考文档：
•抖音开发者工具 - 概览
•抖音开发者工具 - 下载
•抖音开发者工具 - 调试控制台
•抖音开发者工具 - 真机调试
•抖音开发者工具 - 版本上传

1.使用基础

•

激活 ttsdk 插件后，导出界面会新增 tt-minigame 导出平台，填写参数后点击导出项目，选择导出路径即可导出抖音小游戏项目。

•

注意事项：

◦

导出 pack 时应该剔除 addons/ttsdk.editor 目录；

◦

抖音小游戏暂不支持上传.pck文件，因此.pck在导出后会被 SDK 重命名为.bin（或.br，如果开启 brotli 压缩）。但 godot 代码中仍然可以使用.pck对文件进行加载；

▪

另外，导出的小游戏目录中仍然保留了.pck文件，该文件不会计入包大小计算，仅仅是为了下次仅导出 pack 时方便选择覆盖。

◦

暂不支持将 pack 导出成 .zip 格式（性能不如.pck）；

◦

暂不支持自定义导出模板；（附：SDK 内置导出模板构建）

custom.py.txt

2.导出参数说明

名称	类型	说明
`Douyin/App ID`	String	小游戏的 App ID
`Douyin/Canvas Resize Policy`	enum	同 Web 导出的 Canvas Resize Policy
`Douyin/Subpackage On`	bool	开启后 wasm 和 main pack 会被打进子包中用到 subpackage 能力时必须开启
`Douyin/Custom Game Js`	bool	开启后重复导出不会覆盖 game.js 文件自定义 game.js 时可以开启
`Douyin Debug/Remote Debugger On`	bool	开启远程调试，游戏启动后自动连接 godot 调试器
`Douyin Debug/Remote Debugger Url`	String	godot 调试服务地址，格式为 `ws://xx.xx.xx.xx:xxxx`
`Douyin Optimize/Brotli On`	bool	开启后，对 pack 进行 brotli 压缩
`Douyin Optimize/Brotli Policy`	enum	brotli 压缩策略

3.功能指引

3.1 使用 remote debugger 进行调试

•

在导出界面勾选 Remote Debugger On 参数可以使用 godot 调试器对小游戏进行调试。

•

连接调试器时，请确保以下几个事项：

•

1）godot debug 服务可以通过局域网进行访问；

◦

设置 Editor Settings -> Network -> Debug -> Remote Host 为局域网可访问地址

•

2）godot 调试服务已开启；

◦

勾选 Debug -> Keep Debug Server On

3.2 使用 brotli 对资源进行压缩

注意：brotli 对 godot pack 资源文件的压缩率取决于 pack 内资源的内容，具体情况因项目而异，请谨慎使用。

•

当出现包体过大的情况时，可以借助 SDK 提供的 brotli 压缩能力对资源进行压缩。

◦

Brotli Policy：

▪

Auto：根据 debug/release 自动选择

▪

Fast：compression level 5

▪

Size：compression level 9

•

经过 brotli 压缩后的资源后缀为 .br，但是在 godot 内仍然可以使用 .pck 进行文件加载。

3.3 使用分包能力加载资源包

•

当游戏的资源包较大时，可以使用分包策略将部分非首场景使用的资源打包到子包内，在运行时进行动态加载，从而达到缩短首场景启动耗时的效果。

•

SDK 提供了名为 tt-minigame-subpackage 的导出平台，来辅助完成资源分包过程。

•

使用示例：

1）在主包打包选项中，打开 Subpackage On 开关。

2）新增 tt-minigame-subpackage 平台预设并填写参数，其中：

◦

Project Config File 选择已导出的小游戏项目的 project.config.json 文件；

◦

Subpackage Name 是子包名称，后续用于子包的加载。

3）根据需要配置导出 Resource 清单，尽量不与主包发生重叠。

4）点击 Export PCK/ZIP，选择导出目录和导出文件名后点击保存。点击 Save 后会在小游戏工程中自动创建子包。

◦

可以将多个 PCK 导出进同一个子包内。

◦

注意导出的目标目录须是小游戏项目的子文件夹。

5）在代码里加载子包资源：

var packed_scene_res_path = "res://example/demos/audio/audio_effects.tscn"
if !ResourceLoader.exists(packed_scene_res_path):
        # 加载子包
    var task = await tt.load_subpackage({
        "name": "audio" # 子包名称
    })
    if !task.is_success:
        # 加载失败，打印错误信息
        printerr("failed to load subpackage", task.get_fail_result())
        return null
    # 子包内的资源文件的导出路径，使用小游戏工程根目录的相对路径
    var path = "subpackages/audio/data.pck"
    # 加载包内文件必须先调用 mount_ttpkg_file 接口
    tt.mount_ttpkg_file(path)
    # 加载 pack 资源文件
    if !ProjectSettings.load_resource_pack(path):
        printerr("failed to load resource pack");
        return null