docs: Add Velocity intergration guide

10 files changed, 185 insertions, 9 deletions

diff --git a/docs/.vitepress/config/en.ts b/docs/.vitepress/config/en.ts
index f1b6723..d5f4dd6 100644
--- a/docs/.vitepress/config/en.ts
+++ b/docs/.vitepress/config/en.ts
@@ -126,6 +126,15 @@ export const en: DefaultTheme.Config = {
               },
             ],
           },
+          {
+            text: '/lcv',
+            items: [
+              {
+                text: '/lc status',
+                link: '/en/reference/commands/lcv/status',
+              },
+            ],
+          },
         ],
       },
     ],
diff --git a/docs/.vitepress/config/ja.ts b/docs/.vitepress/config/ja.ts
index 12c8992..2ee250e 100644
--- a/docs/.vitepress/config/ja.ts
+++ b/docs/.vitepress/config/ja.ts
@@ -126,6 +126,15 @@ export const ja: DefaultTheme.Config = {
               },
             ],
           },
+          {
+            text: '/lcv',
+            items: [
+              {
+                text: '/lc status',
+                link: '/en/reference/commands/lcv/status',
+              },
+            ],
+          },
         ],
       },
     ],
diff --git a/docs/src/en/guide/admin/velocity.md b/docs/src/en/guide/admin/velocity.md
index b9ec3b5..9b4f10e 100644
--- a/docs/src/en/guide/admin/velocity.md
+++ b/docs/src/en/guide/admin/velocity.md
@@ -1,13 +1,81 @@
-# Velocity Integration (Cross-Server Chat) <Badge type="tip" text="v1.0.0" /> <Badge type="warning" text="Experimental" />
+# Velocity Integration (Cross-Server Chat) <Badge type="tip" text="v0.8.0" />
 
 This feature enables cross-server chat between Paper servers connected through a Velocity proxy server.
 
 ::: warning Experimental Feature
 
-This feature is currently implemented experimentally, and specifications may change in future updates.
+This feature is currently provided as an experimental feature. Specifications may change in future updates.
 
-Since this is a large-scale feature, we plan to implement it gradually rather than all at once.
+:::
+
+## Enabling Integration
+
+To enable Velocity integration, follow these steps:
+
+1. Install the Velocity version of LunaticChat on the Velocity side.
+2. Open `plugins/LunaticChat/config.yml` on each Paper server and set `velocity.enabled` to `true`.
+3. Start Velocity and Paper, and verify that the integration completion message appears.
+
+## Plugin Version and Protocol Version
+
+For Velocity and Paper's LunaticChat to integrate correctly, both plugin versions and protocol versions must be compatible.
+
+- Ensure that the LunaticChat versions on Velocity and Paper sides are the same.
+  - Generally, the same version of LunaticChat is compatible.
+  - Releases are made simultaneously for Velocity and Paper versions, so version numbers will not differ.
+  - However, compatibility may not be guaranteed when using beta or development versions.
+- Ensure that protocol versions match.
+  - LunaticChat uses protocol versions to ensure compatibility between different versions.
+  - Verify that the protocol versions of LunaticChat on Velocity and Paper sides match.
+  - Note that when protocol versions change, it is considered a **breaking change**, requiring simultaneous updates of both Velocity and Paper versions of LunaticChat.
 
-For detailed implementation plans, see the [Roadmap (m1sk9/LunaticChat #54)](https://github.com/m1sk9/LunaticChat/issues/54).
+::: danger Regarding LunaticChat versions prior to v0.7.0
+
+LunaticChat versions prior to v0.7.0 are not backward compatible with the Velocity version.
+
+They cannot be used together, so if you are using LunaticChat prior to v0.7.0, do not use the Velocity integration feature.
 
 :::
+
+::: tip Version Rules
+
+LunaticChat follows these version rules:
+
+- Plugin version: Exact match required
+  - Paper 0.7.0, Velocity 0.7.0 → ✓ PASS
+  - Paper 0.7.0, Velocity 0.6.0 → ✗ FAIL
+- Protocol version: MAJOR.MINOR must match
+  - Paper 1.0.0, Velocity 1.0.1 → ✓ PASS (PATCH difference is OK)
+  - Paper 1.0.0, Velocity 1.1.0 → ✗ FAIL (MINOR difference)
+  - Paper 1.0.0, Velocity 2.0.0 → ✗ FAIL (MAJOR difference)
+
+:::
+
+## How to Check Integration Status
+
+To verify that Velocity integration is working properly, use the `/lcv status` command.
+
+The current protocol version and connection state will be displayed.
+
+## Troubleshooting
+
+If you encounter issues with Velocity integration, check the following:
+
+- Ensure that the LunaticChat version / protocol version on Velocity and Paper sides are the same.
+- Verify that LunaticChat settings are correct.
+- Ensure that network connection between Velocity server and Paper servers is working properly.
+- Check LunaticChat logs for error messages or warnings.
+
+## Cross-Server Chat
+
+When Velocity integration is enabled, chat messages are shared across all servers connected through the proxy server.
+
+## Features Compatible with Velocity Integration
+
+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 |  |
+| 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/reference/commands/lcv/status.md b/docs/src/en/reference/commands/lcv/status.md
new file mode 100644
index 0000000..2b85283
--- /dev/null
+++ b/docs/src/en/reference/commands/lcv/status.md
@@ -0,0 +1,9 @@
+# /lcv status <Badge type="tip" text="v0.8.0" /> <Badge type="tip" text="Velocity" />
+
+### `/lcv status`
+
+| Permission                      |
+|------------------------------|
+| `lunaticchat.command.lcv.status` |
+
+Displays the current LunaticChat Velocity integration status.
diff --git a/docs/src/en/reference/commands/reply.md b/docs/src/en/reference/commands/reply.md
index 0884eb8..1b26be2 100644
--- a/docs/src/en/reference/commands/reply.md
+++ b/docs/src/en/reference/commands/reply.md
@@ -1,4 +1,4 @@
-# /reply <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper" />
+# /reply　<Badge type="tip" text="v0.1.0" />　<Badge type="tip" text="Paper/Velocity" />
 
 ### `/reply <message>`
 
diff --git a/docs/src/en/reference/commands/tell.md b/docs/src/en/reference/commands/tell.md
index 6687e94..fb2b8e1 100644
--- a/docs/src/en/reference/commands/tell.md
+++ b/docs/src/en/reference/commands/tell.md
@@ -1,4 +1,4 @@
-# /tell <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper" />
+# /tell <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper/Velocity" />
 
 ### `/tell <player ID> <message>`
 
diff --git a/docs/src/guide/admin/velocity.md b/docs/src/guide/admin/velocity.md
index bbf5db6..98f5a6f 100644
--- a/docs/src/guide/admin/velocity.md
+++ b/docs/src/guide/admin/velocity.md
@@ -1,4 +1,4 @@
-# Velocity 連携 (クロスサーバーチャット) <Badge type="tip" text="v1.0.0" /> <Badge type="warning" text="試験的" />
+# Velocity 連携 (クロスサーバーチャット) <Badge type="tip" text="v0.8.0" />
 
 Velocity を使用して，プロキシサーバーを繋いだ Paper サーバー間のクロスサーバーチャットを行う機能です．
 
@@ -7,3 +7,75 @@ Velocity を使用して，プロキシサーバーを繋いだ Paper サーバ�
 この機能は現在試験的な機能として提供されています．今後のアップデートで仕様が変更される可能性があります．
 
 :::
+
+## 連携機能を有効化する
+
+Velocity 連携を有効化するには以下の手順を行います：
+
+1. Velocity 側に Velocity 版 LunaticChat をインストールします．
+2. 各 Paper サーバの `plugins/LunaticChat/config.yml` を開き， `velocity.enabled` を `true` に設定します．
+3. Velocity, Paper を起動し，連携完了のメッセージが表示されることを確認します．
+
+## プラグインバージョンとプロトコルバージョン
+
+Velocity と Paper の LunaticChat が正しく連携するには，両方のプラグインバージョン・プロトコルバージョンが互換性のあるものである必要があります．
+
+- Velocity 側と Paper 側の LunaticChat のバージョンが同じであることを確認してください．
+  - 基本的に，同じバージョンの LunaticChat は互換性があります．
+  - リリースは Velocity 版・Paper 版 で同時に行われるため，バージョン番号が異なることはありません．
+  - ただし，ベータ版や開発版を使用している場合，互換性が保証されないことがあります．
+- プロトコルバージョンが一致していることを確認してください．
+  - LunaticChat は，異なるバージョン間での互換性を確保するために，プロトコルバージョンを使用しています．
+  - Velocity 側と Paper 側の LunaticChat のプロトコルバージョンが一致していることを確認してください．
+  - なお，プロトコルバージョンが変わる場合は **破壊的変更** に当たるため，Paper 版の LunaticChat のアップデート時に Velocity 版の LunaticChat も同時にアップデートする必要があります．
+
+::: danger v0.7.0 未満の LunaticChat について
+
+v0.7.0 未満の LunaticChat は Velocity 版との後方互換性はありません．
+
+併用することもできないため，v0.7.0 未満の LunaticChat を使用している場合は，Velocity 連携機能を使用しないでください．
+
+:::
+
+::: tip バージョンルール
+
+LunaticChat は以下のバージョンルールに従います．
+
+- プラグインバージョン: 完全一致が必要
+  - Paper 0.7.0, Velocity 0.7.0 → ✓ PASS
+  - Paper 0.7.0, Velocity 0.6.0 → ✗ FAIL
+- プロトコルバージョン: MAJOR.MINOR が一致する必要あり
+  - Paper 1.0.0, Velocity 1.0.1 → ✓ PASS (PATCH の違いは OK)
+  - Paper 1.0.0, Velocity 1.1.0 → ✗ FAIL (MINOR の違い)
+  - Paper 1.0.0, Velocity 2.0.0 → ✗ FAIL (MAJOR の違い)
+
+:::
+
+## 連携状況の確認方法
+
+Velocity 連携が正常に動作しているか確認するには，`/lcv status` コマンドを使用します．
+
+現在のプロトコルバージョンと接続状態が表示されます．
+
+## トラブルシューティング
+
+Velocity 連携に関する問題が発生した場合，以下の点を確認してください：
+
+- Velocity 側と Paper 側の LunaticChat のバージョン / プロトコルバージョンが同じであることを確認してください．
+- LunaticChat の設定が正しいことを確認してください．
+- Velocity サーバーと Paper サーバー間のネットワーク接続が正常であることを確認してください．
+- LunaticChat のログを確認し，エラーメッセージや警告メッセージがないか確認してください．
+
+## クロスサーバーチャット
+
+Velocity 連携が有効化されている場合，プロキシサーバーを介して接続されている全てのサーバー間でチャットメッセージが共有されます．
+
+## Velocity 連携と互換性のある機能
+
+Velocity 連携中に利用可能な主な機能は以下の通りです：
+
+|            | 互換性の有無 | 挙動 | 備考 |
+|------------| --- | --- | --- |
+| ダイレクトメッセージ | ◯ | `/tell`, `/reply` コマンドで他サーバーのプレイヤーに DM を送信可能 |  |
+| チャンネルチャット | × | チャンネルチャットはサーバー内限定で動作 | チャンネルチャットは Velocity 連携に対応していません． |
+| かな・ローマ字変換 | ◯ | かな・ローマ字変換は全サーバーで動作 |  |
diff --git a/docs/src/reference/commands/lcv/status.md b/docs/src/reference/commands/lcv/status.md
new file mode 100644
index 0000000..320e6fa
--- /dev/null
+++ b/docs/src/reference/commands/lcv/status.md
@@ -0,0 +1,9 @@
+# /lcv status <Badge type="tip" text="v0.8.0" /> <Badge type="tip" text="Velocity" />
+
+### `/lcv status`
+
+| パーミッション                      |
+|------------------------------|
+| `lunaticchat.command.lcv.status` |
+
+現在の LunaticChat の Velocity 連携ステータスを表示します．
diff --git a/docs/src/reference/commands/reply.md b/docs/src/reference/commands/reply.md
index fa9306a..51070e1 100644
--- a/docs/src/reference/commands/reply.md
+++ b/docs/src/reference/commands/reply.md
@@ -1,4 +1,4 @@
-# /reply　<Badge type="tip" text="v0.1.0" />　<Badge type="tip" text="Paper" />
+# /reply　<Badge type="tip" text="v0.1.0" />　<Badge type="tip" text="Paper/Velocity" />
 
 ### `/reply <メッセージ>`
 
diff --git a/docs/src/reference/commands/tell.md b/docs/src/reference/commands/tell.md
index 6f6e897..69c2d90 100644
--- a/docs/src/reference/commands/tell.md
+++ b/docs/src/reference/commands/tell.md
@@ -1,4 +1,4 @@
-# /tell <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper" />
+# /tell <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper/Velocity" />
 
 ### `/tell <プレイヤーID> <メッセージ>`