-
Notifications
You must be signed in to change notification settings - Fork 0
Configuration
plugins/DiscordBridgeJP/config.yml の全設定項目です。
アップデートによる自動補完機能は廃止されています。 アップデートで新しい設定項目が増えても、既存ファイルへの自動追記は行われません。起動時に
plugins/DiscordBridgeJP/update-vX.X.X/フォルダが自動生成されるので、同梱のupdate-guide.txtの手順に従って手動で反映してください。
通知文言・Embed色・チャット表示形式などは config.yml ではなく Messages (messages.yml)で設定します。Botトークン・チャンネルIDは config.yml ではなく bot.yml にあります(下記参照)。
漏洩すると影響が大きい情報のため、config.ymlとは別ファイルに分離されています。GitHub等にソースを公開する場合は.gitignoreに追加することを推奨します。
| キー | 説明 |
|---|---|
bot-token |
Discord Developer Portal で取得したBotトークン。他人に公開しないこと |
guild-id |
Botを動かすDiscordサーバー(ギルド)自体のID |
chat-channel-id |
MC↔Discordチャット中継チャンネルID |
console-channel-id |
コンソールログ中継 / Discordからのコマンド実行チャンネルID |
verify-channel-id |
アカウント連携コード(!XXXXXXXX)を入力するチャンネルID |
command-log-channel-id |
プレイヤーコマンドログ専用チャンネルID。0で無効 |
いずれも導入手順は Installation を参照してください。
Discordのコンソールチャンネルでの発言を、サーバーコマンドとして実行する機能の設定です。
| キー | デフォルト | 説明 |
|---|---|---|
console-command.enabled |
false |
trueにすると console-channel での発言をMCコマンドとして実行する(強い権限のため要注意) |
console-command.role-id |
"0" |
上記を許可するDiscordロールID |
| キー | デフォルト | 説明 |
|---|---|---|
console-log-level |
"ALL" |
コンソールチャンネルに中継するログの範囲。ALL=全ログ / WARN_ERROR=WARN・ERRORのみ。Discordチャンネル内でコマンドを実行した場合、その実行結果はこの設定に関わらず常に表示されます |
| キー | デフォルト | 説明 |
|---|---|---|
language |
"ja" |
表示言語。lang/フォルダにあるYAMLファイルの言語コードを指定(ja、enなど) |
連携済みプレイヤーのDiscordロール色をMC側へ反映する設定です。
| キー | デフォルト | 説明 |
|---|---|---|
name-color.chat |
true |
チャット欄のプレイヤー名にロール色(フルカラー)を反映し、<名前>形式にする |
name-color.nametag |
true |
頭上のネームタグに反映(バニラ16色へ自動近似) |
name-color.tablist |
true |
タブリスト(プレイヤー一覧)に反映(フルカラー) |
name-color.cache-seconds |
300 |
Discordロール色をREST取得してからキャッシュする秒数 |
個別プレイヤー単位でON/OFFしたい場合は /discordbridgejp namecolor <on|off> <player> コマンドを使います。
| キー | デフォルト | 説明 |
|---|---|---|
chat-command.enabled |
true |
Discord側のテキストコマンド(!list等)を有効にするか |
chat-command.prefix |
"!" |
テキストコマンドの接頭辞 |
sticky-message.enabled |
true |
チャットチャンネル下部に案内メッセージを固定表示する機能 |
| キー | デフォルト | 説明 |
|---|---|---|
link.code-expiry-seconds |
600 |
連携コードの有効期限(秒) |
link.delete-code-message |
false |
連携用チャンネルに貼られた本人のコードメッセージを、処理後にBotが削除するか |
link.unlink-mode |
"block" |
require-link-for-new-players: true 中の本人による unlink 実行時の動作。block=一般プレイヤーのunlinkコマンド自体を拒否(誤爆防止) / kick=unlink自体は許可し、下記の在籍確認・タイムアウト付与のうえキック |
link.multi-account.enabled |
false |
1つのDiscordアカウントに複数のMinecraftアカウントを紐づけられるようにするか |
link.multi-account.max-per-discord |
2 |
1つのDiscordアカウントに紐づけられるMinecraftアカウントの上限(multi-account.enabled時のみ有効) |
| キー | デフォルト | 説明 |
|---|---|---|
require-link-for-new-players |
false |
true=連携必須化モード。初参加(過去にこのサーバーへ入ったことのない)プレイヤーに連携を必須化する。未連携の場合は接続時にキック画面でコードが表示される。加えて、連携解除(unlink)自体もブロック対象として扱われるようになり、非除外対象者(OP・login-check-exempt-groups所属者を除く)は連携解除と同時にタイムアウトが付与されキックされる(再ログインには連携が必要)。false=連携任意モード。初参加も連携解除も自由で、キック・タイムアウトは一切発生しない |
連携済みプレイヤーがDiscordサーバーを抜けたことを検知し、次回ログインをブロックする機能です。
| キー | デフォルト | 説明 |
|---|---|---|
guild-leave.enabled |
true |
この機能自体のON/OFF。falseにすると、既に付与されているタイムアウトも一括で解除される |
guild-leave.rejoin-verify |
true |
Discordサーバーに再参加した際、念のため確認コードを発行して再認証させるか。falseなら再参加を検知した時点で自動的にタイムアウトを解除する |
guild-leave.login-check-enabled |
true |
ログインを試みるたびに、そのプレイヤーのDiscord在籍状況をリアルタイムで確認するか。バニラ管理者(OP)以外は参加のたびにDiscordへ問い合わせが発生する(数秒待たされる場合がある)。Bot接続時の一括チェックだけでは拾いきれない「Bot切断中に離脱していた」ケースも確実にブロックしたい場合はtrueのままにする |
guild-leave.login-check-exempt-groups |
[] |
LuckPerms導入時のみ有効。指定したグループ名(複数可、例: ["admin", "moderator"])に所属するプレイヤーは、タイムアウト自体は付与されるがキック/ログインブロックはされない。グループから外れた時点で次回ログインからブロックされる |
/discordbridgejp timeout / removetimeout / unlink <player> コマンドのタブ補完設定です。
| キー | デフォルト | 説明 |
|---|---|---|
timeout-command.tab-complete-mode |
"all" |
online=オンラインプレイヤーのみ候補に出す / all=サーバー参加経験のある全プレイヤーを候補に出す(オンラインを上位表示) |
/discordbridgejp maintenance on [理由] で即時切替・保存されます。手動でconfig.ymlを編集することもできます。
| キー | デフォルト | 説明 |
|---|---|---|
maintenance-mode |
false |
メンテナンスモードのON/OFF |
maintenance.bypass-permission |
"" |
メンテ中でも参加できるバイパス権限ノード。空ならOPのみ参加可能(LuckPerms等の権限プラグイン導入時のみ有効) |
maintenance.reason |
"" |
直近のメンテナンス理由。コマンドから自動保存されるが手動編集も可 |
maintenance.notify-join-leave |
false |
メンテ中、参加/退出通知をDiscordへ出すか |
maintenance.notify-first-join |
false |
メンテ中、初参加通知をDiscordへ出すか |
maintenance.notify-advancement |
false |
メンテ中、進捗達成通知をDiscordへ出すか |
maintenance.notify-death |
false |
メンテ中、死亡通知をDiscordへ出すか |
maintenance.notify-server |
true |
メンテ中、サーバー起動/停止通知をDiscordへ出すか(メンテ中でも起動・停止は把握したいことが多いためデフォルトtrue) |
maintenance.chat-enabled |
false |
メンテ中、MC↔Discordのチャット中継を行うか |
AdvancedBanと連携してBANを双方向に同期します。
| キー | デフォルト | 説明 |
|---|---|---|
ban-sync.mc-to-discord |
true |
MinecraftでのBANをDiscordへ反映するか |
ban-sync.discord-to-mc |
true |
DiscordでのBANをMinecraftへ反映するか |
ban-sync.unban-sync |
true |
BAN解除も同様に同期するか |
複数アカウント連携時は、紐づく全Minecraftアカウントに対してBAN/解除が反映されます。
| キー | デフォルト | 説明 |
|---|---|---|
recognize-legacy-discordsrv-permissions |
true |
discordsrv.silentjoin / discordsrv.silentquit 権限(SuperVanishJP等が付与)も discordbridgejp.* と同等に扱うか。SuperVanishJPとの互換性のための設定 |
| キー | デフォルト | 説明 |
|---|---|---|
debug |
false |
trueにすると、Webhook送信やロール色反映などの詳細ログをコンソールに出力する。動作確認・トラブルシューティング時に使用 |
設定変更後は /discordbridgejp reload で反映できます(Botの再接続を伴います)。