summaryrefslogtreecommitdiff
path: root/docs/src/guide
diff options
context:
space:
mode:
authorSho Sakuma <me@m1sk9.dev>2026-02-07 03:59:25 +0900
committerSho Sakuma <me@m1sk9.dev>2026-02-07 04:00:04 +0900
commit40c9d18e4747e23977618e17bafcd64cd0ffa6b4 (patch)
tree1fe77e8d677471c8a52ee7b28419423f7a25f14a /docs/src/guide
parentc7231d496c60ef68907f976427ab1b9c29e3c9f0 (diff)
downloadLunaticChat-40c9d18e4747e23977618e17bafcd64cd0ffa6b4.tar.gz
LunaticChat-40c9d18e4747e23977618e17bafcd64cd0ffa6b4.tar.bz2
LunaticChat-40c9d18e4747e23977618e17bafcd64cd0ffa6b4.zip
docs: Update Cross Server chat
Diffstat (limited to 'docs/src/guide')
-rw-r--r--docs/src/guide/admin/configuration.md48
-rw-r--r--docs/src/guide/admin/velocity.md10
2 files changed, 53 insertions, 5 deletions
diff --git a/docs/src/guide/admin/configuration.md b/docs/src/guide/admin/configuration.md
index 5eb5fc6..b641549 100644
--- a/docs/src/guide/admin/configuration.md
+++ b/docs/src/guide/admin/configuration.md
@@ -68,6 +68,19 @@ features:
retentionDays: 30
# Maximum size of a single log file in megabytes. Files exceeding this size will stop accepting new entries.
maxFileSizeMB: 100
+ velocityIntegration:
+ # If enabled, enables integration with Velocity proxy plugin.
+ # This allows Paper and Velocity instances to communicate and verify compatibility.
+ enabled: false
+ # If enabled, global chat messages will be shared across all Paper servers connected to the Velocity proxy.
+ # Players on different servers can communicate through the GLOBAL chat mode.
+ crossServerGlobalChat: false
+ # Server name to display in cross-server chat (e.g., "survival", "creative", "lobby").
+ # This should match the server name defined in your Velocity configuration.
+ serverName: "Unknown"
+ # Size of the message deduplication cache to prevent duplicate messages from appearing.
+ # Keeps track of the most recent N message IDs to filter out duplicates.
+ messageDeduplicationCacheSize: 100
# ----------------------------------------------
# --------- Message Format Settings --------
@@ -80,6 +93,7 @@ features:
# {recipient} - The name of the message recipient
# {message} - The content of the message
# {channel} - The name of the chat channel (only for channel chat)
+# {server} - The name of the server (only for Velocity cross-server chat)
# ----------------------------------------------
messageFormat:
@@ -87,6 +101,8 @@ messageFormat:
directMessageFormat: "§7[§e{sender} §7>> §e{recipient}§7] §f{message}"
# Configure the format for messages sent in channel chat
channelMessageFormat: "§7[§b#{channel}§7] §e{sender}: §f{message}"
+ # Configure the format for global chat messages in Velocity integration
+ crossServerGlobalChatFormat: "§7[§6{server}§7] §e{sender}: §f{message}"
```
## General Settings
@@ -246,6 +262,38 @@ LunaticChat の [`/reply`](../../reference/commands/reply.md) コマンドによ
`maxFileSizeMB` を超えたログファイルは新しいエントリを受け付けなくなります.
+### `features.velocityIntegration`
+
+#### `enabled`
+
+- Type: `boolean`
+- Default: `false`
+
+Velocity プロキシプラグインとの連携を有効にします.
+
+#### `crossServerGlobalChat`
+
+- Type: `boolean`
+- Default: `false`
+
+Velocity プロキシに接続されたすべての Paper サーバー間でチャットメッセージを共有するかどうかを指定します.
+
+#### `serverName`
+
+- Type: `string`
+- Default: `Unknown`
+
+Velocity クロスサーバーチャットで表示されるサーバー名を指定します.
+
+例: `survival`, `creative`, `lobby`
+
+#### `messageDeduplicationCacheSize`
+
+- Type: `integer`
+- Default: `100`
+
+メッセージの重複排除キャッシュのサイズを指定します.
+
## Message Format Settings
使用できるプレースホルダー:
diff --git a/docs/src/guide/admin/velocity.md b/docs/src/guide/admin/velocity.md
index 98f5a6f..d6de2c6 100644
--- a/docs/src/guide/admin/velocity.md
+++ b/docs/src/guide/admin/velocity.md
@@ -74,8 +74,8 @@ Velocity 連携が有効化されている場合,プロキシサーバーを
Velocity 連携中に利用可能な主な機能は以下の通りです:
-| | 互換性の有無 | 挙動 | 備考 |
-|------------| --- | --- | --- |
-| ダイレクトメッセージ | ◯ | `/tell`, `/reply` コマンドで他サーバーのプレイヤーに DM を送信可能 | |
-| チャンネルチャット | × | チャンネルチャットはサーバー内限定で動作 | チャンネルチャットは Velocity 連携に対応していません. |
-| かな・ローマ字変換 | ◯ | かな・ローマ字変換は全サーバーで動作 | |
+| | 互換性の有無 | 挙動 | 備考 |
+|------------|--------|-----------------------------------|-----------------------------------|
+| ダイレクトメッセージ | × | `/tell`, `/reply` コマンドはサーバー内限定で動作 | ダイレクトメッセージは Velocity 連携に対応していません. |
+| チャンネルチャット | × | チャンネルチャットはサーバー内限定で動作 | チャンネルチャットは Velocity 連携に対応していません. |
+| かな・ローマ字変換 | ◯ | かな・ローマ字変換は全サーバーで動作 | |