Skip to content

Commit

Permalink
BS-AutoSceneChangerで追加した機能に合わせて機能追加・修正
Browse files Browse the repository at this point in the history 
- 終了タイミングを finish/failタイミングに変更出来るようにした
- Menu, Gameイベントの発生タイミングの遅延機能追加
- 終了シーンをクリア、フェイル、ポーズに分けた
  • Loading branch information
@rynan4818
rynan4818 committed Apr 24, 2021
1 parent f9a4ade commit 72950ee
Show file tree
Hide file tree
Showing 2 changed files with 152 additions and 80 deletions.
29 changes: 18 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

※[Streamlabs OBS版はこちら](https://github.com/rynan4818/Streamlabs-obs-control)

※[XSplit Broadcaster用の同様ツールはこちら](https://github.com/rynan4818/BS-AutoSceneChanger)

## 使用方法

1. OBS Studioにobs-websocketをインストールします
Expand Down Expand Up @@ -59,23 +61,28 @@

6. オーバーレイの「js」フォルダにコピーした obs-control.js をメモ帳で開きます

先頭の以下の8行の内容を必要に応じて変更します。
先頭の以下の15行の内容を必要に応じて変更します。

デフォルト設定のまま使う場合は、メニューシーンのOBS Studioのシーン名を `BS-Game` ゲームシーンのシーン名を `BS-Menu` とします。

const obs_address = 'localhost:4444'; //基本的に変更不要
const obs_password = ''; //OBSにパスワード設定がある場合のみ設定
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_address = 'localhost:4444'; //基本的に変更不要
const obs_password = ''; //OBSにパスワード設定がある場合のみ設定
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の設定

7. あとは通常通りOBS Studioで記録・配信すればＯＫです。

BeatSaber起動直後のメニューシーン切り替えは発生しないので、手動でOBS Studioのシーン名をメニューシーンにしておくか１度プレイすれば切り替わります。

## ライセンス

本ツールのライセンスはMITライセンスを適用します
Expand Down
203 changes: 134 additions & 69 deletions js/obs-control.js
View file
Original file line number Diff line number Diff line change
@@ -1,88 +1,153 @@
const obs_address = 'localhost:4444'; //基本的に変更不要
const obs_password = ''; //OBSにパスワード設定がある場合のみ設定
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の設定要

var bs_menu_flag = true;
var obs;
const obs_address = 'localhost:4444'; //基本的に変更不要
const obs_password = ''; //OBSにパスワード設定がある場合のみ設定
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の設定

let now_scene;
let bs_menu_flag = true;
let end_event = '';
let obs;

function obs_connect() {
obs = new OBSWebSocket();
obs.connect({
address: obs_address,
password: obs_password
})
.then(() => {
console.log(`Success! We're connected & authenticated.`);

return;
})
.catch(err => { // Promise convention dicates you have a catch on every chain.
console.log(err);
});

obs.on('ConnectionClosed', (data) => {
setTimeout(() => {
obs_connect();
}, 3000);
});

// You must add this handler to avoid uncaught exceptions.
obs.on('error', err => {
console.error('socket error:', err);
});
obs = new OBSWebSocket();
obs.connect({
address: obs_address,
password: obs_password
})
.then(() => {
console.log(`Success! We're connected & authenticated.`);
obs.send('GetCurrentScene').then((data) => {
now_scene = data.name;
});
return;
})
.catch(err => { // Promise convention dicates you have a catch on every chain.
console.log(err);
});

obs.on('ConnectionClosed', (data) => {
setTimeout(() => {
obs_connect();
}, 3000);
});

// You must add this handler to avoid uncaught exceptions.
obs.on('error', err => {
console.error('socket error:', err);
});
}

obs_connect();

function obs_start_scene_change() {
obs.send('SetCurrentScene', {
'scene-name': obs_start_scene_name
});
function scene_change(name) {
if (name != now_scene) {
obs.send('SetCurrentScene', {
'scene-name': name
});
}
now_scene = name;
}

function obs_end_scene_change() {
obs.send('SetCurrentScene', {
'scene-name': obs_end_scene_name
});
function menu_scene_change() {
scene_change(obs_menu_scene_name);
}

function obs_game_scene_change() {
obs.send('SetCurrentScene', {
'scene-name': obs_game_scene_name
});
function game_scene_change() {
scene_change(obs_game_scene_name);
}

function obs_menu_scene_change() {
obs.send('SetCurrentScene', {
'scene-name': obs_menu_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);
}
}

0 comments on commit 72950ee

Please sign in to comment.