summaryrefslogtreecommitdiff
path: root/website/src/docs/features
diff options
context:
space:
mode:
authorSho Sakuma <me@m1sk9.dev>2026-07-19 22:06:37 +0900
committerGitHub <noreply@github.com>2026-07-19 22:06:37 +0900
commitbee1a61b7e38b160d967a91dd06bc5f44e14d057 (patch)
treea8a0d281f1ddb4f314eb70ec3d01f4e4f7134cc8 /website/src/docs/features
parent31e024179517b261dedd45ff10dc80bb928af5df (diff)
downloadLunaticChat-bee1a61b7e38b160d967a91dd06bc5f44e14d057.tar.gz
LunaticChat-bee1a61b7e38b160d967a91dd06bc5f44e14d057.tar.bz2
LunaticChat-bee1a61b7e38b160d967a91dd06bc5f44e14d057.zip
docs: add developer design/architecture guide (EN/JA) (#251)
* docs: add developer design/architecture guide (EN/JA) The docs site covered features and reference but had no entry point for the codebase's design. Add a Developer Guide section describing the module structure (engine shared kernel, platform-paper, platform-velocity), the protocol-version compatibility model, and the Service Container / Feature Gating pattern, so contributors can understand the architecture without reading the source first. Co-Authored-By: Claude <noreply@anthropic.com> * docs: mirror cross-server DM docs into English (#231) PR #231 added the cross-server direct messaging feature but updated only the Japanese docs. Port the same additions to the English pages (configuration, direct-message, velocity, commands) so both locales stay in sync. Co-Authored-By: Claude <noreply@anthropic.com> * style: apply biome formatting to ja.ts sidebar config The developer-guide sidebar entries were not biome-formatted, failing the build_docs CI check (format:check). Apply the formatter. Co-Authored-By: Claude <noreply@anthropic.com> --------- Co-authored-by: Claude <noreply@anthropic.com>
Diffstat (limited to 'website/src/docs/features')
-rw-r--r--website/src/docs/features/direct-message.md12
-rw-r--r--website/src/docs/features/velocity.md4
2 files changed, 16 insertions, 0 deletions
diff --git a/website/src/docs/features/direct-message.md b/website/src/docs/features/direct-message.md
index 6aa9f42..07f6cdb 100644
--- a/website/src/docs/features/direct-message.md
+++ b/website/src/docs/features/direct-message.md
@@ -30,6 +30,18 @@ Replies to the last player who sent you a message. If there is no such player, t
To use quick reply, `features.quickReplies.enabled` must be `true` (default) in `config.yml`.
+## Cross-Server Direct Messages <Badge type="tip" text="v1.3.0~" />
+
+> [!NOTE]
+>
+> To use this feature, set `features.velocityIntegration.crossServerDirectMessage` to `true` in `config.yml`.
+
+To message a player on another server, specify the player argument as `playerName@serverName`.
+
+```
+/tell <player>@<server> <message>
+```
+
## Notification Settings
Players can individually control the sound notification when receiving direct messages.
diff --git a/website/src/docs/features/velocity.md b/website/src/docs/features/velocity.md
index f43fd65..8bc1b70 100644
--- a/website/src/docs/features/velocity.md
+++ b/website/src/docs/features/velocity.md
@@ -51,6 +51,10 @@ When `crossServerGlobalChat` is set to `true`, player chat messages are relayed
Each message is assigned a unique ID, and a cache prevents the same message from being displayed more than once. The cache size can be configured with `messageDeduplicationCacheSize` (default: `100`).
+## Cross-Server Direct Messages <Badge type="tip" text="v1.3.0~" />
+
+Setting `crossServerDirectMessage` to `true` lets players exchange direct messages with players on other servers connected to the same proxy.
+
## Connection States
The states reported by `/lcv status` and their meanings: