Streamer.bot
VfinityのイベントやクイックデッキのパッドからStreamer.botのアクションを実行する
PC上のStreamer.botとVfinityを接続すると、任意のイベントやクイックデッキのパッドからStreamer.botのアクションを直接実行できます。視聴者名、ギフト、チャットメッセージなどの情報も引数として引き渡せます。
VfinityはStreamer.botのWebSocketサーバーへクライアントとして接続します。Vfinityから接続する前に、Streamer.bot側でWebSocketサーバーを起動しておく必要があります。
Streamer.botを接続する
Streamer.botのWebSocketサーバーを起動する
Streamer.botでWebSocketサーバーを開始し、使用されているアドレス、ポート、パスワードを確認します。
Streamer.botカードを開く
Vfinityで 設定接続 を開きます。アプリ の下にある Streamer.bot カードを開き、Streamer.botに接続 をオンにします。
接続情報を入力する
Streamer.botの設定に合わせて IPアドレス と ポート を入力します。サーバーにパスワードが設定されている場合は、サーバーパスワード に入力します。
接続する
Streamer.botに接続 ボタンをクリックします。カードの状態が 接続済み に変わり、VfinityがStreamer.botのアクション一覧を取得します。
接続に失敗した場合、カードに 問題: とその詳細が表示されます。接続が切断された場合、Vfinityは間隔を少しずつ広げながら自動で再接続を試みます。起動時に接続 をオンにしておくと、Vfinityの起動時に毎回自動接続されます。
Streamer.botに接続 スイッチをオフにすると接続が終了し、再度オンにするまでVfinityはStreamer.botにアクセスしなくなります。
イベントからアクションを実行する
ステップを追加する
イベント タブでイベントを開き、ステップを追加 をクリックして Streamer.bot アクション を選びます。
アクションを選ぶ
URL / アクションID をクリックし、表示されたリストからアクション名を選択します。Vfinityはアクションの内部IDを保存します。IDを直接入力欄に貼り付けることも可能です。
必要に応じてリストを更新する
リストはStreamer.bot接続中に読み込まれます。接続後に新しいアクションを作成した場合は、アクションリストを更新 をクリックして反映してください。リストが読み込めない場合、ステップに 連携リクエストに失敗しました と表示されます。
保存してテストする
イベントを保存したら、行を右クリックして 今すぐテスト を選択し、視聴者のアクションを待たずにテスト実行します。
このステップは クイックデッキ のパッド内でも同様に動作するため、パッドを手動で押してStreamer.botのアクションを発動させることも可能です。ブループリントイベントでは、アクション ノードがこのステップを実行します。
アクションに詳細情報を渡す
JSONボディ / 引数 にはJSONオブジェクトを記述できます。Vfinityは文字列値内のプレースホルダーを展開した上で、Streamer.botのアクション引数として送信します。
{
"user": "{name}",
"gift": "{gift}",
"amount": "{count}",
"message": "{comment}",
"loud": true
}プレースホルダーはテキスト値の中で機能し、{name}、{gift}、{count}、{diamonds}、{comment} や、チャットコマンド用の {arg1} 〜 {arg9} が利用できます。数値や真偽値はそのまま渡されます。展開された各値は改行が空白に変換され、最大500文字で切り詰められるため、長文チャットでアクションが溢れるのを防ぎます。
引数を渡さない場合は {} のままにします。アクションIDが空の場合や、引数が正しいJSONオブジェクトでない場合、イベントは保存できません。
全プレースホルダーの一覧は テンプレート変数 を参照してください。
アクションが実行されない場合の確認
Streamer.botが未接続の場合、ステップは 連携が切断されています というエラーで失敗します。また、Streamer.bot側がリクエストを拒絶した場合も失敗します。どちらの場合も、同じイベント内の他のステップは中断されずそのまま実行されます。
Streamer.botが起動しているか、WebSocketサーバーが動作しているか、指定したアクションが削除されていないかを確認してください。確認後、イベントを右クリックして 今すぐテスト を選び、再試行してください。
パスワードの安全な保持
サーバーパスワード は設定ファイルとは別に、このPC内でのみ保持されます。バックアップ時に パスワードやトークンを含める にチェックを入れた場合のみバックアップに含まれ、サポート用ログを書き出す際にも伏字化されます。
逆方向の操作について
自作スクリプトや外部アプリからVfinityのコマンドやイベントを呼び出したい場合は、ローカルAPI を使用してください。