============================================================
DiscordBridgeJP 1.0.0 → 1.1.3 アップデート手順
============================================================

このファイルは、旧バージョン(1.0.0)から今回の更新(1.1.3)へ移行する際、
既存の設定ファイルに何を追記・移動すればいいかをまとめた手順書です。

同梱の以下3ファイルと合わせて使ってください。
  - update-config.yml.txt    (config.ymlの完成形サンプル)
  - update-bot.yml.txt       (bot.ymlの完成形サンプル、新規ファイル)
  - update-messages.yml.txt  (messages.ymlの完成形サンプル)

作業前に、必ず plugins/DiscordBridgeJP/ フォルダ全体をバックアップしてください。


------------------------------------------------------------
手順1: jarの差し替え
------------------------------------------------------------
plugins フォルダ内の古い DiscordBridgeJP-x.x.x.jar を削除し、
今回の DiscordBridgeJP-ver1.1.3.jar を配置してください。
この時点ではまだサーバーを起動しないでください(先に手順2〜4を終わらせます)。


------------------------------------------------------------
手順2: bot.yml の新規作成(最重要)
------------------------------------------------------------
1.0.0時点では bot-token や各チャンネルIDは全て config.yml の中にありましたが、
1.1.3では漏洩防止のため bot.yml という別ファイルに分離されました。

【今の config.yml から bot.yml へ「移動」する項目】
  bot-token
  guild-id
  chat-channel-id
  console-channel-id
  verify-channel-id
  command-log-channel-id  (無ければ新規、下記手順3参照)

手順:
  1. plugins/DiscordBridgeJP/ に bot.yml がまだ無いことを確認したら、
     一度サーバーを起動して自動生成させるか、update-bot.yml.txt の中身を
     bot.yml という名前で保存してください。
  2. 今の config.yml に書かれている bot-token・guild-id・各チャンネルIDの値を、
     新しく作った bot.yml の対応する項目にそれぞれコピーしてください。
  3. 移し終えたら、config.yml 側の bot-token・guild-id・各チャンネルIDの行は
     削除して構いません(残っていても読み込まれなくなるだけで実害はありません)。


------------------------------------------------------------
手順3: config.yml への追記
------------------------------------------------------------
以下のブロックは1.1.3で新設されたもので、旧config.ymlには存在しません。
update-config.yml.txt を参照しながら、該当箇所を config.yml に追記してください。

【まるごと新規追加するブロック】

  ・guild-leave: ブロック全体
    (Discordサーバー離脱検知の設定。enabled/rejoin-verify/login-check-enabled/
     login-check-exempt-groups の4項目)

  ・timeout-command: ブロック全体
    (timeout/removetimeoutコマンドのタブ補完設定)

【既存ブロックに項目だけ追加する箇所】

  ・maintenance: ブロックの中に、以下5項目を追加
      notify-join-leave
      notify-first-join
      notify-advancement
      notify-death
      notify-server
      chat-enabled
    (bypass-permission と reason は今の値をそのまま残してください)

  ・command-log-channel-id
    (1.0.0で既にある場合はそのまま bot.yml へ移動、無い場合は bot.yml に
     新規追加。デフォルトは "0"=無効)

【値は変わらないが、コメントの意味が変わった項目】

  ・require-link-for-new-players
    値(true/false)は変更不要ですが、true にした場合の挙動が変わっています。
    1.1.3では、連携解除(unlink)自体もブロック対象として扱われるようになりました。
    詳しい説明は update-config.yml.txt 内のコメントを参照してください。


------------------------------------------------------------
手順4: messages.yml の確認
------------------------------------------------------------
messages.yml の構造(notifications / maintenance / server 等)は
1.0.0から変更ありません。既存の messages.yml はそのままお使いいただけます。

もし見比べて不安な場合のみ、update-messages.yml.txt と見比べてください。


------------------------------------------------------------
手順5: 起動して確認
------------------------------------------------------------
1. bot.yml と config.yml の編集が終わったら、サーバーを起動してください。
2. コンソールにエラーが出ていないか確認してください。
3. ゲーム内で /discordbridgejp status を実行し、Botが接続済みか確認してください。
4. 問題なければ完了です。


------------------------------------------------------------
権限まわりの変更について(任意対応)
------------------------------------------------------------
1.1.3では、これまで discordbridgejp.admin 1つに集約されていた管理コマンドに、
コマンドごとの個別権限(discordbridgejp.command.reload 等)が追加されました。
discordbridgejp.admin を持つプレイヤーは今まで通り全コマンドを使えるため、
この対応は任意です。特定のコマンドだけを扱えるモデレーターを作りたい場合のみ、
LuckPerms等で個別の権限ノードを付与してください。詳細はModrinthのページ、
またはGitHub Wikiを参照してください。


------------------------------------------------------------
それでも分からない場合
------------------------------------------------------------
GitHubのIssueで報告してください。デバッグログ(config.ymlのdebug: trueで
出力されるログ)を添えていただけると対応が早くなります。


------------------------------------------------------------
なぜ自動で反映されないのか
------------------------------------------------------------
以前のバージョンには、新しい設定項目を起動時に自動で追記する機能があり
ましたが、「値を勝手に書き換えられるのは怖い」「意図しない項目が増える
のが分かりにくい」というご意見を受けて、この機能は廃止しました。
そのため1.1.3以降、新しい設定項目は今回のような手順書とサンプルファイル
を都度用意する形で、手動で反映していただく運用にしています。
お手数をおかけしますが、ご了承ください。


------------------------------------------------------------
このファイル・関連ファイルは削除して問題ありません
------------------------------------------------------------
このファイル(update-guide.txt)、および同梱の update-config.yml.txt・
update-bot.yml.txt・update-messages.yml.txt・update-guide-en.txt は、
あくまで今回のアップデート作業のための参考資料です。

手順に沿って設定ファイルを更新し、サーバーが正常に起動・動作することを
確認できたら、これらのファイルは plugins/DiscordBridgeJP/ フォルダから
削除していただいて構いません(削除してもプラグインの動作には一切影響
しません)。

