你的第一个 Livedeck 小组件:从入门套件到上传

下载入门套件,修改后以 ZIP 上传,并在编辑器中测试。

阅读约 6 分钟 更新于 2026年11月4日

入门套件是一个名为“Live Feed”的完整小组件:它以卡片形式显示礼物、关注和评论,并统计点赞数。你可以在此基础上制作自己的小组件。

包里有什么

manifest.json

小组件的名称、版本、尺寸、权限和设置

index.html

起始页面,负责加载 SDK 和你的文件。

style.css

外观

app.js

逻辑:响应事件

README.md

快速指南

起始页

每个起始页都从路径 /sdk/v1.js 加载 SDK。Livedeck 会在你的 widget 地址下提供该文件,无需自己放进包里。其他文件一律用相对路径加载。

html
<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <link rel="stylesheet" href="style.css">
  <!-- Livedeck serves the SDK. Everything else lives in your package. -->
  <script src="/sdk/v1.js"></script>
</head>
<body>
  <div id="feed"></div>
  <script src="app.js"></script>
</body>
</html>

响应事件

js
function show(text) {
  const line = document.createElement("p");
  line.textContent = text; // textContent, never innerHTML: names are viewer text
  document.getElementById("feed").prepend(line);
}

livedeck.on("gift", (e) => {
  // "@" + e.user.handle (username), e.gift.name, e.count, e.totalDiamonds
  show("@" + e.user.handle + " sent " + e.count + "× " + e.gift.name);
});

livedeck.on("follow", (e) => {
  show("@" + e.user.handle + " followed you");
});

livedeck.ready(() => {
  // The overlay is connected and the settings are here.
  document.body.style.color = livedeck.settings.accent;
});

widget 只会收到它在 manifest.json 的 permissions 中申请的事件。上面的示例中就是 events.gift 和 events.follow。

打包并上传

  1. 在 manifest.json 中提高版本号(例如从 1.0.0 改为 1.0.1),方便以后区分各个版本。
  2. 把文件压缩成 ZIP。manifest.json 必须位于 ZIP 的最顶层,或位于包含所有文件的唯一文件夹内。Windows:选中文件 › 右键 › 发送到 › 压缩(zipped)文件夹。Mac:选中文件 › 右键 › 压缩。
  3. 在控制台中:编辑器 › 我的 widget ›「上传自己的」。首次上传时需创建开发者资料并接受规则。
  4. 大约一分钟后检查完成。没通过?你会看到每个原因及对应的文件和行号,或测得的数值。修改后重新上传 ZIP 即可。
  5. 把 widget 放到画布上,用其设置中的测试按钮(礼物、聊天、点赞等)试一试。
提示:文件名只能使用 a 到 z、数字、连字符和下划线。Livedeck 会忽略 __MACOSX、.DS_Store 或 Thumbs.db 等系统文件。
注意:来自编辑器和 Marketplace 的测试事件带有 livedeck.context.test = true 和虚构的观众。在 OBS 链接中该值为 false。

这篇文章对你有帮助吗?