diff --git a/README.md b/README.md index 43e16d9..29951b2 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ ※[OBS Studio版はこちら](https://github.com/rynan4818/obs-control) +※[XSplit Broadcaster用の同様ツールはこちら](https://github.com/rynan4818/BS-AutoSceneChanger) + ## 使用方法 1. Beat Saber Overlay 改良版をインストールして使えるようにします @@ -59,6 +61,23 @@ ![preview](https://rynan4818.github.io/streamlabs-obs-control2.png) + const obs_token = ''; //StreamlabsOBSの設定の「リモートコントロール」の「詳細を表示」から「APIトークン」をコピーして''内に貼り付ける + const obs_uri = 'localhost'; //基本的に変更不要 + const obs_port = '59650'; //基本的に変更不要 + const obs_game_scene_name = 'BS-Game'; //ゲームシーン名 + const obs_menu_scene_name = 'BS-Menu'; //メニューシーン名 + const obs_game_event_delay = 0; //ゲームシーン開始タイミングを遅らせる場合に遅らせるミリ秒を設定して下さい。タイミングを早めること（マイナス値）はできません。[0の場合は無効] + const obs_menu_event_delay = 0; //ゲームシーン終了(メニューに戻る)タイミングを遅らせる場合に遅らせるミリ秒を設定して下さい。タイミングを早めること（マイナス値）はできません。[0の場合は無効] + const obs_menu_event_switch = false; //[true/false]ゲームシーン終了タイミングをfinish/failした瞬間に変更する場合は true にします。約1秒程度早まりますのでobs_menu_event_delayと合わせて終了タイミングの微調整に使えます。 + const obs_start_scene_duration = 0; //ゲームシーンに切り替える前に開始シーンを表示する時間(秒単位) [0の場合は無効] + const obs_start_scene_name = 'BS-Start'; //開始シーン名 ※使用時はobs_start_scene_durationの設定要 + const obs_finish_scene_duration = 0; //Finish(クリア)時にメニューシーンに切替わる前に終了シーンを表示する時間(秒単位) [0の場合は無効] + const obs_finish_scene_name = 'BS-Finish'; //Finish(クリア)用終了シーン名 ※使用時はobs_finish_scene_durationの設定要 + const obs_fail_scene_duration = 0; //Fail(フェイル)時にメニューシーンに切替わる前に終了シーンを表示する時間(秒単位) [0の場合は無効] + const obs_fail_scene_name = 'BS-Fail'; //Fail(フェイル)用終了シーン名 ※使用時はobs_fail_scene_durationの設定要 + const obs_pause_scene_duration = 0; //Pause(ポーズ)してメニューに戻る場合にメニューシーンに切替わる前に終了シーンを表示する時間(秒単位) [0の場合は無効] + const obs_pause_scene_name = 'BS-Pause'; //Pause(ポーズ)用終了シーン名 ※使用時はobs_pause_scene_durationの設定 + 6. あとは通常通りStreamlabs OBSで記録・配信すればＯＫです。 BeatSaber起動直後のメニューシーン切り替えは発生しないので、手動でStreamlabs OBSのシーン名をメニューシーンにしておくか１度プレイすれば切り替わります。 diff --git a/js/obs-control.js b/js/obs-control.js index 603a314..41eeb02 100644 --- a/js/obs-control.js +++ b/js/obs-control.js @@ -1,14 +1,24 @@ const obs_token = ''; //StreamlabsOBSの設定の「リモートコントロール」の「詳細を表示」から「APIトークン」をコピーして''内に貼り付ける -const obs_uri = 'localhost'; //基本的に変更不要 -const obs_port = '59650'; //基本的に変更不要 -const obs_game_scene_name = 'BS-Game'; //ゲームシーン名 -const obs_menu_scene_name = 'BS-Menu'; //メニューシーン名 -const obs_start_scene_duration = 0; //ゲームシーンに切り替える前に開始シーンを表示する時間(秒単位) [0の場合は開始シーンは無効になる] -const obs_start_scene_name = 'BS-Start'; //開始シーン名 ※使用時はobs_start_scene_durationの設定要 -const obs_end_scene_duration = 0; //メニューシーンに切替わる前に終了シーンを表示する時間(秒単位) [0の場合は終了シーンは無効になる] -const obs_end_scene_name = 'BS-End'; //終了シーン名 ※使用時はobs_end_scene_durationの設定要 +const obs_uri = 'localhost'; //基本的に変更不要 +const obs_port = '59650'; //基本的に変更不要 +const obs_game_scene_name = 'BS-Game'; //ゲームシーン名 +const obs_menu_scene_name = 'BS-Menu'; //メニューシーン名 +const obs_game_event_delay = 0; //ゲームシーン開始タイミングを遅らせる場合に遅らせるミリ秒を設定して下さい。タイミングを早めること（マイナス値）はできません。[0の場合は無効] +const obs_menu_event_delay = 0; //ゲームシーン終了(メニューに戻る)タイミングを遅らせる場合に遅らせるミリ秒を設定して下さい。タイミングを早めること（マイナス値）はできません。[0の場合は無効] +const obs_menu_event_switch = false; //[true/false]ゲームシーン終了タイミングをfinish/failした瞬間に変更する場合は true にします。約1秒程度早まりますのでobs_menu_event_delayと合わせて終了タイミングの微調整に使えます。 +const obs_start_scene_duration = 0; //ゲームシーンに切り替える前に開始シーンを表示する時間(秒単位) [0の場合は無効] +const obs_start_scene_name = 'BS-Start'; //開始シーン名 ※使用時はobs_start_scene_durationの設定要 +const obs_finish_scene_duration = 0; //Finish(クリア)時にメニューシーンに切替わる前に終了シーンを表示する時間(秒単位) [0の場合は無効] +const obs_finish_scene_name = 'BS-Finish'; //Finish(クリア)用終了シーン名 ※使用時はobs_finish_scene_durationの設定要 +const obs_fail_scene_duration = 0; //Fail(フェイル)時にメニューシーンに切替わる前に終了シーンを表示する時間(秒単位) [0の場合は無効] +const obs_fail_scene_name = 'BS-Fail'; //Fail(フェイル)用終了シーン名 ※使用時はobs_fail_scene_durationの設定要 +const obs_pause_scene_duration = 0; //Pause(ポーズ)してメニューに戻る場合にメニューシーンに切替わる前に終了シーンを表示する時間(秒単位) [0の場合は無効] +const obs_pause_scene_name = 'BS-Pause'; //Pause(ポーズ)用終了シーン名 ※使用時はobs_pause_scene_durationの設定 -var bs_menu_flag = true; +let now_scene; +let bs_menu_flag = true; +let end_event = ''; +let obs; const client = new StreamlabsOBSClient({ port: obs_port, @@ -18,42 +28,100 @@ const client = new StreamlabsOBSClient({ client.connect(); -function obs_game_scene_change() { - client.changeScene(obs_game_scene_name); +function scene_change(name) { + if (name != now_scene) client.changeScene(name); + now_scene = name; } -function obs_menu_scene_change() { - client.changeScene(obs_menu_scene_name); +function menu_scene_change() { + scene_change(obs_menu_scene_name); } -function obs_start_scene_change() { - client.changeScene(obs_start_scene_name); +function game_scene_change() { + scene_change(obs_game_scene_name); } -function obs_end_scene_change() { - client.changeScene(obs_end_scene_name); +function start_scene_change() { + if (obs_start_scene_duration > 0) { + scene_change(obs_start_scene_name); + setTimeout(game_scene_change, obs_start_scene_duration * 1000); + } else { + scene_change(obs_game_scene_name); + } } function op_songStart(data) { - if (bs_menu_flag) { - if (obs_start_scene_duration > 0) { - obs_start_scene_change(); - setTimeout(obs_game_scene_change, obs_start_scene_duration * 1000); - } else { - obs_game_scene_change(); - } - } - bs_menu_flag = false; + end_event = ''; + if (bs_menu_flag) { + if (obs_game_event_delay > 0) { + setTimeout(start_scene_change, obs_game_event_delay); + } else { + start_scene_change(); + } + } + bs_menu_flag = false; +} + +function end_scene_change() { + let end_scene_duration = 0; + switch (end_event) { + case 'finish': + end_scene_duration = obs_finish_scene_duration; + if (end_scene_duration > 0) scene_change(obs_finish_scene_name); + break; + case 'fail': + end_scene_duration = obs_fail_scene_duration; + if (end_scene_duration > 0) scene_change(obs_fail_scene_name); + break; + case 'pause': + end_scene_duration = obs_pause_scene_duration; + if (end_scene_duration > 0) scene_change(obs_pause_scene_name); + } + if (end_scene_duration > 0) { + setTimeout(menu_scene_change, end_scene_duration * 1000); + } else { + scene_change(obs_menu_scene_name); + } +} + +function menu_event() { + if (!bs_menu_flag) { + if (obs_menu_event_delay > 0) { + setTimeout(end_scene_change, obs_menu_event_delay); + } else { + end_scene_change(); + } + } + bs_menu_flag = true; } function op_menu(data) { - if (!bs_menu_flag) { - if (obs_end_scene_duration > 0) { - obs_end_scene_change(); - setTimeout(obs_menu_scene_change, obs_end_scene_duration * 1000); - } else { - obs_menu_scene_change(); - } - } - bs_menu_flag = true; + menu_event(); } + +function op_finished(data) { + end_event = 'finish'; + if (obs_menu_event_switch) menu_event(); +} + +function op_failed(data) { + end_event = 'fail'; + if (obs_menu_event_switch) menu_event(); +} + +function op_pause(data) { + end_event = 'pause'; +} + +function op_resume(data) { + end_event = ''; +} + +function op_hello(data) { + end_event = ''; + if (data.status.beatmap && data.status.performance) { + setTimeout(game_scene_change, 3000); + } else { + setTimeout(menu_scene_change, 3000); + } +} \ No newline at end of file