diff options
Diffstat (limited to 'website/src/ja/docs/configuration.md')
| -rw-r--r-- | website/src/ja/docs/configuration.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/website/src/ja/docs/configuration.md b/website/src/ja/docs/configuration.md index c2c8c12..3324940 100644 --- a/website/src/ja/docs/configuration.md +++ b/website/src/ja/docs/configuration.md @@ -6,6 +6,22 @@ layout: doc LunaticChat の設定は `plugins/LunaticChat/config.yml` で管理されます．サーバーの初回起動時にデフォルトの設定ファイルが生成されます． +## 設定の反映 + +リロードコマンドはありません．`config.yml` を編集したら**サーバーを再起動**してください． + +真偽値の設定は `true` / `false` のほか，Bukkit が従来受け付けていた `yes` / `no` / `on` / `off` の表記も使用できます．古いリリース向けに書かれたファイルもそのまま動作します． + +## 不正なファイルからの復帰 <Badge type="tip" text="v1.3.0~" /> + +`config.yml` が使用できない状態であっても，プラグインの起動が止まることはありません． + +- **1つの値**が読めない場合，その設定だけがデフォルトにフォールバックし，該当キーを示す警告がログに出力されます．ファイル内のほかの設定はそのまま反映されます +- ファイルが **YAML として不正**な場合やディスクから読み取れない場合は，すべての設定がデフォルトにフォールバックし，エラーがログに出力されます +- コメントのみのファイルは「デフォルトを使う」という有効な指定として扱われ，問題として報告されません + +`config.yml` を編集したあとはサーバーログを確認してください．デフォルトに戻された設定があれば，そこに報告されています． + ## グローバル設定 | キー | 型 | デフォルト | 説明 | @@ -68,6 +84,20 @@ LunaticChat の設定は `plugins/LunaticChat/config.yml` で管理されます | `channelMessageFormat` | `§7[§b#{channel}§7] §e{sender}: §f{message}` | `{sender}`, `{message}`, `{channel}` | | `crossServerGlobalChatFormat` | `§7[§6{server}§7] §e{sender}: §f{message}` | `{sender}`, `{message}`, `{server}` | +## データファイル + +プラグインが書き込むファイルはすべて `plugins/LunaticChat/` 配下に置かれます． + +| ファイル | 書き込まれるタイミング | 備考 | +|----------|----------------------|------| +| `config.yml` | 初回起動時に生成 | プラグインが書き換えることはない | +| `player-settings.yaml` | プレイヤーが `/lc settings` で設定を変更したとき | パスは `userSettingsFilePath` で変更可能．起動時に読み取れなかった場合，**全プレイヤーの設定がデフォルトに戻る** | +| `channels.json` | チャンネルまたはメンバーシップが変化したとき | チャンネルチャットが有効な場合のみ | +| `conversion_cache.json` | `cache.saveIntervalSeconds` ごとに定期保存 | ローマ字変換が有効な場合のみ．パスは `cache.filePath` で変更可能 | +| `logs/channelchat/` | チャンネルメッセージごと | メッセージログが有効な場合のみ．[メッセージログ](/ja/docs/features/message-logging)を参照 | + +保存は変更ごとではなくまとめて行われ，またすべてのファイルはアトミックに書き込まれるため，書き込み途中のファイルが読まれることはありません．いずれもサーバー停止時にも書き出されます． + ## デフォルト設定ファイル [GitHub で確認する](https://github.com/m1sk9/LunaticChat/blob/main/platform-paper/src/main/resources/config.yml) |