diff options
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report_velocity.yml | 2 | ||||
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | website/src/docs/features/admin.md | 2 | ||||
| -rw-r--r-- | website/src/docs/features/direct-message.md | 8 | ||||
| -rw-r--r-- | website/src/docs/features/velocity.md | 2 | ||||
| -rw-r--r-- | website/src/ja/docs/features/admin.md | 2 | ||||
| -rw-r--r-- | website/src/ja/docs/features/direct-message.md | 8 | ||||
| -rw-r--r-- | website/src/ja/docs/features/velocity.md | 2 |
8 files changed, 16 insertions, 12 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report_velocity.yml b/.github/ISSUE_TEMPLATE/bug_report_velocity.yml index fb622c9..1de18a2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report_velocity.yml +++ b/.github/ISSUE_TEMPLATE/bug_report_velocity.yml @@ -54,7 +54,7 @@ body: id: lcv-status attributes: label: Output of `/lcv status` - description: Run `/lcv status` on an affected backend server. It reports the connection state and the protocol version of both sides. + description: "Run `/lcv status` on an affected backend server, **after at least one player has joined** — the handshake is only sent once a player connects, so on an empty server the state is always `DISCONNECTED`. It reports the connection state, the plugin version of both sides, and this server's protocol version." placeholder: Paste the output here... validations: required: true @@ -56,7 +56,7 @@ Paper and Folia use `LunaticChat-<version>.jar`; Velocity proxies use `LunaticCh 1. Place `LunaticChat-<version>-velocity.jar` into the Velocity `plugins/` directory 2. Start (or restart) the proxy 3. Set `features.velocityIntegration.enabled` to `true` in the `config.yml` of every backend server -4. Restart the backend servers, then check the connection with `/lcv status` +4. Restart the backend servers, then check the connection with `/lcv status` — the handshake is sent once a player joins, so an empty server reports `DISCONNECTED` For more detail, see [Getting Started](https://lc.m1sk9.dev/docs/getting-started). diff --git a/website/src/docs/features/admin.md b/website/src/docs/features/admin.md index 0c185fb..3f71dcc 100644 --- a/website/src/docs/features/admin.md +++ b/website/src/docs/features/admin.md @@ -28,7 +28,7 @@ Players with the `lunaticchat.spy` permission (default: op) can view both the di - Direct messages are delivered to spies, excluding the sender and the recipient - Channel messages are delivered to spies, excluding the sender and the channel's own members -- Spy players see the original message before romaji conversion +- For direct messages, spies see the original text before romaji conversion. Channel messages reach spies in the same converted form the members see - Hover text indicates the message is a spy message - Spy players themselves are not included in the normal sender/recipient list diff --git a/website/src/docs/features/direct-message.md b/website/src/docs/features/direct-message.md index f3d39e4..ec0f24e 100644 --- a/website/src/docs/features/direct-message.md +++ b/website/src/docs/features/direct-message.md @@ -42,14 +42,16 @@ To message a player on another server, specify the player argument as `playerNam /tell <player>@<server> <message> ``` -`serverName` is the `features.velocityIntegration.serverName` configured on the **destination** server, not the name Velocity uses internally. A server left at the default `"Unknown"` cannot be addressed meaningfully, so give every server a name before enabling this. +`serverName` is the name of the destination server **as registered in your Velocity configuration** (`velocity.toml`), which is what the proxy resolves the target against. Tab completion offers the names and players it currently knows about. + +Set `features.velocityIntegration.serverName` on each backend to that same name. It does not affect routing, but it fills `{server}` in cross-server chat and is how a server recognises which players are its own — if it disagrees with the Velocity name, local players are treated as remote in tab completion. Delivery can fail in two ways, and the sender is told which: | Reason | Meaning | |--------|---------| -| `SERVER_NOT_FOUND` | No server behind the proxy reports that `serverName` | -| `TARGET_OFFLINE` | The server was found, but that player is not online on it | +| `SERVER_NOT_FOUND` | No server registered on the proxy has that name | +| `TARGET_OFFLINE` | The server exists, but that player is not on it — including when they are online on a different server | ## Notification Settings diff --git a/website/src/docs/features/velocity.md b/website/src/docs/features/velocity.md index 29b59f2..7842a24 100644 --- a/website/src/docs/features/velocity.md +++ b/website/src/docs/features/velocity.md @@ -83,7 +83,7 @@ The handshake timeout is 5 seconds. If the handshake times out, the state become | `enabled` | `false` | Enable Velocity integration | | `crossServerGlobalChat` | `false` | Enable cross-server global chat | | `crossServerDirectMessage` | `false` | Enable cross-server direct messages | -| `serverName` | `"Unknown"` | Server name displayed in cross-server chat, and the name `/tell <player>@<server>` matches against | +| `serverName` | `"Unknown"` | This server's own name. Fills `{server}` in cross-server chat and is how the server recognises its own players. Set it to the name registered in `velocity.toml` | | `messageDeduplicationCacheSize` | `100` | Size of the message deduplication cache | ## Message Format diff --git a/website/src/ja/docs/features/admin.md b/website/src/ja/docs/features/admin.md index 7d3874a..a29be09 100644 --- a/website/src/ja/docs/features/admin.md +++ b/website/src/ja/docs/features/admin.md @@ -28,7 +28,7 @@ layout: doc - ダイレクトメッセージは，送信者と受信者を除いてスパイプレイヤーに配信されます - チャンネルメッセージは，送信者とそのチャンネルのメンバーを除いてスパイプレイヤーに配信されます -- スパイプレイヤーにはローマ字変換前の元のメッセージが表示されます +- ダイレクトメッセージについては，ローマ字変換前の元のテキストがスパイプレイヤーに表示されます．チャンネルメッセージはメンバーと同じ変換後の形で届きます - ホバーテキストでスパイメッセージであることが示されます - スパイプレイヤー自身は通常の送受信者リストには含まれません diff --git a/website/src/ja/docs/features/direct-message.md b/website/src/ja/docs/features/direct-message.md index 337759d..736a257 100644 --- a/website/src/ja/docs/features/direct-message.md +++ b/website/src/ja/docs/features/direct-message.md @@ -42,14 +42,16 @@ layout: doc /tell <player>@<server> <message> ``` -ここでのサーバー名は，**宛先サーバー側**の `features.velocityIntegration.serverName` に設定した値であり，Velocity が内部で使う名前ではありません．デフォルトの `"Unknown"` のままではサーバーを指定できないため，この機能を有効にする前に各サーバーへ名前を設定してください． +ここでのサーバー名は，**Velocity の設定 (`velocity.toml`) に登録されている**宛先サーバーの名前です．プロキシはこの名前で宛先を解決します．タブ補完では，その時点で判明しているサーバー名とプレイヤーが提示されます． + +各バックエンドの `features.velocityIntegration.serverName` にも同じ名前を設定してください．この設定値はルーティングには使われませんが，クロスサーバーチャットの `{server}` に入る値であり，またサーバーが自分のプレイヤーを識別するために使われます．Velocity 側の名前と食い違っていると，ローカルのプレイヤーがタブ補完でリモート扱いになります． 送信が失敗する場合は次の2種類があり，送信者にどちらであるかが通知されます． | 理由 | 意味 | |------|------| -| `SERVER_NOT_FOUND` | プロキシ配下にその `serverName` を報告しているサーバーが存在しない | -| `TARGET_OFFLINE` | サーバーは見つかったが，そのプレイヤーがオンラインでない | +| `SERVER_NOT_FOUND` | その名前で登録されているサーバーがプロキシ上に存在しない | +| `TARGET_OFFLINE` | サーバーは存在するが，そのプレイヤーがそこにいない (別のサーバーでオンラインである場合も含む) | ## 通知設定 diff --git a/website/src/ja/docs/features/velocity.md b/website/src/ja/docs/features/velocity.md index 010165c..9020ea1 100644 --- a/website/src/ja/docs/features/velocity.md +++ b/website/src/ja/docs/features/velocity.md @@ -83,7 +83,7 @@ features: | `enabled` | `false` | Velocity 連携を有効にする | | `crossServerGlobalChat` | `false` | クロスサーバーグローバルチャットを有効にする | | `crossServerDirectMessage` | `false` | クロスサーバーダイレクトメッセージを有効にする | -| `serverName` | `"Unknown"` | クロスサーバーチャットで表示されるサーバー名．`/tell <player>@<server>` の照合先にもなる | +| `serverName` | `"Unknown"` | このサーバー自身の名前．クロスサーバーチャットの `{server}` に入り，自分のプレイヤーを識別するために使われる．`velocity.toml` に登録した名前を設定する | | `messageDeduplicationCacheSize` | `100` | メッセージ重複排除キャッシュのサイズ | ## メッセージフォーマット |