summaryrefslogtreecommitdiff
path: root/docs/src/admin-guide/velocity.md
blob: b3652de5cea6dd5634c7c5f9923e22fb2656e5f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# Velocity 連携 (クロスサーバーチャット) <Badge type="tip" text="v0.8.0" />

Velocity を使用して,プロキシサーバーを繋いだ Paper サーバー間のクロスサーバーチャットを行う機能です.

::: warning 試験的機能

この機能は現在試験的な機能として提供されています.今後のアップデートで仕様が変更される可能性があります.

:::

::: warning Folia との互換性

Velocity 連携機能は Folia とは互換性がありません.

Folia を使用している場合は Velocity 連携機能を使用できません.

:::

## 連携機能を有効化する

Velocity 連携を有効化するには以下の手順を行います:

1. Velocity 側に Velocity 版 LunaticChat をインストールします.
2. 各 Paper サーバの `plugins/LunaticChat/config.yml` を開き, `velocity.enabled``true` に設定します.
3. Velocity, Paper を起動し,連携完了のメッセージが表示されることを確認します.

## プラグインバージョンとプロトコルバージョン

Velocity と Paper の LunaticChat が正しく連携するには,両方のプラグインバージョン・プロトコルバージョンが互換性のあるものである必要があります.

- Velocity 側と Paper 側の LunaticChat のバージョンが同じであることを確認してください.
  - ベータ版や開発版を使用している場合,互換性が保証されないことがあります.
- プロトコルバージョンが一致していることを確認してください.

::: danger v0.7.0 未満の LunaticChat について

v0.7.0 未満の LunaticChat は Velocity 版との後方互換性はありません.

併用することもできないため,v0.7.0 未満の LunaticChat を使用している場合は,Velocity 連携機能を使用しないでください.

:::

## 連携状況の確認方法

Velocity 連携が正常に動作しているか確認するには,`/lcv status` コマンドを使用します.

現在のプロトコルバージョンと接続状態が表示されます.

::: warning バージョン不一致時の動作

バージョンやプロトコルバージョンが一致しない場合,Velocity 連携機能は無効化されますが,**プラグイン自体は動作を継続します**.

`/lcv status` コマンドで接続状態とエラー内容を確認できます.再接続するには Velocity 側と Paper 側の LunaticChat のバージョン / プロトコルバージョンを一致させてください.

:::

::: tip Velocity との連携タイミングについて

LunaticChat が Velocity と連携するタイミングは,起動後 **最初のプレイヤーがサーバーに接続したとき** に行われます.

そのため,サーバー起動直後に `/lcv status` コマンドを実行しても,まだ Velocity との連携が確立されていない場合があります.

:::

## トラブルシューティング

Velocity 連携に関する問題が発生した場合,以下の点を確認してください:

- **`/lcv status` コマンドを実行して接続状態を確認してください**.バージョン不一致などのエラーがある場合は,エラーメッセージが表示されます.
- Velocity 側と Paper 側の LunaticChat のバージョン / プロトコルバージョンが同じであることを確認してください.
- LunaticChat の設定が正しいことを確認してください.
- Velocity サーバーと Paper サーバー間のネットワーク接続が正常であることを確認してください.
- LunaticChat のログを確認し,エラーメッセージや警告メッセージがないか確認してください.

## クロスサーバーチャット

Velocity 連携が有効化されている場合,プロキシサーバーを介して接続されている全てのサーバー間でチャットメッセージが共有されます.

## Velocity 連携と互換性のある機能

Velocity 連携中に利用可能な主な機能は以下の通りです:

|                      | 互換性の有無 | 挙動                                             | 備考                                                     |
| -------------------- | ------------ | ------------------------------------------------ | -------------------------------------------------------- |
| ダイレクトメッセージ | ×            | `/tell`, `/reply` コマンドはサーバー内限定で動作 | ダイレクトメッセージは Velocity 連携に対応していません. |
| チャンネルチャット   | ×            | チャンネルチャットはサーバー内限定で動作         | チャンネルチャットは Velocity 連携に対応していません.   |
| かな・ローマ字変換   | ◯            | かな・ローマ字変換は全サーバーで動作             |                                                          |