summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSho Sakuma <me@m1sk9.dev>2026-02-11 05:31:13 +0900
committerSho Sakuma <me@m1sk9.dev>2026-02-11 05:31:13 +0900
commite91f1ca1397a9ca90481aa7ef9c45646bb11b0cd (patch)
tree635cf43df0d50d474f76464a6382ebe3aa03c295 /docs
parent13e4625859541001b794b7739d7876f2716d0c9f (diff)
downloadLunaticChat-e91f1ca1397a9ca90481aa7ef9c45646bb11b0cd.tar.gz
LunaticChat-e91f1ca1397a9ca90481aa7ef9c45646bb11b0cd.tar.bz2
LunaticChat-e91f1ca1397a9ca90481aa7ef9c45646bb11b0cd.zip
docs: Update Velocity guide
Diffstat (limited to 'docs')
-rw-r--r--docs/src/en/guide/admin/velocity.md35
-rw-r--r--docs/src/guide/admin/velocity.md34
2 files changed, 32 insertions, 37 deletions
diff --git a/docs/src/en/guide/admin/velocity.md b/docs/src/en/guide/admin/velocity.md
index 6a4e6f7..e1f9aa0 100644
--- a/docs/src/en/guide/admin/velocity.md
+++ b/docs/src/en/guide/admin/velocity.md
@@ -21,13 +21,8 @@ To enable Velocity integration, follow these steps:
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.
+ - 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.
::: danger Regarding LunaticChat versions prior to v0.7.0
@@ -37,34 +32,36 @@ They cannot be used together, so if you are using LunaticChat prior to v0.7.0, d
:::
-::: tip Version Rules
+## 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.
+
+::: warning Behavior When Versions Mismatch
-LunaticChat follows these version rules:
+When the version or protocol version does not match, the Velocity integration feature is disabled, but **the plugin itself continues to operate**.
-- 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)
+You can check the connection state and error details using the `/lcv status` command. To reconnect, ensure that the LunaticChat version / protocol version on Velocity and Paper sides match.
:::
-## How to Check Integration Status
+::: tip About Velocity Integration Timing
-To verify that Velocity integration is working properly, use the `/lcv status` command.
+LunaticChat connects to Velocity **when the first player joins the server** after startup.
-The current protocol version and connection state will be displayed.
+Therefore, if you run the `/lcv status` command immediately after server startup, the Velocity integration may not be established yet.
+
+:::
## Troubleshooting
If you encounter issues with Velocity integration, check the following:
+- **Run the `/lcv status` command to check the connection state**. If there are errors such as version mismatches, an error message will be displayed.
- 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
diff --git a/docs/src/guide/admin/velocity.md b/docs/src/guide/admin/velocity.md
index d6de2c6..2b07ddb 100644
--- a/docs/src/guide/admin/velocity.md
+++ b/docs/src/guide/admin/velocity.md
@@ -21,13 +21,8 @@ Velocity 連携を有効化するには以下の手順を行います:
Velocity と Paper の LunaticChat が正しく連携するには,両方のプラグインバージョン・プロトコルバージョンが互換性のあるものである必要があります.
- Velocity 側と Paper 側の LunaticChat のバージョンが同じであることを確認してください.
- - 基本的に,同じバージョンの LunaticChat は互換性があります.
- - リリースは Velocity 版・Paper 版 で同時に行われるため,バージョン番号が異なることはありません.
- - ただし,ベータ版や開発版を使用している場合,互換性が保証されないことがあります.
+ - ベータ版や開発版を使用している場合,互換性が保証されないことがあります.
- プロトコルバージョンが一致していることを確認してください.
- - LunaticChat は,異なるバージョン間での互換性を確保するために,プロトコルバージョンを使用しています.
- - Velocity 側と Paper 側の LunaticChat のプロトコルバージョンが一致していることを確認してください.
- - なお,プロトコルバージョンが変わる場合は **破壊的変更** に当たるため,Paper 版の LunaticChat のアップデート時に Velocity 版の LunaticChat も同時にアップデートする必要があります.
::: danger v0.7.0 未満の LunaticChat について
@@ -37,30 +32,33 @@ v0.7.0 未満の LunaticChat は Velocity 版との後方互換性はありま
:::
-::: tip バージョンルール
+## 連携状況の確認方法
+
+Velocity 連携が正常に動作しているか確認するには,`/lcv status` コマンドを使用します.
+
+現在のプロトコルバージョンと接続状態が表示されます.
+
+::: warning バージョン不一致時の動作
-LunaticChat は以下のバージョンルールに従います.
+バージョンやプロトコルバージョンが一致しない場合,Velocity 連携機能は無効化されますが,**プラグイン自体は動作を継続します**.
-- プラグインバージョン: 完全一致が必要
- - 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 の違い)
+`/lcv status` コマンドで接続状態とエラー内容を確認できます.再接続するには Velocity 側と Paper 側の LunaticChat のバージョン / プロトコルバージョンを一致させてください.
:::
-## 連携状況の確認方法
+::: tip Velocity との連携タイミングについて
-Velocity 連携が正常に動作しているか確認するには,`/lcv status` コマンドを使用します.
+LunaticChat が Velocity と連携するタイミングは,起動後 **最初のプレイヤーがサーバーに接続したとき** に行われます.
-現在のプロトコルバージョンと接続状態が表示されます.
+そのため,サーバー起動直後に `/lcv status` コマンドを実行しても,まだ Velocity との連携が確立されていない場合があります.
+
+:::
## トラブルシューティング
Velocity 連携に関する問題が発生した場合,以下の点を確認してください:
+- **`/lcv status` コマンドを実行して接続状態を確認してください**.バージョン不一致などのエラーがある場合は,エラーメッセージが表示されます.
- Velocity 側と Paper 側の LunaticChat のバージョン / プロトコルバージョンが同じであることを確認してください.
- LunaticChat の設定が正しいことを確認してください.
- Velocity サーバーと Paper サーバー間のネットワーク接続が正常であることを確認してください.