diff options
| author | Sho Sakuma <me@m1sk9.dev> | 2026-02-01 01:16:17 +0900 |
|---|---|---|
| committer | Sho Sakuma <me@m1sk9.dev> | 2026-02-01 01:16:17 +0900 |
| commit | 04aa7573e876724b58c8f116fadd01e060629813 (patch) | |
| tree | 8da16f3f655e249dc6efb412a9dacf088872bbdc /docs/src/en/guide/admin | |
| parent | 4793b23aaa6bdcbd24498e0af37c4ba0ba06f6dd (diff) | |
| download | LunaticChat-04aa7573e876724b58c8f116fadd01e060629813.tar.gz LunaticChat-04aa7573e876724b58c8f116fadd01e060629813.tar.bz2 LunaticChat-04aa7573e876724b58c8f116fadd01e060629813.zip | |
docs: Add Velocity intergration guide
Diffstat (limited to 'docs/src/en/guide/admin')
| -rw-r--r-- | docs/src/en/guide/admin/velocity.md | 76 |
1 files changed, 72 insertions, 4 deletions
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 | | |
