From a6225ae1db85a73c545ace3e65fe925209cfe6a8 Mon Sep 17 00:00:00 2001 From: rynan4818 <14249877+rynan4818@users.noreply.github.com> Date: Sun, 25 Apr 2021 08:00:39 +0900 Subject: [PATCH] =?UTF-8?q?README=E4=BF=AE=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 71be7cd..61fc3d9 100644 --- a/README.md +++ b/README.md @@ -18,37 +18,41 @@ obs-websocket-＊.＊.＊-Windows-Installer.exe (*は最新バージョンを選択) をダウンロードしてインストールします - 2. OBS Studioを起動して「ツール」の「Websocketサーバ設定」を開いて「WebSocketsサーバを有効にする」をチェックします。 + 2. OBS Studioを起動してメニューの`ツール`にある`Websocketサーバ設定`を開いて`WebSocketsサーバを有効にする`をチェックします。また、サーバーポートが`4444`になっているか確認します。(4444と違う場合は、4444に修正するか後述する本ツールの設定でポート番号を指定します。) - 「認証を有効にする」をチェックすると、パスワード設定できますが + `認証を有効にする`をチェックすると、パスワード設定できますが その場合は後述する、本ツールのパスワード設定が必要です + ![preview](https://rynan4818.github.io/obs-control1.png) + 3. Beat Saber Overlay 改良版をインストールして使えるようにします 配布サイト:https://github.com/rynan4818/beat-saber-overlay インストールと設定方法は上記サイトに詳細があります。 - **注意点として `表示されていないときにソースをシャットダウン` と `シーンがアクティブになったときにブラウザの表示を更新` の２つはチェックしないで下さい** - オーバーレイ機能を使用しない場合は、OBS Studio上でオーバーレイを非表示にしてください (例えば、他のDataPullerとかのオーバーレイを使用している場合など) 非表示にしても、裏でOBSコントロール機能は動くのでOBS Studioのどこかのシーンのソースにオーバーレイを設定する必要があります + **注意点として `表示されていないときにソースをシャットダウン` と `シーンがアクティブになったときにブラウザの表示を更新` の２つはチェックしないで下さい** + + ![preview](https://rynan4818.github.io/obs-control2.png) + 4. 本ツールの[リリースページ](https://github.com/rynan4818/obs-control/releases)から最新リリースをダウンロードします。 5. 3.でインストールしたオーバーレイのフォルダに、本ツールのファイルをコピーしてください。 - - 「js」フォルダに、obs-control.js と obs-websocket.js の２つ - - インストールフォルダの index.htmlを本ツールの物に差し替え(上書き) + - `js` フォルダに、`obs-control.js` と `obs-websocket.js` の２つ + - インストールフォルダの `index.html` を本ツールの物に差し替え(上書き) 本ツールは、Beat Saber Overlay 改良版の[Release v2021/02/22](https://github.com/rynan4818/beat-saber-overlay/releases/tag/v2021%2F02%2F22)を元にしています。 - オーバーレイがそれ以外のバージョンになっている場合、index.htmlを上書きするとおかしくなる場合があります。 + オーバーレイがそれ以外のバージョンになっている場合、`index.html` を上書きするとおかしくなる場合があります。 - その場合は、インストールしたオーバーレイのindex.htmlをメモ帳で開いて、最後の方の + その場合は、インストールしたオーバーレイの `index.html` をメモ帳で開いて、最後の方の @@ -59,9 +63,9 @@ の２つを追加してください。 - 6. オーバーレイの「js」フォルダにコピーした obs-control.js をメモ帳で開きます + 6. オーバーレイの `js` フォルダにコピーした `obs-control.js` をメモ帳で開きます - 先頭の以下の15行の内容を必要に応じて変更します。 + 行頭が `const obs_` で始まる内容は必要に応じて変更します。 デフォルト設定のまま使う場合は、メニューシーンのOBS Studioのシーン名を `BS-Game` ゲームシーンのシーン名を `BS-Menu` とします。 @@ -85,9 +89,9 @@ ## ライセンス -本ツールのライセンスはMITライセンスを適用します +本ツールのライセンスは[MITライセンス](https://github.com/rynan4818/obs-control/blob/main/LICENSE)を適用します -本ツールに添付している obs-websocket.js は以下の物を使用しています。 +本ツールに添付している `obs-websocket.js` は以下の物を使用しています。 [obs-websocket-js](https://github.com/haganbmj/obs-websocket-js)