diff options
| author | Sho Sakuma <me@m1sk9.dev> | 2026-01-27 21:39:59 +0900 |
|---|---|---|
| committer | Sho Sakuma <me@m1sk9.dev> | 2026-01-27 22:07:27 +0900 |
| commit | 21d17ca948193a9f4b7ef080d2b949240e64e538 (patch) | |
| tree | 421f100ec8c8a6289d4d687143f0750108167a9e /docs/src/guide/admin | |
| parent | 4bdfa1e3cfcb981355d8413d1f2f7e8f8bb36aa0 (diff) | |
| download | LunaticChat-21d17ca948193a9f4b7ef080d2b949240e64e538.tar.gz LunaticChat-21d17ca948193a9f4b7ef080d2b949240e64e538.tar.bz2 LunaticChat-21d17ca948193a9f4b7ef080d2b949240e64e538.zip | |
docs: Add admin guide
Diffstat (limited to 'docs/src/guide/admin')
| -rw-r--r-- | docs/src/guide/admin/cache.md | 10 | ||||
| -rw-r--r-- | docs/src/guide/admin/configuration.md | 37 | ||||
| -rw-r--r-- | docs/src/guide/admin/data-and-logs.md | 119 | ||||
| -rw-r--r-- | docs/src/guide/admin/introduction-channel-chat.md | 56 |
4 files changed, 211 insertions, 11 deletions
diff --git a/docs/src/guide/admin/cache.md b/docs/src/guide/admin/cache.md index 9e45ff2..afacac5 100644 --- a/docs/src/guide/admin/cache.md +++ b/docs/src/guide/admin/cache.md @@ -29,13 +29,3 @@ LunaticChat では,キャッシュのパージ 機能は実装されていま これはプレイヤー側にホストのファイルシステムを操作させることがセキュリティ上好ましくないためです. ::: - -## キャッシュバージョン - -ディスクキャッシュに使用されるファイルには `version` フィールドが含まれており,LunaticChat のバージョンアップに伴うキャッシュフォーマットの変更に対応しています. - -バージョンが不一致の場合,LunaticChat はキャッシュファイルを **古い形式のキャッシュ** として認識し,内容を無視して新しい形式で再作成します. - -```json -{"version":"1","entries":{}} -``` diff --git a/docs/src/guide/admin/configuration.md b/docs/src/guide/admin/configuration.md index ac63eb7..dfa41f9 100644 --- a/docs/src/guide/admin/configuration.md +++ b/docs/src/guide/admin/configuration.md @@ -54,6 +54,12 @@ features: channelChat: # If enabled, channel-based chat functionality will be activated. enabled: false + # Maximum number of channels that can be created per server. Set to 0 for unlimited. + maxChannelsPerServer: 0 + # Maximum number of members allowed in a single channel. Set to 0 for unlimited. + maxMembersPerChannel: 0 + # Maximum number of channels a single player can join. Set to 0 for unlimited. + maxMembershipPerPlayer: 0 # ---------------------------------------------- # --------- Message Format Settings -------- @@ -171,13 +177,42 @@ LunaticChat の [`/reply`](../../reference/commands/reply.md) コマンドによ ローマ字変換 API へのリクエストが失敗した場合の再試行回数を指定します. -### `features.channelChat.enabled` +### `features.channelChat` + +#### `enabled` - Type: `boolean` - Default: `false` チャンネルチャット機能を有効にします. +#### `maxChannelsPerServer` + +- Type: `integer` +- Default: `0` + +サーバーあたりで作成可能なチャンネルの最大数を指定します. + +`0` に設定すると無制限になります. + +#### `maxMembersPerChannel` + +- Type: `integer` +- Default: `0` + +1 つのチャンネルに参加可能なメンバーの最大数を指定します. + +`0` に設定すると無制限になります. + +#### `maxMembershipPerPlayer` + +- Type: `integer` +- Default: `0` + +1 人のプレイヤーが参加可能なチャンネルの最大数を指定します. + +`0` に設定すると無制限になります. + ## Message Format Settings 使用できるプレースホルダー: diff --git a/docs/src/guide/admin/data-and-logs.md b/docs/src/guide/admin/data-and-logs.md new file mode 100644 index 0000000..6f48857 --- /dev/null +++ b/docs/src/guide/admin/data-and-logs.md @@ -0,0 +1,119 @@ +# データ・ログ + +::: danger 編集厳禁 + +これらのデータファイルは LunaticChat の動作に不可欠です.直接編集すると,データの破損や予期せぬ動作を引き起こす可能性があります.データのバックアップを取る場合を除き,これらのファイルを直接編集しないでください. + +::: + +## データの保存場所 + +LunaticChat は、チャンネルデータや設定情報をローカルディスクに保存します. + +- `channels.json`: チャンネル情報を保存するファイルです. +- `chatmodes.json`: プレイヤーのチャットモード設定を保存するファイルです. +- `conversion_cache.json`: チャンネル変換のキャッシュを保存するファイルです. +- `player-settings.yaml`: プレイヤーごとの設定情報を保存するファイルです. + +::: tip 定期的なバックアップ + +LunaticChat のデータの安全性を確保するために,定期的にバックアップを作成することをお勧めします. + +::: + +### `channels.json` + +`channels.json` ファイルは、LunaticChat が管理するチャンネルの情報を保存します.このファイルには,チャンネル名、参加者リスト、チャットモードなどの情報が含まれます. + +```json +{ + "channels": { + "general-channel": { + "id": "general-channel", + "name": "一般チャンネル", + "ownerId": "a01e3843-e521-3998-958a-f459800e4d11", + "createdAt": 1769507213150, + "bannedPlayers": [ + "ceaea267-39dd-3bac-931c-761ada671ebe" + ] + } + }, + "members": { + "general-channel": [ + { + "channelId": "test2", + "playerId": "a01e3843-e521-3998-958a-f459800e4d11", + "role": "OWNER", + "joinedAt": 1769507213150 + } + ] + }, + "activeChannels": { + "a01e3843-e521-3998-958a-f459800e4d11": "test2" + } +} +``` + +### `chatmodes.json` + +`chatmodes.json` ファイルは、プレイヤーのチャットモード設定を保存します.このファイルには,プレイヤーごとのチャットモード情報が含まれます. + +```json +{ + "modes": { + "aed5efd4-551b-3965-bc28-ae21aa072a66": "CHANNEL", + "ceaea267-39dd-3bac-931c-761ada671ebe": "CHANNEL", + "a01e3843-e521-3998-958a-f459800e4d11": "CHANNEL", + "681f539b-8bb8-3f85-85e5-a2945f6c6539": "GLOBAL" + } +} +``` + +### `conversion_cache.json` + +`conversion_cache.json` ファイルは、チャンネル変換のキャッシュを保存します.このファイルには,プレイヤーごとのチャンネル変換情報が含まれます. + +キャッシュシステムに関する詳細は [こちら](./cache.md) をご覧ください. + + +```json +{"version":"1","entries":{"hi":"日"}} +``` + +### `player-settings.yaml` + +`player-settings.yaml` ファイルは、プレイヤーごとの設定情報を保存します.このファイルには,プレイヤーの個別設定が含まれます. + +```yaml +version: 1 +japaneseConversion: + "aed5efd4-551b-3965-bc28-ae21aa072a66": false + "ceaea267-39dd-3bac-931c-761ada671ebe": false +directMessageNotification: + "aed5efd4-551b-3965-bc28-ae21aa072a66": true + "ceaea267-39dd-3bac-931c-761ada671ebe": true +channelMessageNotification: + "ceaea267-39dd-3bac-931c-761ada671ebe": true +``` + +## キャッシュバージョン + +ディスクキャッシュに使用されるファイルには `version` フィールドが含まれており,LunaticChat のバージョンアップに伴うキャッシュフォーマットの変更に対応しています. + +バージョンが不一致の場合,LunaticChat はキャッシュファイルを **古い形式のキャッシュ** として認識し,内容を無視して新しい形式で再作成します. + +```json +{"version":"1","entries":{}} +``` + +## CoreProtect について + +LunaticChat の各種チャットログは API 不要で CoreProtect でも記録することができます. + +各機能のログは次のアクションで確認できます. `/co lookup` コマンド使用時に以下のアクションを指定してください: + +- ダイレクトメッセージ: `command` +- 全体チャット・チャンネルチャット: `chat` + - かな・ローマ字変換はそのプレイヤーの設定状況により保存されます. + + diff --git a/docs/src/guide/admin/introduction-channel-chat.md b/docs/src/guide/admin/introduction-channel-chat.md new file mode 100644 index 0000000..6993435 --- /dev/null +++ b/docs/src/guide/admin/introduction-channel-chat.md @@ -0,0 +1,56 @@ +# チャンネルチャット展開ガイド + +このガイドでは、チャンネルチャットの展開方法について説明します. + +## チャンネルチャットとは + +プレイヤー間でチャンネルを作成し,特定のプレイヤー間で,チャットを共有できる機能です. + +詳しい機能については [プレイヤー向けガイド版](../player/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` + +::: + +## チャンネルの管理 + +基本的に,[チャンネルの管理はプレイヤー自身が行います](../player/channel-chat/moderation.md). + +ただし,サーバー管理者として,以下の点に注意してください: + +- サーバー管理者はすべてのチャンネルに対してオーナー権限を持ちます.操作が必要な場合は,適切に対応してください. +- サーバーのパフォーマンスを維持するために,必要に応じてチャンネル数やメンバー数の制限を設定してください. +- 不適切なチャンネルやメンバー行動が発生した場合は,適切な措置を講じてください. + +また,それらのチャンネルの管理によるトラブルを回避したい場合は `/lc channel ban` などのモデレートコマンドの制限を検討してください. |
