diff --git a/README.md b/README.md index 0547d47..38cc942 100644 --- a/README.md +++ b/README.md @@ -29,10 +29,31 @@ 2. プラグインをダウンロードする。 3. プラグインをサーバーに導入する。 4. `TalkWithNearPlayer/config.yml` に必要な項目を入力する。 - `discord.token` に `1.5` のトークンを入力する。 - その他のコンフィグは自由に設定をする。コマンドで設定することも可能。 + - `discord.token` に セクション `1.5` のトークンを入力する。 + - `discord.guild` に DiscordのサーバーIDを入力する。サーバー設定からウィジェットを選択し、サーバーIDをコピーする。 + - その他のコンフィグは自由に設定をする。コマンドで設定することも可能。 5. サーバーを起動する。 -6. 機能を利用するには必ずどこかのボイスチャンネルに入っている必要があるので注意する。 +6. 機能を利用する全てのプレイヤーがDiscordと連携させる。 + 1. `/twnp connect` をプレイヤーが実行する。 + 2. 表示された4桁の数字をDiscordのボットのDMに送る。 + 3. 認証に成功したことを確認する。 +7. 機能を利用するには必ずどこかのボイスチャンネルに入っている必要があるので注意する。 + +### 自動部屋分けモード + +1. `/twnpa mode Auto` を実行する。 +2. `/twnpa auto radius` で声が聞こえる範囲を設定する。 +3. `/twnpa auto player add` でオーナープレイヤーを追加する。 + オーナープレイヤーひとりに対して一つのボイスチャンネルが作成される。 +4. マインクラフトサーバー内で移動すると自動で切り替わるようになる。 +5. 自動で切り替わらない場合は、メンバーの取得が出来ていない可能性があるので、アイテムでのミュート切り替えでデバッグをする。 + +### アイテムを使ったミュート切り替えモード + +1. `/twnpa mode Item` を実行する。 +2. `/twnpa item` でミュート切り替え用のアイテムを入手する。 +3. ミュート切り替え用のアイテムでプレイヤーをクリックすることでミュートの切り替えを行える。 +4. エラーがあった場合、チャット欄に表示されます。 ## 動画や生放送で使用する場合