diff options
Diffstat (limited to 'docs/src/en')
| -rw-r--r-- | docs/src/en/guide/admin/configuration.md | 56 | ||||
| -rw-r--r-- | docs/src/en/guide/admin/velocity.md | 2 | ||||
| -rw-r--r-- | docs/src/en/index.md | 4 | ||||
| -rw-r--r-- | docs/src/en/reference/commands/lc/settings.md | 7 | ||||
| -rw-r--r-- | docs/src/en/reference/commands/lc/status.md | 6 |
5 files changed, 66 insertions, 9 deletions
diff --git a/docs/src/en/guide/admin/configuration.md b/docs/src/en/guide/admin/configuration.md index ef33ddc..15c8f10 100644 --- a/docs/src/en/guide/admin/configuration.md +++ b/docs/src/en/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 @@ Specifies the maximum size (in megabytes) of channel chat log files. Log files exceeding `maxFileSizeMB` will stop accepting new entries. +### `features.velocityIntegration` + +#### `enabled` + +- Type: `boolean` +- Default: `false` + +Enables integration with Velocity proxy plugin. + +#### `crossServerGlobalChat` + +- Type: `boolean` +- Default: `false` + +Specifies whether to share chat messages across all Paper servers connected to the Velocity proxy. + +#### `serverName` + +- Type: `string` +- Default: `Unknown` + +Specifies the server name to display in Velocity cross-server chat. + +Examples: `survival`, `creative`, `lobby` + +#### `messageDeduplicationCacheSize` + +- Type: `integer` +- Default: `100` + +Specifies the size of the message deduplication cache. + ## Message Format Settings Available placeholders: @@ -254,6 +302,7 @@ Available placeholders: - `{recipient}`: Name of the message recipient - `{message}`: Content of the message - `{channel}`: Name of the chat channel (only for channel chat) +- `{server}`: Name of the server (only for Velocity cross-server chat) ### `messageFormat.directMessageFormat` @@ -268,3 +317,10 @@ Specifies the format for messages sent via direct message ([`/tell`](../../refer - Default: `§7[§b#{channel}§7] §e{sender}: §f{message}` Specifies the format for messages sent in channel chat. + +### `messageFormat.crossServerGlobalChatFormat` + +- Type: `string` +- Default: `§7[§6{server}§7] §e{sender}: §f{message}` + +Specifies the format for messages sent via Velocity cross-server global chat. diff --git a/docs/src/en/guide/admin/velocity.md b/docs/src/en/guide/admin/velocity.md index 9b4f10e..6a4e6f7 100644 --- a/docs/src/en/guide/admin/velocity.md +++ b/docs/src/en/guide/admin/velocity.md @@ -76,6 +76,6 @@ The main features available during Velocity integration are as follows: | | Compatibility | Behavior | Notes | |------------| --- | --- | --- | -| Direct Messages | ◯ | Can send DMs to players on other servers using `/tell` and `/reply` commands | | +| Direct Messages | × | `/tell` and `/reply` commands operate only within the server | Direct messages do not support Velocity integration. | | Channel Chat | × | Channel chat operates only within the server | Channel chat does not support Velocity integration. | | Kana/Romanization | ◯ | Kana/Romanization works across all servers | | diff --git a/docs/src/en/index.md b/docs/src/en/index.md index 0fe8a53..266c4a6 100644 --- a/docs/src/en/index.md +++ b/docs/src/en/index.md @@ -32,10 +32,10 @@ features: - title: Japanese Romanization Conversion details: Automatically converts messages input in romaji to Japanese icon: 🌍 - - title: Channel Chat Feature (Planned) + - title: Channel Chat Feature details: Create and manage chat channels, send private messages between specific players icon: ☎️ - - title: Multi-Platform Support (Planned) + - title: Multi-Platform Support details: Support for multi-platform Paper and Velocity, enabling cross-server chat icon: 🚀 - title: High-Speed Performance with Caching diff --git a/docs/src/en/reference/commands/lc/settings.md b/docs/src/en/reference/commands/lc/settings.md index 4d09301..8b88066 100644 --- a/docs/src/en/reference/commands/lc/settings.md +++ b/docs/src/en/reference/commands/lc/settings.md @@ -2,9 +2,9 @@ ### `/lc settings <key> [value]` -| Permission | -|--------------------------------| -| `lunaticchat.command.settings` | +| Permission | +|-----------------------------------| +| `lunaticchat.command.lc.settings` | Manages player settings for LunaticChat. If no value is specified, the current setting value will be displayed. @@ -16,3 +16,4 @@ This setting is saved by UUID, so the setting will not be lost even if you chang |----------|----------------------------------------------------------|--------| | `japanese` | Toggles romanization conversion on or off. | `true` | | `notice` | Toggles whether to receive notifications when receiving direct messages via `/tell` or `/reply`. | `true` | +| `chNotice` | Toggles whether to receive notifications when receiving channel chat messages. | `true` | diff --git a/docs/src/en/reference/commands/lc/status.md b/docs/src/en/reference/commands/lc/status.md index 365519a..1fa6a39 100644 --- a/docs/src/en/reference/commands/lc/status.md +++ b/docs/src/en/reference/commands/lc/status.md @@ -2,8 +2,8 @@ ### `/lc status` -| Permission | -|------------------------------| -| `lunaticchat.command.status` | +| Permission | +|---------------------------------| +| `lunaticchat.command.lc.status` | Displays the status of LunaticChat. |