/TalkWithNearPlayer

Talk With Near Player Using Discord, Spigot Plugin.

Primary LanguageKotlin

TalkWithNearPlayer

EasySpigotAPI

機能

自動部屋分けモード

Youtubeで開く

部屋のオーナープレイヤーを設定することでそのプレイヤーの付近では話せるようになる。

アイテムを使ったミュート切り替えモード

Youtubeで開く

専用のアイテムでプレイヤーをクリックすることでミュートを切り替えることができる。

導入

  1. https://discord.com/developers/applications でボットを作成する。
    1. New Application をクリック。
    2. NAME にボットの名前を入力。
    3. 左のタブから Bot を選択。
    4. Add Bot を押す。
    5. TOKEN セクションの Copy をクリックしてどこかにメモっておく。(config.yml の discord.token に入力する。)
    6. 左のタブから OAuth2 を選択。
    7. SCOPES から bot を選択。
    8. BOT PERMISSIONS から Administrator を選択。
    9. SCOPES に表示されているURLをコピーし、アクセスする。
    10. 導入するDiscordサーバーを選択する。
  2. プラグインを ダウンロード する。
  3. プラグインをサーバーの plugins に追加する。
  4. サーバーを起動し、コンフィグファイルを生成させる。
  5. TalkWithNearPlayer/config.yml に必要な項目を入力する。
    • discord.token に セクション 1.5 のトークンを入力する。
    • discord.guild に DiscordのサーバーIDを入力する。サーバー設定からウィジェットを選択し、サーバーIDをコピーする。
    • その他のコンフィグは自由に設定をする。コマンドで設定することも可能。
  6. サーバーを再起動する。
  7. /twnpa check bot でボットの状態を確認する。問題があるようなら指示に従って変更を加えてください。
  8. 機能を利用する全てのプレイヤーがDiscordと連携させる。
    1. /twnp connect をプレイヤーが実行する。
    2. 表示された4桁の数字をDiscordのボットのDMに送る。
    3. 認証に成功したことを確認する。
  9. /twnpa check player を実行することで連携の確認をすることができる。
  10. 機能を利用するには必ずどこかのボイスチャンネルに入っている必要があるので注意する。

自動部屋分けモード

  1. /twnpa mode Auto を実行する。
  2. /twnpa auto radius で声が聞こえる範囲を設定する。
  3. /twnpa auto player add でオーナープレイヤーを追加する。 オーナープレイヤーひとりに対して一つのボイスチャンネルが作成される。
  4. マインクラフトサーバー内で移動すると自動で切り替わるようになる。
  5. 自動で切り替わらない場合は、メンバーの取得が出来ていない可能性があるので、アイテムでのミュート切り替えでデバッグをする。

アイテムを使ったミュート切り替えモード

  1. /twnpa mode Item を実行する。
  2. /twnpa item でミュート切り替え用のアイテムを入手する。
  3. ミュート切り替え用のアイテムでプレイヤーをクリックすることでミュートの切り替えを行える。
  4. エラーがあった場合、チャット欄に表示される。

動画や生放送で使用する場合

以下の内容を概要欄に必ず載せるようにしてください。

製作者: sya_ri
配布リンク: https://github.com/sya-ri/TalkWithNearPlayer/releases

コンフィグ

config.yml

discord:
  token: "" # ボットのトークン
  guild: 0 # 稼働させるDiscordサーバーのID
mode: Item # モード(Auto, Item)
item: # mode == Item : ミュート切り替えアイテムの設定
  type: SLIME_BALL # アイテムマテリアル
  name: "&aミュート切り替え" # アイテム名
auto: # mode == Auto : 自動部屋移動の設定
  radius: 5 # 声が聞こえる半径
  player: [] # 部屋のオーナー
  category: null # 自動生成されるチャンネルを入れるカテゴリーのID

player.yml

<name>: # uuid と一致している必要はなく、好きに決めて良い。
  uuid: "" # プレイヤーのUUID
  discord: 0 # 連携するDiscordアカウントのID

コマンド

/twnp

/talk-with-near-player というコマンドの省略形。通常プレイヤー向けのコマンド。

コマンド 説明
/twnp connect Discordと連携する。
/twnp disconnect Discordとの連携を解除する。

/twnpa

/talk-with-near-player-admin というコマンドの省略形。設定・管理用のコマンド。

権限名 説明
twnp.admin /twnpa コマンドの実行権限
コマンド 説明
/twnpa check bot ボットの状態を確認する。
/twnpa check player 連携済みのプレイヤーを表示する。
/twnpa mode 現在のモードを表示。
/twnpa mode Auto 自動部屋分けモードに変更する。
/twnpa mode Item アイテムを使ったミュート切り替えモードに変更する。
/twnpa item ミュート切り替え用のアイテムを入手する。
/twnpa auto radius 自動部屋分けモードの声が聞こえる範囲を設定する。
/twnpa auto player add 自動部屋分けモードのオーナーを追加する。
/twnpa auto player remove 自動部屋分けモードのオーナーを削除する。
/twnpa auto player list 自動部屋分けモードのオーナー一覧を表示する。
/twnpa reload コンフィグのリロードをする。

開発者向け

Gradle Task

ktlintFormat

gradle ktlintFormat

ソースコードを綺麗にすることができる。

addKtlintFormatGitPreCommitHook

gradle addKtlintFormatGitPreCommitHook

Git Commit する時に ktlintFormat を実行する。

shadowJar

gradle shadowJar

Jar ファイルを生成する。build/libs フォルダの中に生成される。