diff options
| author | Sho Sakuma <me@m1sk9.dev> | 2026-08-30 13:54:28 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-08-30 13:54:28 +0900 |
| commit | b697f1cc341cbd9740daa2249c566f1b6bf1952d (patch) | |
| tree | 6d4d14a5f6cc07d28d8b85fdaedc32496e6f5988 /website/src/ja | |
| parent | 6e267a6a0426a5290c8f689c8333f1e9b35e87b7 (diff) | |
| parent | ebdb8d1940b41bab60d201eb6b0cd6f05efbc6ac (diff) | |
| download | LunaticChat-b697f1cc341cbd9740daa2249c566f1b6bf1952d.tar.gz LunaticChat-b697f1cc341cbd9740daa2249c566f1b6bf1952d.tar.bz2 LunaticChat-b697f1cc341cbd9740daa2249c566f1b6bf1952d.zip | |
Merge pull request #293 from m1sk9/feat/config-reload
feat: Add `/lc reload` command
Diffstat (limited to 'website/src/ja')
| -rw-r--r-- | website/src/ja/docs/configuration.md | 22 | ||||
| -rw-r--r-- | website/src/ja/docs/developers/platform-paper.md | 5 | ||||
| -rw-r--r-- | website/src/ja/docs/features/admin.md | 20 | ||||
| -rw-r--r-- | website/src/ja/docs/getting-started.md | 2 | ||||
| -rw-r--r-- | website/src/ja/docs/permissions.md | 1 | ||||
| -rw-r--r-- | website/src/ja/docs/reference/commands.md | 8 | ||||
| -rw-r--r-- | website/src/ja/docs/reference/message-format.md | 2 |
7 files changed, 57 insertions, 3 deletions
diff --git a/website/src/ja/docs/configuration.md b/website/src/ja/docs/configuration.md index 3324940..a2ae86f 100644 --- a/website/src/ja/docs/configuration.md +++ b/website/src/ja/docs/configuration.md @@ -8,7 +8,23 @@ LunaticChat の設定は `plugins/LunaticChat/config.yml` で管理されますï ## 設定の反映 -リロードコマンドはありません.`config.yml` を編集したら**サーバーを再起動**してください. +`/lc reload` <Badge type="tip" text="v1.4.0~" /> はサーバーの稼働中に `config.yml` を読み直します.反映されるのは [`messageFormat`](/ja/docs/reference/message-format) の設定のみです. + +ほかの設定は,どのサービスを構築するか・どのコマンドとリスナーを登録するか・どのファイルを開くかといった,プラグインの起動時に一度だけ決まる事柄を左右します.反映されたように見せかけることはせず,変更したもののうち稼働中のサーバーが取り込めない設定を一覧で表示するので,再起動が必要かどうかが分かります. + +``` +[LC] config.yml を再読み込みしましたが,一部の変更の適用にはサーバーの再起動が必要です. +``` + +応答は,編集した内容が反映されたかどうかだけを伝えます.どの設定が動いたかはサーバーログに記録されます. + +| | `/lc reload` で反映 | 再起動が必要 | +|---|---|---| +| `messageFormat.*` | はい | — | +| `features.*` | — | はい | +| `debug`, `checkForUpdates`, `language`, `userSettingsFilePath` | — | はい | + +このコマンドはプレイヤーのほかコンソール・RCON からも実行できます.`lunaticchat.command.lc.reload` (デフォルト: op) が必要です. 真偽値の設定は `true` / `false` のほか,Bukkit が従来受け付けていた `yes` / `no` / `on` / `off` の表記も使用できます.古いリリース向けに書かれたファイルもそのまま動作します. @@ -22,6 +38,10 @@ LunaticChat の設定は `plugins/LunaticChat/config.yml` で管理されますï `config.yml` を編集したあとはサーバーログを確認してください.デフォルトに戻された設定があれば,そこに報告されています. +`/lc reload` はこれよりも厳格です.起動時にはない選択肢 — 稼働中の設定をそのまま使い続ける — を取れるためです.デフォルトへのフォールバックは行わずファイルごと拒否し,読み取れなかった設定をすべてまとめて表示します.サーバーは元の設定を保持したままです.設定を 1 つも含まないファイルも同じ理由で拒否されます.コメントのみのファイルと,書き込み途中のファイルを見分けられないためです. + +**キー名**のタイポは,どちらの経路でも検出されません.新しいビルド向けに書かれた `config.yml` が古いビルドで壊れないよう,未知のキーは無視されるためです.リロードで反映対象が 1 つも見つからなかった場合は,成功としてではなく「変更なし」として報告されます.これがキー名を疑う手がかりになります. + ## グローバル設定 | キー | 型 | デフォルト | 説明 | diff --git a/website/src/ja/docs/developers/platform-paper.md b/website/src/ja/docs/developers/platform-paper.md index 26a9ad7..e291bcf 100644 --- a/website/src/ja/docs/developers/platform-paper.md +++ b/website/src/ja/docs/developers/platform-paper.md @@ -23,7 +23,7 @@ paper 側は「Bukkit / Folia という現実」を吸収するアダプタとã� `onEnable` の流れは次の通りです. -1. `saveDefaultConfig()` → `ConfigManager` で `LunaticChatConfiguration` を生成 +1. `saveDefaultConfig()` → `ConfigManager` で `LunaticChatConfiguration` を生成し,`MessageFormatHolder` と `ConfigurationReloader` を構築 2. `HttpClient(CIO)` と `PluginCoroutineScope` を初期化 3. `ServiceInitializer.initialize()` → `ServiceContainer` を受け取る 4. コマンドから使う公開プロパティへサービスを移し替え @@ -146,6 +146,9 @@ config フラグ - `ConfigManager` — `config.yml` を **KAML** で `LunaticChatConfiguration` にデシリアライズする.デフォルト値の定義箇所をデータクラス 1 箇所に限定するためで,以前のドット記法の手組みマッパーは同じデフォルトを二重に持っており,実際に乖離していた (`checkForUpdates` が `config.yml` とデータクラスの双方と食い違い,`messageLogging` ブロックはドキュメント化されていながら一度も読まれていなかった) - 失敗はファイル単位ではなく設定単位で処理する.`YamlException` が出た場合は該当キーをドキュメントから取り除いてデコードを再試行するため,読めない値 1 つの影響はその値だけに留まる.全体をデフォルトに落とすのは「YAML として成立していない」場合だけで,いずれのケースも `onEnable` の外へ例外を投げない +- `ConfigManager.loadStrictly` — `/lc reload` が使う読み取り経路.pruning ループは `loadConfiguration` と共有するが,結果の解釈が逆で,1 つでも pruning が発生した時点でファイル全体を拒否し,読み取れなかった設定をまとめて報告する.設定を含まないドキュメントも拒否する.コメントのみのファイルと書き込み途中のファイルを見分けられず,それを理由に全フォーマットをリセットするのは何もしないより悪いため +- `MessageFormatHolder` — 設定のうち唯一実行時に差し替わる部分.`LunaticChatConfiguration` より意図的に狭く,この型を受け取ることが「値が変わりうる」,`LunaticChatConfiguration` を受け取ることが「起動時に凍結された」というシグナルになる.設定全体を holder に入れると,差し替わるのは `messageFormat` だけであるため,どのバージョンのファイルとも一致しないツリーができてしまう +- `ConfigurationReloader` — ファイルを読み直して holder を差し替える.各設定を「適用済み」(`MessageFormatConfig` から leaf 単位) と「再起動が必要」(データクラスの `equals` に乗せた block 単位) に分類し,`memberProperties` を走査するテストが,どちらの表にも載っていない設定が `config.yml` に増えた時点で失敗する.2 つのリストは比較基準が異なり,適用済みは現在有効なフォーマットとの差分,再起動が必要は実際にサーバーが起動した設定との差分である.`messageFormat` 以外を適用できないのは,Paper がコマンドを `COMMANDS` ライフサイクルイベントでしか登録できず,Bukkit にリスナーの解除手段がなく,キャッシュ保存タスクがキャンセル用のハンドルを保持していないため - `LenientBoolean` — `yes` / `no` / `on` / `off` も受け付けるシリアライザ付きの `Boolean` typealias.Bukkit は `config.yml` を YAML 1.1 として読んでいたためこれらは真偽値だったが,kaml が読む YAML 1.2 では単なる文字列であり,黙ってリセットすると `checkForUpdates: no` がデフォルトの逆の値に反転してしまう - 機能デフォルト: `quickReplies=true`, `japaneseConversion=false`, `channelChat=false`, `velocityIntegration=false` - `config/key` 以下に `FeaturesConfig` / `ChannelChatFeatureConfig` / `JapaneseConversionFeatureConfig` / `VelocityIntegrationConfig` / `QuickRepliesFeatureConfig` / `MessageFormatConfig` / `ChannelMessageLoggingConfig` diff --git a/website/src/ja/docs/features/admin.md b/website/src/ja/docs/features/admin.md index a29be09..f6c86b8 100644 --- a/website/src/ja/docs/features/admin.md +++ b/website/src/ja/docs/features/admin.md @@ -22,6 +22,26 @@ layout: doc - 設定値 (デバッグモード,アップデート確認,言語) - GitHub,Modrinth,ドキュメントへのリンク +## 設定のリロード (`/lc reload`) <Badge type="tip" text="v1.4.0~" /> + +サーバーを再起動せずに `config.yml` を読み直します. + +``` +/lc reload +``` + +反映されるのは [`messageFormat`](/ja/docs/reference/message-format) の設定のみです.`config.yml` のほかの設定はプラグインが起動時に確定させる事柄を左右するため,反映されたように見せかけることはせず,再起動が必要な変更を一覧で表示します. + +``` +[LC] config.yml を再読み込みしましたが,一部の変更の適用にはサーバーの再起動が必要です. +``` + +応答は,編集した内容が反映されたかどうかだけを伝えます.どの設定が動いたかはサーバーログに記録されます. + +- **パーミッション**: `lunaticchat.command.lc.reload` (デフォルト: op).コンソール・RCON からも実行可能 +- `config.yml` を完全に読み取れない場合は拒否されます.読み取れなかった設定をすべてまとめて表示し,稼働中の設定はそのまま維持されます.読み取れない設定を個別にデフォルトへフォールバックさせて起動を続行する起動時よりも厳格です +- リロードはサーバーログにも記録されるため,フォーマットを変更した時期をあとから追跡できます.ファイルの読み取りはメインスレッド外で行われ,RCON セッションは応答が届く前に切断されるため,RCON から実行した場合の結果はコマンド出力ではなくログで確認します + ## スパイモード `lunaticchat.spy` パーミッション (デフォルト: op) を持つプレイヤーは,サーバー上で送信されるダイレクトメッセージとチャンネルメッセージの両方を閲覧できます. diff --git a/website/src/ja/docs/getting-started.md b/website/src/ja/docs/getting-started.md index 91f4e89..50bf812 100644 --- a/website/src/ja/docs/getting-started.md +++ b/website/src/ja/docs/getting-started.md @@ -34,7 +34,7 @@ Paper / Folia サーバーには `LunaticChat-<version>.jar` を,Velocity プã 1. ダウンロードした `LunaticChat-<version>.jar` をサーバーの `plugins/` ディレクトリに配置します 2. サーバーを起動 (または再起動) します 3. `plugins/LunaticChat/config.yml` が自動生成されます -4. 必要に応じて[設定](/ja/docs/configuration)を変更し,サーバーを再起動します +4. 必要に応じて[設定](/ja/docs/configuration)を変更し,`/lc reload` を実行するかサーバーを再起動します ### Velocity diff --git a/website/src/ja/docs/permissions.md b/website/src/ja/docs/permissions.md index b2726dd..05ca9cb 100644 --- a/website/src/ja/docs/permissions.md +++ b/website/src/ja/docs/permissions.md @@ -48,3 +48,4 @@ LunaticChat のすべてのパーミッションノードの一覧です. | `lunaticchat.noticeupdate` | op | アップデート通知の受信 | | `lunaticchat.channelbypass` | op | チャンネル制限のバイパス(キック・BAN 保護,強制削除) | | `lunaticchat.command.lcv.status` | op | `/lcv status` コマンドの使用 | +| `lunaticchat.command.lc.reload` | op | `/lc reload` コマンドの使用 | diff --git a/website/src/ja/docs/reference/commands.md b/website/src/ja/docs/reference/commands.md index 8102a75..6d34f1c 100644 --- a/website/src/ja/docs/reference/commands.md +++ b/website/src/ja/docs/reference/commands.md @@ -36,6 +36,14 @@ LunaticChat で使用できるすべてのコマンドのリファレンスでã� - **エイリアス**: `st` - **パーミッション**: `lunaticchat.command.lc.status` +### `/lc reload` <Badge type="tip" text="v1.4.0~" /> + +`config.yml` を読み直して `messageFormat` の設定を反映し,残りの変更のうち再起動が必要なものを報告します.[設定の反映](/ja/docs/configuration#設定の反映)を参照してください. + +- **パーミッション**: `lunaticchat.command.lc.reload` (デフォルト: op) +- **コンソール・RCON からも実行可能** +- `config.yml` を完全に読み取れない場合は拒否され,稼働中の設定がそのまま維持されます + ### `/lc settings [key] [on|off]` プレイヤー個人の設定を確認・変更します.引数なしで設定一覧を表示します. diff --git a/website/src/ja/docs/reference/message-format.md b/website/src/ja/docs/reference/message-format.md index 7ae42e9..3eddd1a 100644 --- a/website/src/ja/docs/reference/message-format.md +++ b/website/src/ja/docs/reference/message-format.md @@ -6,6 +6,8 @@ layout: doc `config.yml` の `messageFormat` セクションで,チャットメッセージの表示形式をカスタマイズできます. +`/lc reload` <Badge type="tip" text="v1.4.0~" /> が再起動なしで反映できるのはこれらの設定だけです.`config.yml` のほかのセクションはサーバー起動時に固定されます.[設定の反映](/ja/docs/configuration#設定の反映)を参照してください. + ## プレースホルダー | プレースホルダー | 説明 | 使用可能なフォーマット | |
