summaryrefslogtreecommitdiff
path: root/website/src/docs
diff options
context:
space:
mode:
authorSho Sakuma <me@m1sk9.dev>2026-05-06 06:09:43 +0900
committerSho Sakuma <me@m1sk9.dev>2026-05-06 06:09:43 +0900
commitc092edbab0e8b516faaa459f6d0915c7df3cd06f (patch)
tree10e9394dcd35270c5374f5396bf8b86b7a711c2b /website/src/docs
parentbbd63b0032965ae58f7a20988312ff5012be543f (diff)
downloadLunaticChat-c092edbab0e8b516faaa459f6d0915c7df3cd06f.tar.gz
LunaticChat-c092edbab0e8b516faaa459f6d0915c7df3cd06f.tar.bz2
LunaticChat-c092edbab0e8b516faaa459f6d0915c7df3cd06f.zip
docs: clarify paper/velocity compatibility
Add a dynamic compatibility matrix (GitHub Releases + ProtocolVersion.kt at each tag) shown on the home page, download page, and a new reference doc. Split protocol theory and rolling-update rules out of the Velocity feature guide into the new compatibility reference, and simplify the download notice. Also set explicit GitHub release titles in the Paper / Velocity workflows so the awkward paper/v* tag prefix is not the user-facing label. Co-Authored-By: Claude <noreply@anthropic.com>
Diffstat (limited to 'website/src/docs')
-rw-r--r--website/src/docs/features/velocity.md55
-rw-r--r--website/src/docs/reference/compatibility.md57
2 files changed, 74 insertions, 38 deletions
diff --git a/website/src/docs/features/velocity.md b/website/src/docs/features/velocity.md
index d1394ec..3fa919e 100644
--- a/website/src/docs/features/velocity.md
+++ b/website/src/docs/features/velocity.md
@@ -6,6 +6,10 @@ layout: doc
Velocity プロキシを経由して複数の Paper / Folia サーバー間でグローバルチャットをリレーします.
+::: tip 互換性について
+Paper プラグインと Velocity プラグインは独立にバージョン管理されています.**両方の最新版を使えば常に動作します.** 古いバージョンを混在させたい場合は,[Paper / Velocity 互換性](/docs/reference/compatibility) を参照してください.
+:::
+
## セットアップ
### 1. Velocity プラグインの導入
@@ -47,45 +51,10 @@ features:
各メッセージに一意な ID が付与され,キャッシュにより同じメッセージが重複して表示されることを防ぎます.キャッシュサイズは `messageDeduplicationCacheSize` (デフォルト: `100`) で設定できます.
-## プロトコルバージョン
-
-Paper と Velocity 間の互換性はプロトコルバージョンで管理されます.接続時にハンドシェイクが行われ,互換性のないバージョン同士では接続が拒否されます.
-
-### バージョンバンプルール
-
-| レベル | 変更例 | 互換性 | デプロイ順序 |
-|--------|--------|--------|-------------|
-| PATCH (1.0.0 → 1.0.1) | optional フィールド追加,新 sub-channel 追加 | 完全互換 (`ignoreUnknownKeys=true` で安全) | 順不同,いつでも |
-| MINOR (1.0.x → 1.1.0) | required フィールド追加,既存 sub-channel のセマンティクス変更 | `MIN_SUPPORTED_MINOR` の範囲内で後方互換 | **Velocity を先に更新** → 各 Paper を順次更新 |
-| MAJOR (1.x.x → 2.0.0) | ワイヤフォーマット変更,sub-channel 削除/リネーム | 非互換 | **全サーバー同時デプロイ** |
-
-### 互換性判定
-
-ハンドシェイク時に以下のルールで互換性が判定されます:
-
-- **MAJOR** が一致すること
-- リモートの **MINOR** が `MIN_SUPPORTED_MINOR` 以上かつ自身の MINOR 以下であること
-- **PATCH** は互換性判定に影響しない
-
-#### 例: Velocity がプロトコル 1.2.0 で `MIN_SUPPORTED_MINOR=1` の場合
-
-| Paper プロトコル | 結果 |
-|-----------------|------|
-| 1.1.x | 接続 OK |
-| 1.2.x | 接続 OK |
-| 1.0.x | 拒否 (`MIN_SUPPORTED_MINOR` より古い) |
-| 1.3.x | 拒否 (Velocity より新しい) |
-| 2.0.x | 拒否 (MAJOR 不一致) |
-
-### 運用サイクル
-
-1. **プロトコル変更なし** → Paper / Velocity を独立にデプロイ可能
-2. **PATCH 変更** → どちら側からでも自由にデプロイ
-3. **MINOR 変更** → Velocity を先行更新し,`MIN_SUPPORTED_MINOR` で旧 Paper の猶予期間を設定.全 Paper 更新後に `MIN_SUPPORTED_MINOR` を引き上げ
-4. **MAJOR 変更** → メンテナンスウィンドウで一括更新
-
## 接続状態
+`/lcv status` で確認できる状態と,それぞれの意味は以下の通りです.
+
| 状態 | 説明 |
|------|------|
| `DISCONNECTED` | 未接続 |
@@ -93,7 +62,13 @@ Paper と Velocity 間の互換性はプロトコルバージョンで管理さ
| `CONNECTED` | 接続済み |
| `FAILED` | 接続失敗 |
-ハンドシェイクのタイムアウトは5秒です.タイムアウトした場合,状態は `FAILED` になります.
+ハンドシェイクのタイムアウトは 5 秒です.タイムアウトした場合,状態は `FAILED` になります.
+
+### `FAILED` になったときの確認ポイント
+
+- Velocity プラグインが正しく導入され,プロキシが起動しているか
+- Paper の `serverName` が Velocity 設定のサーバー名と一致しているか
+- Paper / Velocity プラグインの**プロトコルバージョン**が互換であるか — [互換性マトリクス](/docs/reference/compatibility#互換性マトリクス) で確認できます
## 設定一覧
@@ -107,3 +82,7 @@ Paper と Velocity 間の互換性はプロトコルバージョンで管理さ
## メッセージフォーマット
クロスサーバーチャットの表示形式は `config.yml` の `messageFormat.crossServerGlobalChatFormat` でカスタマイズできます.詳細は[メッセージフォーマット](/docs/reference/message-format)を参照してください.
+
+## 関連ドキュメント
+
+- [Paper / Velocity 互換性](/docs/reference/compatibility) — プロトコルバージョンとローリングアップデートの詳細
diff --git a/website/src/docs/reference/compatibility.md b/website/src/docs/reference/compatibility.md
new file mode 100644
index 0000000..dc0c3b2
--- /dev/null
+++ b/website/src/docs/reference/compatibility.md
@@ -0,0 +1,57 @@
+---
+layout: doc
+---
+
+# Paper / Velocity 互換性
+
+LunaticChat の Paper プラグインと Velocity プラグインは独立にバージョン管理されています.それぞれの組み合わせが動作するかどうかは,両プラグインに埋め込まれた**プロトコルバージョン**で判定されます.
+
+## 結論から
+
+- **両プラグインの最新版同士は常に互換性があります.** 迷ったら両方を最新にしてください.
+- 古いバージョンを混在させたい場合は,下のマトリクスで組み合わせを確認してください.
+- 接続状態は Minecraft サーバーで `/lcv status` を実行すると確認できます.
+
+## 互換性マトリクス
+
+各セルは「その Paper × Velocity の組み合わせが接続できるか」を示します.データは GitHub Releases から自動取得されます.
+
+<CompatibilityMatrix />
+
+## プロトコルバージョンとは
+
+Paper / Velocity 間の通信は LunaticChat 独自のプラグインメッセージプロトコルで行われています.プロトコルにはセマンティックバージョニング (`MAJOR.MINOR.PATCH`) が振られており,接続時のハンドシェイクで両者のバージョンが照合されます.
+
+判定ルールは以下です:
+
+- **MAJOR** が一致すること
+- 相手の **MINOR** が自分の `MIN_SUPPORTED_MINOR` 以上かつ自分の `MINOR` 以下であること
+- **PATCH** は判定に影響しない
+
+`MIN_SUPPORTED_MINOR` は「どこまで古い MINOR を受け入れるか」を示す値で,ローリングアップデート中の猶予期間を作るために使われます.
+
+### バージョンバンプの基準
+
+| レベル | 変更例 | 互換性 | デプロイ順序 |
+|--------|--------|--------|-------------|
+| **PATCH** (1.0.0 → 1.0.1) | optional フィールド追加,新 sub-channel 追加 | 完全互換 (`ignoreUnknownKeys=true` で安全) | 順不同,いつでも |
+| **MINOR** (1.0.x → 1.1.0) | required フィールド追加,既存 sub-channel のセマンティクス変更 | `MIN_SUPPORTED_MINOR` の範囲内で後方互換 | **Velocity を先に更新** → 各 Paper を順次更新 |
+| **MAJOR** (1.x.x → 2.0.0) | ワイヤフォーマット変更,sub-channel 削除/リネーム | 非互換 | **全サーバー同時デプロイ** |
+
+### ローリングアップデートの考え方
+
+1. **プロトコル変更なし**:Paper / Velocity を独立にデプロイ可能.プラグインのバグ修正やリファクタはここに入ります.
+2. **PATCH 変更**:どちら側からでも自由にデプロイ可能.
+3. **MINOR 変更**:Velocity を先行更新し,`MIN_SUPPORTED_MINOR` で旧 Paper を許容.全 Paper 更新後に `MIN_SUPPORTED_MINOR` を引き上げ.
+4. **MAJOR 変更**:メンテナンスウィンドウで一括更新.
+
+## ハンドシェイクの挙動
+
+接続時は以下の流れで互換性が確認されます:
+
+1. Paper サーバー起動時に Velocity に対してハンドシェイクを送信
+2. Velocity が自身のプロトコルバージョンと照合
+3. 不一致の場合は接続が拒否され,状態が `FAILED` になる
+4. ハンドシェイクのタイムアウトは 5 秒
+
+接続状態は `/lcv status` で確認できます.詳細は [Velocity 連携](/docs/features/velocity#接続状態) を参照してください.