はじめてのLivedeckウィジェット:スターターキットからアップロードまで

スターターキットをダウンロードして編集し、ZIPでアップロードしてエディターでテストします。

6分で読めます 2026年11月4日更新

スターターキットは「Live Feed」という完成済みのウィジェットです。ギフト、フォロー、チャットをカードで表示し、いいねを数えます。これをもとに自分だけのウィジェットを作りましょう。

パッケージの中身

manifest.json

ウィジェットの名前、バージョン、サイズ、権限、設定

index.html

スタートページ。SDKと各ファイルを読み込みます。

style.css

見た目

app.js

ロジック:イベントに反応

README.md

クイックガイド

スタートページ

すべてのスタートページは、パス /sdk/v1.js からSDKを読み込みます。SDKはLivedeckがウィジェットのアドレスで配信するため、パッケージに含める必要はありません。その他のファイルはすべて相対パスで読み込んでください。

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;
});

ウィジェットが受け取れるのは、manifest.json の permissions で要求したイベントだけです。上の例では events.gift と events.follow です。

ZIP化してアップロード

  1. あとでバージョンを区別できるよう、manifest.json の version を上げます(例:1.0.0 → 1.0.1)。
  2. ファイルをZIPにまとめます。manifest.json はZIPの最上位、またはすべてを含む1つのフォルダ内に置く必要があります。Windows:ファイルを選択 › 右クリック › 送る › 圧縮(zip形式)フォルダー。Mac:ファイルを選択 › 右クリック › 圧縮。
  3. ダッシュボードで:エディター › マイウィジェット › 「自作をアップロード」。初回は開発者プロフィールを作成し、ルールに同意します。
  4. 約1分でチェックが完了します。通らなかった場合は、すべての理由がファイルと行番号、または測定値とともに表示されます。修正して新しいZIPをアップロードしてください。
  5. ウィジェットをキャンバスに配置し、設定内のテストボタン(ギフト、チャット、いいねなど)で試してみましょう。
ヒント:ファイル名には a〜z、数字、ハイフン、アンダースコアのみを使ってください。__MACOSX、.DS_Store、Thumbs.db などのシステムファイルはLivedeckが無視します。
注意:エディターやMarketplaceからのテストイベントは、livedeck.context.test = true と架空の視聴者付きで届きます。OBSリンクではこの値は false です。

この記事は役に立ちましたか?