summaryrefslogtreecommitdiff
path: root/docs/src/admin-guide/channel-chat
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src/admin-guide/channel-chat')
-rw-r--r--docs/src/admin-guide/channel-chat/introduction.md74
-rw-r--r--docs/src/admin-guide/channel-chat/logs.md119
2 files changed, 193 insertions, 0 deletions
diff --git a/docs/src/admin-guide/channel-chat/introduction.md b/docs/src/admin-guide/channel-chat/introduction.md
new file mode 100644
index 0000000..559283c
--- /dev/null
+++ b/docs/src/admin-guide/channel-chat/introduction.md
@@ -0,0 +1,74 @@
+# チャンネルチャット: 展開ガイド
+
+このガイドでは、チャンネルチャットの展開方法について説明します.
+
+## チャンネルチャットとは
+
+プレイヤー間でチャンネルを作成し,特定のプレイヤー間で,チャットを共有できる機能です.
+
+詳しい機能については [プレイヤー向けガイド版](../../player-guide/channel-chat/about.md) を参照してください.
+
+## チャンネルチャットの展開準備
+
+チャンネルチャットを展開するには,LunaticChat の設定ファイル `config.yml` でチャンネルチャット機能を有効化する必要があります.
+
+1. サーバーを停止します.
+2. `plugins/LunaticChat/config.yml` を開きます.
+3. `features.channelChat.enabled` を `true` に設定します.
+4. サーバーを再起動します.
+
+以上でチャンネルチャット機能が有効化され,プレイヤーがチャンネルチャットを使用できるようになります.
+
+## チャンネルチャットの設定
+
+チャンネルチャットに関する設定項目は以下の通りです.
+
+- `features.channelChat.maxChannelsPerPlayer`: 1人のプレイヤーが作成できるチャンネルの最大数を指定します.
+- `features.channelChat.maxMembersPerChannel`: 1つのチャンネルに参加できるメンバーの最大数を指定します.
+- `features.channelChat.maxMembershipPerPlayer`: 1人のプレイヤーが参加できるチャンネルの最大数を指定します.
+
+デフォルトは `0` に設定されており,制限はありません.
+
+::: tip 設定のおすすめは?
+
+チャンネルチャット機能を活発に使用したい場合は,これらの値を高めに設定することをお勧めします.
+
+ただし,サーバーのパフォーマンスに影響を与える可能性があるため,サーバーのリソース状況に応じて適切に設定してください.
+
+おすすめの設定は次のとおりです.
+
+- `features.channelChat.maxChannelsPerPlayer`: `3` 〜 `5`
+- `features.channelChat.maxMembersPerChannel`: `20` 〜 `50`
+- `features.channelChat.maxMembershipPerPlayer`: `5` 〜 `10`
+
+:::
+
+## チャンネルチャットのログ
+
+::: warning CoreProtect などのプラグインとの互換性
+
+LunaticChat では,チャンネルチャット機能に限り v0.7.0 以降 CoreProtect などのログ記録プラグインと互換性はありません.
+
+:::
+
+チャンネルチャットのログ機能はデフォルトで有効になっています.
+
+詳しくは [チャンネルチャット: ログ](logs.md) を参照してください.
+
+## チャンネルの管理
+
+基本的に,[チャンネルの管理はプレイヤー自身が行います](../../player-guide/channel-chat/moderation.md).
+
+ただし,サーバー管理者として,以下の点に注意してください:
+
+- サーバー管理者はすべてのチャンネルに対してオーナー権限を持ちます.操作が必要な場合は,適切に対応してください.
+- サーバーのパフォーマンスを維持するために,必要に応じてチャンネル数やメンバー数の制限を設定してください.
+- 不適切なチャンネルやメンバー行動が発生した場合は,適切な措置を講じてください.
+
+また,それらのチャンネルの管理によるトラブルを回避したい場合は `/lc channel ban` などのモデレートコマンドの制限を検討してください.
+
+## チャンネルチャットを捕捉してしまうプラグイン
+
+基本的に CoreProtect などのログ記録プラグインは,LunaticChat のチャンネルチャットメッセージを捕捉しません.
+
+ただし,Paper API の `originalMessage()` を使用してメッセージを取得しているプラグインは,LunaticChat のチャンネルチャットメッセージを捕捉してしまう可能性があります.
diff --git a/docs/src/admin-guide/channel-chat/logs.md b/docs/src/admin-guide/channel-chat/logs.md
new file mode 100644
index 0000000..9b88bdd
--- /dev/null
+++ b/docs/src/admin-guide/channel-chat/logs.md
@@ -0,0 +1,119 @@
+# チャンネルチャット: ログ <Badge type="tip" text="v0.7.0" />
+
+チャンネルチャットのログは,チャット内で行われたすべてのメッセージとアクティビティの記録です.
+
+::: warning CoreProtect などのプラグインとの互換性
+
+LunaticChat では,チャンネルチャット機能に限り v0.7.0 以降 CoreProtect などのログ記録プラグインと互換性はありません.
+
+:::
+
+## チャンネルチャットのログを確認する
+
+チャンネルチャットのログは `plugins/LunaticChat/logs/channelchat/` ディレクトリに保存されます.
+
+チャンネルチャットのログファイルは,以下のフォーマットで保存されます:
+
+```
+{"timestamp":"2026-01-31T08:54:18.504343071Z","playerId":"ceaea267-39dd-3bac-931c-761ada671ebe","playerName":"m1sk9","channelId":"test","message":"こんにちは"}
+```
+
+## ファイルサイズについて
+
+各行が1つの完全な JSON オブジェクトであり,各行で区切られているだけで,ファイル全体としては JSON 配列ではありません.
+
+```text
+plugins/LunaticChat/logs/
+├── channel-messages-2026-01-17.json (5.2 MB)
+├── channel-messages-2026-01-18.json (4.8 MB)
+├── channel-messages-2026-01-19.json (6.1 MB)
+├── channel-messages-2026-01-20.json (5.5 MB)
+├── channel-messages-2026-01-21.json (7.2 MB) <- 週末、アクティブ
+├── channel-messages-2026-01-22.json (6.9 MB)
+├── channel-messages-2026-01-23.json (4.3 MB)
+├── channel-messages-2026-01-24.json (5.0 MB)
+├── channel-messages-2026-01-25.json (5.4 MB)
+├── channel-messages-2026-01-26.json (4.9 MB)
+├── channel-messages-2026-01-27.json (6.2 MB)
+├── channel-messages-2026-01-28.json (7.5 MB)
+├── channel-messages-2026-01-29.json (5.8 MB)
+├── channel-messages-2026-01-30.json (6.0 MB)
+└── channel-messages-2026-01-31.json (2.1 MB) <- 今日(進行中)
+```
+
+合計: 約 83 MB
+
+30日保持設定 の場合,1月17日のファイルは明日自動削除されます.
+
+### 1メッセージあたりのサイズ
+
+チャンネルチャットのログエントリは1行につき,約200バイトです.
+
+1時間に1000メッセージの計算として
+
+```text
+1000 msg/h × 24h × 220 bytes = 5,280,000 bytes ≈ 5.3 MB/日
+```
+
+デフォルト設定の30日間保持の場合は **159 MB** 程度になります.
+
+```text
+5.3 MB × 30日 = 159 MB
+```
+
+## Grafana Loki での可視化
+
+JSON 形式のため,Promtail を使用し,Grafana Loki にチャンネルチャットのログを取り込むとパースされ読みやすくなります.
+
+```text
+2026-01-31 10:23:45.123 {job="lunatichat", player="Steve", channel="Global"}
+Hello everyone!
+
+2026-01-31 10:24:12.456 {job="lunatichat", player="Alex", channel="Global"}
+Hi Steve!
+
+2026-01-31 10:25:03.789 {job="lunatichat", player="Notch", channel="Development Team"}
+Working on new features
+```
+
+::: tip フィルタリング例
+
+Grafana Loki でログをクエリ化する例:
+
+```text
+{job="lunatichat"} |= "new features"
+{job="lunatichat", channel="Global"}
+{job="lunatichat", player="Steve"}
+```
+
+:::
+
+## コマンドラインでの確認例
+
+### 最新10件を見る
+
+```bash
+tail -n 10 plugins/LunaticChat/logs/channel-messages-2026-01-31.json | jq
+```
+
+### 特定プレイヤーのメッセージを抽出
+
+```bash
+cat plugins/LunaticChat/logs/channel-messages-*.json | \
+jq 'select(.playerName=="Steve")'
+```
+
+### 特定チャンネルのメッセージ数をカウント
+
+```bash
+cat plugins/LunaticChat/logs/channel-messages-*.json | \
+jq 'select(.channelId=="global")' | wc -l
+```
+
+### 日付別メッセージ数
+
+```bash
+for file in plugins/LunaticChat/logs/channel-messages-*.json; do
+echo "$file: $(wc -l < $file) messages"
+done
+```