SyncSing Studio
Developers

雛形: C#(.NET Framework 4.8)の拡張機能

音量メーターを読んでパネルに出し、ボタン(パネル・Stream Deck の「拡張機能のコマンド」・ミニUI・ショートカット)で アプリに通知を出す、いちばん小さな拡張機能です。SDK(../../dotnet/SyncSing.Plugin.Sdk/ の SyncSingPlugin.cs と、全メソッドの型付き API SyncSingApi.g.cs)をソースのまま取り込むので、できあがりは EXE 1 つです。 全メソッドは client.Api.〇〇(引数名: 値) で呼べます(例: client.Api.NotifyShow(title: "…"))。

この雛形は 0BSD ライセンスです(LICENSE。自由にコピー・改変してよく、表示も要りません)。取り込む SDK は MIT です。

はじめに書き換えるところ

場所書き換え
manifest.json の uuid11111111-1111-4111-8111-111111111111 は見本です。サーバーが発行した UUID に変えてください(開発者モードで試すだけなら見本のままでも動きます。ほかの拡張機能と同じ UUID にはしないでください)
manifest.json の author.identity_idbuild.ps1 -IdentityId <あなたの Identity ID> で書き換わります(ID は 設定 → 拡張機能 の説明文に出ます)
manifest.json の name・description・author.nameあなたの拡張機能の名前・説明・作者名
my-first-plugin.csproj の AssemblyName と manifest.json の entry.pathEXE の名前(両方そろえる)
permissions使う権限だけ。要審査の権限(processing.control・player.control・tts.speak・overlay.draw・obs.write など)を入れると、配布に審査が要ります

試す

  1. .\build.ps1 -IdentityId <あなたの Identity ID> で dist\ ができます。
  2. SyncSing Studio → 設定 → 拡張機能 → 開発者モードを ON(開発者規約への同意が要ります)。
  3. 「開発フォルダを登録」で dist\ を選び、権限を許可します。ツール枠に「はじめての拡張機能」のカードが出ます。
  4. ログは 設定 → 拡張機能 → 「ログを開く」(plugins\<uuid>\logs\plugin.log)。標準出力・標準エラーもここに入ります。
  5. dist\bin\my-first-plugin.exe か dist\manifest.json を作り直すと、アプリが自動で再起動します。

アプリにつなぐ前に python ..\..\tools\syncsing_plugin.py test dist で、起動・hello・コマンドへの返事・呼んだメソッドの引数・終了まで確かめられます。

配る

python ..\..\tools\syncsing_plugin.py validate dist → pack dist → submit(sdk/README_JA.md を参照)。

この資料は開発キットに入っているものと同じ内容です。拡張機能の作成・配布には拡張機能 開発者規約が適用されます。