Skip to content

About

わんコメのコメントログを使って、配信終了・続行投票をOBSに表示するWindows向けツール

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

配信終了投票くん

わんコメが保存したコメントログを読み取り、
視聴者による「配信終了 / 続行」の投票を集計して、OBSに表示するWindows向けツールです。

投票メーターやカウントダウンは、OBSのブラウザソースとして表示できます。

初期状態では、配信を自動停止しません。
通常利用では、投票の集計と表示だけを安全に使えます。


主な機能

  • わんコメが保存したコメントログを読み取って投票を集計
  • ツイキャス / Kick / Twitchのコメントを対象に利用可能
  • 1人1票
  • 同じ人が後から投票した場合は、新しい内容で上書き
  • ツイキャスの番号付き匿名コメントにも対応
  • 直近3分のローリング集計
  • 初期値20人以上かつ終了票70%以上でカウントダウン開始
  • 判定に必要な人数を1〜999人の範囲で変更可能
  • 投票パネルの表示位置を変更可能
  • カウントダウン大表示の位置を変更可能
  • X / Yをそれぞれ±500pxの範囲で微調整可能
  • OBS上にプレビューを出しながら表示位置を確認可能
  • カウントダウン中は大きな停止ボタンまたは任意のキーでキャンセル可能
  • OBSブラウザソースは通常時は透明
  • 必要なときだけ投票パネルやカウントダウンを表示
  • OBS停止機能は任意
  • OBS停止機能は初期状態ではOFF

安全上の重要事項

初期状態では配信を自動停止しません

初期状態では、カウントダウンが終了しても画面表示が変わるだけで、
実際の配信は停止しません。

通常利用では、OBS停止機能をOFFのまま使用してください。

投票の集計やOBSへの表示だけなら、次の設定は不要です。

  • OBS WebSocket
  • OBSのサーバーパスワード
  • OBS停止機能

OBS停止機能を使用する場合は、必ず配信外で動作確認してください。


対応サービスについて

このツールは、各配信サービスから直接コメントを取得するものではありません。

わんコメが保存したコメントログを読み取ります。

集計対象は次のサービスです。

  • ツイキャス
  • Kick
  • Twitch

実際に利用できるかどうかは、わんコメ側でそのサービスのコメントを取得し、
ログとして保存できるかどうかにも依存します。

Kickについて

Kickで使用する場合は、わんコメのKick対応版・ベータ版などが
必要になる場合があります。

Kickおよびわんコメ側の対応状況は今後変わる可能性があります。

最新情報は、わんコメ側の案内を確認してください。


必要なもの

  • Windows
  • OBS Studio
  • わんコメ

わんコメ側の設定

わんコメの

設定 → その他

で、次の項目をONにしてください。

  • コメントログを残す
  • ログをファイルとしても書き出し

コメントを受信すると、.log または .jsonl のログファイルが保存されます。


OBSへの登録

OBSに「ブラウザソース」を追加します。

ローカルファイル

配布フォルダー内の

03_OBSに入れる_overlay.html

を指定してください。

推奨サイズ

  • 1920 × 1080
  • 1280 × 720

通常時は透明なので、何も表示されなくても異常ではありません。

表示位置や見え方は、本体の「表示設定」からプレビューできます。


基本的な使い方

  1. わんコメでコメントログ保存を有効にする
  2. OBSに 03_OBSに入れる_overlay.html を登録する
  3. 02_起動する_配信終了投票くん.exe を起動する
  4. 「わんコメログを自動で探す」を押す
  5. 「監視中」と表示されることを確認する
  6. 必要に応じて「投票設定」「表示設定」を変更する

自動でログが見つからない場合は、手動でログファイルを選択できます。

詳しい使い方は、

01_最初に読む_使い方.txt

も確認してください。


投票コマンド

終了票

!寝ろ
!終了
!寝ろ
!終了

続行票

!続行
!まだ
!続行
!まだ

半角の ! と全角の ! の両方に対応しています。


投票者の判定

1人1票です。

同じ人が後から別の投票を送った場合は、
新しい投票内容で上書きされます。

ツイキャスの匿名コメント

ツイキャスの番号付き匿名コメントにも対応しています。

たとえば、

匿名コメント#12345
匿名コメント#67890

のように匿名番号が異なる場合は、
それぞれ別の投票者として集計します。


投票判定

初期状態では、

  • 判定に必要な人数:20人
  • 終了ライン:70%以上

です。

設定人数以上の投票が集まり、
終了票が70%以上になるとカウントダウンが始まります。

集計対象は直近3分です。


判定人数の変更

本体の「投票設定」から、

判定に必要な人数

を変更できます。

設定範囲は、

1〜999

です。

「保存」を押すと、再起動せずに反映されます。

「初期値に戻す」で20人に戻せます。
実際に確定するには「保存」を押してください。


表示位置の変更

本体の「表示設定」から、OBS表示位置を変更できます。

投票パネル

  • 右下
  • 左下
  • 右上
  • 左上

カウントダウン大表示

  • 中央
  • 上寄せ
  • 下寄せ

それぞれ、

  • X:-500〜+500px
  • Y:-500〜+500px

の範囲で微調整できます。

Xは正の値で右、負の値で左へ移動します。
Yは正の値で下、負の値で上へ移動します。

画面端では、表示が画面内に収まりやすいよう位置を制限します。


表示プレビュー

「表示設定」では、OBS上にダミー表示を出しながら位置調整できます。

投票パネルをプレビュー

投票メーターのダミー表示を出します。

カウントダウンをプレビュー

カウントダウンのダミー表示を出します。

位置プリセットやX / Yを変更すると、
保存前でもOBS上のプレビューに反映されます。

プレビューは、次の処理には影響しません。

  • 実際の投票
  • 実際のカウントダウン
  • OBS停止処理

「プレビュー終了」、保存、キャンセル、表示設定ウィンドウを閉じる操作で
通常表示へ戻ります。


カウントダウンの停止

終了条件を満たすと、カウントダウンが始まります。

カウントダウン中は、本体が前面に表示されます。

停止する場合は、次のどちらかを操作してください。

  • 本体の大きな赤い停止ボタンをクリック
  • キーボードの任意のキーを押す

通常時のキー入力では停止処理は動作しません。

一度キャンセルした後は、同じ投票状態が残っているだけでは
すぐにカウントダウンを再開しません。

「投票をリセット」した後、新しく条件を満たすと再び開始できます。


OBS停止機能

OBS停止機能は任意の上級者向け機能です。

通常利用ではOFFのままで問題ありません。

使用する場合は、本体の「OBS設定」で、

  • OBS連携
  • OBS停止

の両方をONにしてください。

両方が有効な場合のみ、カウントダウン完了時にOBSへ停止要求を送ります。


OBSのサーバーパスワードについて

ここで入力するパスワードは、

OBSの「ツール → WebSocketサーバー設定」にある認証用パスワード

です。

配信終了投票くん専用のパスワードではありません。

また、OBSの配信キーでもありません。

  • OBS側でWebSocket認証がONの場合のみ入力してください
  • 認証OFFの場合は空欄で構いません
  • 作者や第三者へ送る必要はありません

OBS停止機能を使用しない場合は、
この設定自体を触る必要はありません。


OBSに表示されない場合

通常時は透明です。

まず本体の「表示設定」からプレビューを表示して確認してください。

表示されない場合は、次の順で確認してください。

  1. OBSブラウザソースを再読み込み
  2. 03_OBSに入れる_overlay.html を指定し直す

アプリを更新した場合は、
更新版の overlay.html をOBSで指定してください。


Windows SmartScreenについて

本ツールのexeには電子署名がないため、
Windows SmartScreenの警告が表示される場合があります。

入手元を確認し、信頼できる場合のみ、

詳細情報 → 実行

を選択してください。

不安な場合は実行しないでください。


配布ファイル

配布ZIPには主に次のファイルが含まれます。

01_最初に読む_使い方.txt
02_起動する_配信終了投票くん.exe
03_OBSに入れる_overlay.html
config.json
overlay_state.json
利用規約.txt

配布用設定は安全な初期状態に戻して作成されます。

  • ログパス:空
  • 判定人数:20
  • OBS連携:OFF
  • OBS停止:OFF
  • OBSパスワード:空
  • overlay:通常時非表示
  • 表示位置:初期値

開発

依存パッケージのインストールとテスト:

python -m pip install -r requirements.txt -r requirements-dev.txt
python -m unittest discover -s tests

exeのビルド:

.\build_exe.bat

配布ZIPの作成:

python .\make_release.py

利用規約

本ツールには、
「マボロシ工房 配布ツール共通利用規約」
が適用されます。

最新版はこちらです。

https://github.com/CKYlab/maboroshi-kobo-terms

主な内容:

  • 個人・法人を問わず利用可能
  • 配信・動画・収益化利用可能
  • クレジット表記は任意
  • 自分自身で使用する目的での改変可能
  • 本ツールそのものの再配布は禁止
  • 改変版の再配布・販売は禁止
  • 自作したものと偽る行為は禁止

詳細は必ず最新の共通利用規約を確認してください。

第三者ライブラリ等が含まれる場合は、
それぞれのライセンス条件が優先されます。


制作

マボロシ工房

  • 昭和の乙女
  • 朔(ChatGPT)

企画・仕様検討・実装支援・ドキュメント整備を共同で行っています。


免責

本ツールは、すべての環境での動作を保証するものではありません。

OS、OBS Studio、わんコメ、各配信サービスなどの仕様変更により、
正常に動作しなくなる場合があります。

利用前に、必ず配信外で設定と動作を確認してください。

本ツールの利用または利用できなかったことによって生じた損害、
トラブル、データ消失その他の不利益については、
「マボロシ工房 配布ツール共通利用規約」に従います。

About

わんコメのコメントログを使って、配信終了・続行投票をOBSに表示するWindows向けツール

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages