summaryrefslogtreecommitdiff
path: root/website/src/docs/features
diff options
context:
space:
mode:
authorSho Sakuma <me@m1sk9.dev>2026-06-12 15:47:12 +0900
committerGitHub <noreply@github.com>2026-06-12 15:47:12 +0900
commitc8adb0505b3fa5d44a6f2b0aa1a3dd97ded5aedd (patch)
tree5a11035b136b216f2033d78a1e4d6b6138c18772 /website/src/docs/features
parent043e202b1cbedad69d5521a83e791c106b49b10f (diff)
parent8326b6a7619fd9e4fb6a640d01c4bf0c6194dc81 (diff)
downloadLunaticChat-c8adb0505b3fa5d44a6f2b0aa1a3dd97ded5aedd.tar.gz
LunaticChat-c8adb0505b3fa5d44a6f2b0aa1a3dd97ded5aedd.tar.bz2
LunaticChat-c8adb0505b3fa5d44a6f2b0aa1a3dd97ded5aedd.zip
Merge pull request #224 from m1sk9/replace/lang
docs(website): make English the default locale
Diffstat (limited to 'website/src/docs/features')
-rw-r--r--website/src/docs/features/admin.md66
-rw-r--r--website/src/docs/features/channel-chat.md90
-rw-r--r--website/src/docs/features/direct-message.md40
-rw-r--r--website/src/docs/features/japanese-conversion.md68
-rw-r--r--website/src/docs/features/message-logging.md66
-rw-r--r--website/src/docs/features/velocity.md90
6 files changed, 210 insertions, 210 deletions
diff --git a/website/src/docs/features/admin.md b/website/src/docs/features/admin.md
index 57d38c0..c3a3d2f 100644
--- a/website/src/docs/features/admin.md
+++ b/website/src/docs/features/admin.md
@@ -2,73 +2,73 @@
layout: doc
---
-# 管理者向け機能
+# Admin Features
-サーバー管理者向けの機能をまとめて解説します.これらの機能は主に OP 権限を持つプレイヤーが利用できます.
+This page covers features intended for server administrators. These features are primarily available to players with OP permissions.
-## プラグインステータス (`/lc status`)
+## Plugin Status (`/lc status`)
-プラグインの動作状況を一覧で確認できます.
+View an overview of the plugin's operational status.
```
/lc status
```
-表示される情報:
+Displayed information:
-- プラグインバージョン (Git コミットハッシュ付き)
-- ヘルスステータス (OK / Degraded)
-- 各機能の有効/無効状態
-- 設定値 (デバッグモード,アップデート確認,言語)
-- GitHub,Modrinth,ドキュメントへのリンク
+- Plugin version (with Git commit hash)
+- Health status (OK / Degraded)
+- Enabled/disabled state of each feature
+- Configuration values (debug mode, update checking, language)
+- Links to GitHub, Modrinth, and documentation
-## スパイモード
+## Spy Mode
-`lunaticchat.spy` パーミッション (デフォルト: op) を持つプレイヤーは,サーバー上で送受信されるすべてのダイレクトメッセージを閲覧できます.
+Players with the `lunaticchat.spy` permission (default: op) can view all direct messages sent and received on the server.
-- スパイプレイヤーにはローマ字変換前の元のメッセージが表示されます
-- ホバーテキストでスパイメッセージであることが示されます
-- スパイプレイヤー自身は通常の送受信者リストには含まれません
+- Spy players see the original message before romaji conversion
+- Hover text indicates the message is a spy message
+- Spy players themselves are not included in the normal sender/recipient list
-## チャンネルバイパス
+## Channel Bypass
-`lunaticchat.channelbypass` パーミッション (デフォルト: op) を持つプレイヤーは,チャンネルに関する以下の制限を無視できます.
+Players with the `lunaticchat.channelbypass` permission (default: op) can bypass the following channel restrictions.
-- キック・BAN の対象にならない
-- オーナーでなくてもチャンネルを削除できる
+- Cannot be kicked or banned
+- Can delete channels even without being the owner
-## アップデート通知
+## Update Notifications
-`checkForUpdates` が `true` (デフォルト) の場合,プラグインは起動時に新しいバージョンが利用可能か確認します.`lunaticchat.noticeupdate` パーミッション (デフォルト: op) を持つプレイヤーがサーバーに参加した際にアップデート通知が表示されます.
+When `checkForUpdates` is `true` (default), the plugin checks for new versions at startup. Players with the `lunaticchat.noticeupdate` permission (default: op) receive an update notification when they join the server.
```yaml
# config.yml
checkForUpdates: true
```
-## デバッグモード
+## Debug Mode
-`debug` を `true` にすると,プラグインの詳細なログが出力されます.問題の調査やバグ報告時に有用です.
+Setting `debug` to `true` enables verbose plugin logging. This is useful for troubleshooting issues or submitting bug reports.
```yaml
# config.yml
debug: true
```
-## 言語設定
+## Language Setting
-プレイヤーに表示されるメッセージの言語を切り替えられます.プラグインログやコンソール出力には影響せず,英語のみ出力となります.
+You can change the language of messages displayed to players. Plugin logs and console output are not affected and remain in English only.
```yaml
# config.yml
-language: "ja" # "en" または "ja"
+language: "ja" # "en" or "ja"
```
-## 管理者パーミッション一覧
+## Admin Permissions Reference
-| パーミッション | デフォルト | 説明 |
-|---------------|-----------|------|
-| `lunaticchat.spy` | op | 全ダイレクトメッセージの閲覧 |
-| `lunaticchat.channelbypass` | op | チャンネル制限のバイパス |
-| `lunaticchat.noticeupdate` | op | アップデート通知の受信 |
-| `lunaticchat.command.lcv.status` | op | `/lcv status` コマンドの使用 |
+| Permission | Default | Description |
+|-----------|---------|-------------|
+| `lunaticchat.spy` | op | View all direct messages |
+| `lunaticchat.channelbypass` | op | Bypass channel restrictions |
+| `lunaticchat.noticeupdate` | op | Receive update notifications |
+| `lunaticchat.command.lcv.status` | op | Use the `/lcv status` command |
diff --git a/website/src/docs/features/channel-chat.md b/website/src/docs/features/channel-chat.md
index b0caa43..c06ea39 100644
--- a/website/src/docs/features/channel-chat.md
+++ b/website/src/docs/features/channel-chat.md
@@ -2,91 +2,91 @@
layout: doc
---
-# チャンネルチャット
+# Channel Chat
-チャンネルを作成してグループごとに会話を分離できます.この機能を利用するには `config.yml` で `features.channelChat.enabled` を `true` に設定してください.
+Create channels to separate conversations by group. To use this feature, set `features.channelChat.enabled` to `true` in `config.yml`.
-## チャンネルの作成
+## Creating a Channel
```
/lc channel create <channelId> <name> [description] [isPrivate]
```
-- `channelId`: チャンネルの一意な識別子 (英数字, `_`, `-` のみ, 3〜30文字)
-- `name`: チャンネルの表示名
-- `description`: チャンネルの説明 (省略可)
-- `isPrivate`: プライベートチャンネルにする場合は `true` (デフォルト: `false`)
+- `channelId`: A unique identifier for the channel (alphanumeric, `_`, `-` only, 3-30 characters)
+- `name`: The display name of the channel
+- `description`: A description of the channel (optional)
+- `isPrivate`: Set to `true` to make the channel private (default: `false`)
-作成者は自動的にオーナーになります.
+The creator automatically becomes the owner.
-## チャンネルへの参加・退出
+## Joining and Leaving Channels
```
-/lc channel join <channelId> # チャンネルに参加
-/lc channel leave # アクティブチャンネルから退出
-/lc channel switch <channelId> # アクティブチャンネルを切り替え
+/lc channel join <channelId> # Join a channel
+/lc channel leave # Leave the active channel
+/lc channel switch <channelId> # Switch the active channel
```
-プライベートチャンネルに参加するには,オーナーまたはモデレーターからの招待が必要です.
+Joining a private channel requires an invitation from the owner or a moderator.
-## アクティブチャンネル
+## Active Channel
-プレイヤーは複数のチャンネルに参加できますが,一度にアクティブにできるチャンネルは1つです.チャットメッセージはアクティブチャンネルに送信されます.`/lc channel switch` でアクティブチャンネルを切り替えられます.
+Players can join multiple channels, but only one channel can be active at a time. Chat messages are sent to the active channel. Use `/lc channel switch` to change the active channel.
```
-/lc channel status # 現在のアクティブチャンネルと参加チャンネル一覧を表示
+/lc channel status # Display the current active channel and list of joined channels
```
-## ロールと権限
+## Roles and Permissions
-チャンネルには3つのロールがあります.
+Channels have three roles.
-| ロール | 権限 |
-|--------|------|
-| **OWNER** | チャンネルの削除,モデレーター管理,オーナー譲渡,メンバー管理 |
-| **MODERATOR** | メンバーの招待,キック,BAN/BAN解除 |
-| **MEMBER** | チャットへの参加,チャンネル情報の閲覧 |
+| Role | Permissions |
+|------|-------------|
+| **OWNER** | Delete the channel, manage moderators, transfer ownership, manage members |
+| **MODERATOR** | Invite, kick, ban/unban members |
+| **MEMBER** | Participate in chat, view channel information |
-### モデレーター管理 (オーナーのみ)
+### Moderator Management (Owner Only)
```
-/lc channel mod <playerName> # モデレーター権限の付与/剥奪
-/lc channel ownership <playerName> # オーナー権限の譲渡
+/lc channel mod <playerName> # Grant/revoke moderator permissions
+/lc channel ownership <playerName> # Transfer ownership
```
-### メンバー管理 (オーナー / モデレーター)
+### Member Management (Owner / Moderator)
```
-/lc channel invite <playerName> # プレイヤーを招待
-/lc channel kick <playerName> # プレイヤーをキック
-/lc channel ban <playerName> # プレイヤーを BAN
-/lc channel unban <playerName> # BAN を解除
+/lc channel invite <playerName> # Invite a player
+/lc channel kick <playerName> # Kick a player
+/lc channel ban <playerName> # Ban a player
+/lc channel unban <playerName> # Unban a player
```
-## 制限設定
+## Limit Settings
-`config.yml` でチャンネルの上限を設定できます (すべて `0` で無制限) .
+You can set channel limits in `config.yml` (set to `0` for unlimited).
-| 設定キー | 説明 |
-|----------|------|
-| `maxChannelsPerServer` | サーバーあたりの最大チャンネル数 |
-| `maxMembersPerChannel` | チャンネルあたりの最大メンバー数 |
-| `maxMembershipPerPlayer` | プレイヤーあたりの最大参加チャンネル数 |
+| Setting Key | Description |
+|-------------|-------------|
+| `maxChannelsPerServer` | Maximum number of channels per server |
+| `maxMembersPerChannel` | Maximum number of members per channel |
+| `maxMembershipPerPlayer` | Maximum number of channels a player can join |
-## メッセージログ
+## Message Logging
-チャンネルメッセージは NDJSON 形式でログファイルに記録できます.ファイルは日次でローテーションされ,`maxFileSizeMB` を超えるとサフィックス付きの新しいファイルが作成されます.
+Channel messages can be logged in NDJSON format. Files are rotated daily, and a new file with a suffix is created when `maxFileSizeMB` is exceeded.
```json
{"timestamp":"2026-04-05T14:23:45.123Z","playerId":"550e8400-...","playerName":"Steve","channelId":"general","message":"Hello!"}
```
-ログ設定の詳細は[設定ページ](/docs/configuration)の `features.channelChat.messageLogging` を参照してください.
+See the `features.channelChat.messageLogging` section on the [Configuration page](/docs/configuration) for logging settings.
-## バイパス権限
+## Bypass Permission
-`lunaticchat.channelbypass` パーミッション (デフォルト: op) を持つプレイヤーは,キック・BAN の保護やチャンネルの強制削除が可能です.
+Players with the `lunaticchat.channelbypass` permission (default: op) are protected from kicks and bans, and can force-delete channels.
-## メッセージフォーマット
+## Message Format
-チャンネルメッセージの表示形式は `config.yml` の `messageFormat.channelMessageFormat` でカスタマイズできます.詳細は[メッセージフォーマット](/docs/reference/message-format)を参照してください.
+The display format for channel messages can be customized via `messageFormat.channelMessageFormat` in `config.yml`. See [Message Format](/docs/reference/message-format) for details.
diff --git a/website/src/docs/features/direct-message.md b/website/src/docs/features/direct-message.md
index 7b12aff..6aa9f42 100644
--- a/website/src/docs/features/direct-message.md
+++ b/website/src/docs/features/direct-message.md
@@ -2,51 +2,51 @@
layout: doc
---
-# ダイレクトメッセージ
+# Direct Message
-プレイヤー間で 1対1 のプライベートメッセージを送受信できます.
+Send and receive private 1-on-1 messages between players.
-## 基本的な使い方
+## Basic Usage
-### メッセージの送信
+### Sending a Message
```
/tell <player> <message>
```
-エイリアス: `/t`, `/msg`, `/m`, `/w`, `/whisper`
+Aliases: `/t`, `/msg`, `/m`, `/w`, `/whisper`
-指定したプレイヤーにダイレクトメッセージを送信します.受信したメッセージをクリックすると,送信者への返信コマンドが自動入力されます.
+Sends a direct message to the specified player. Clicking on a received message will auto-fill the reply command to the sender.
-### クイック返信
+### Quick Reply
```
/reply <message>
```
-エイリアス: `/r`
+Alias: `/r`
-最後にメッセージを送ってきたプレイヤーに返信します.該当するプレイヤーがいない場合は,最後にメッセージを送った相手に送信されます.
+Replies to the last player who sent you a message. If there is no such player, the message is sent to the last player you messaged.
-クイック返信を利用するには `config.yml` で `features.quickReplies.enabled` が `true` (デフォルト) である必要があります.
+To use quick reply, `features.quickReplies.enabled` must be `true` (default) in `config.yml`.
-## 通知設定
+## Notification Settings
-プレイヤーはダイレクトメッセージ受信時のサウンド通知を個別に制御できます.
+Players can individually control the sound notification when receiving direct messages.
```
-/lc settings notice on # 通知を有効化
-/lc settings notice off # 通知を無効化
+/lc settings notice on # Enable notifications
+/lc settings notice off # Disable notifications
```
-## ローマ字変換との連携
+## Integration with Japanese Conversion
-[ローマ字変換](/docs/features/japanese-conversion)が有効な場合,ダイレクトメッセージの内容も自動的に日本語に変換されます.変換はプレイヤーの `japanese` 設定に従います.
+When [Japanese Conversion](/docs/features/japanese-conversion) is enabled, direct message content is also automatically converted to Japanese. Conversion follows each player's `japanese` setting.
-## スパイ機能
+## Spy Feature
-`lunaticchat.spy` パーミッション (デフォルト: op) を持つプレイヤーは,サーバー上のすべてのダイレクトメッセージを閲覧できます.スパイプレイヤーには変換前のメッセージが表示されます.
+Players with the `lunaticchat.spy` permission (default: op) can view all direct messages on the server. Spy players see the original message before conversion.
-## メッセージフォーマット
+## Message Format
-ダイレクトメッセージの表示形式は `config.yml` の `messageFormat.directMessageFormat` でカスタマイズできます.詳細は[メッセージフォーマット](/docs/reference/message-format)を参照してください.
+The display format for direct messages can be customized via `messageFormat.directMessageFormat` in `config.yml`. See [Message Format](/docs/reference/message-format) for details.
diff --git a/website/src/docs/features/japanese-conversion.md b/website/src/docs/features/japanese-conversion.md
index e5e751b..3bcd52b 100644
--- a/website/src/docs/features/japanese-conversion.md
+++ b/website/src/docs/features/japanese-conversion.md
@@ -2,61 +2,61 @@
layout: doc
---
-# ローマ字変換
+# Japanese Conversion
-ローマ字で入力したチャットメッセージを自動的に日本語に変換します.この機能を利用するには `config.yml` で `features.japaneseConversion.enabled` を `true` に設定してください.
+Automatically converts chat messages typed in romaji into Japanese. To use this feature, set `features.japaneseConversion.enabled` to `true` in `config.yml`.
-## 変換の仕組み
+## How Conversion Works
-変換は2段階で行われます.
+Conversion is performed in two stages.
-1. **ローマ字 → ひらがな**: プラグイン内蔵の Trie ベースの変換エンジンでローマ字をひらがなに変換します
-2. **ひらがな → 漢字/カナ**: Google IME API を使用してひらがなを自然な日本語に変換します
+1. **Romaji to Hiragana**: The plugin's built-in Trie-based conversion engine converts romaji to hiragana
+2. **Hiragana to Kanji/Katakana**: The Google IME API converts hiragana into natural Japanese
-### 変換例
+### Conversion Example
```
-入力: konnichiha sekai
-変換1: こんにちは せかい
-変換2: こんにちは 世界
+Input: konnichiha sekai
+Stage 1: こんにちは せかい
+Stage 2: こんにちは 世界
```
-## 変換対象
+## Conversion Targets
-- 通常チャット
-- ダイレクトメッセージ (`/tell`, `/reply`)
-- チャンネルチャット
+- Normal chat
+- Direct messages (`/tell`, `/reply`)
+- Channel chat
-入力が有効なローマ字でない場合 (英単語などが含まれる場合),変換は行われずそのまま送信されます.
+If the input is not valid romaji (e.g., contains English words), no conversion is performed and the message is sent as-is.
-## プレイヤー設定
+## Player Settings
-プレイヤーは個別に変換のオン/オフを切り替えられます.
+Players can individually toggle conversion on or off.
```
-/lc settings japanese on # 変換を有効化
-/lc settings japanese off # 変換を無効化
+/lc settings japanese on # Enable conversion
+/lc settings japanese off # Disable conversion
```
-## キャッシュ
+## Cache
-変換結果は単語単位でキャッシュされ,同じ単語の再変換時には API を呼び出さずにキャッシュから取得します.キャッシュは JSON ファイルとしてディスクに定期保存されます.
+Conversion results are cached per word. When the same word is converted again, the result is retrieved from cache instead of calling the API. The cache is periodically saved to disk as a JSON file.
-| 設定キー | デフォルト | 説明 |
-|----------|-----------|------|
-| `cache.maxEntries` | `500` | キャッシュの最大エントリ数 |
-| `cache.saveIntervalSeconds` | `300` | ディスク保存の間隔 (秒) |
-| `cache.filePath` | `"conversion_cache.json"` | キャッシュファイルのパス |
+| Setting Key | Default | Description |
+|-------------|---------|-------------|
+| `cache.maxEntries` | `500` | Maximum number of cache entries |
+| `cache.saveIntervalSeconds` | `300` | Interval for saving to disk (seconds) |
+| `cache.filePath` | `"conversion_cache.json"` | Path to the cache file |
-キャッシュが上限に達すると,古いエントリの10%が自動的に削除されます.
+When the cache reaches its limit, the oldest 10% of entries are automatically removed.
-## API 設定
+## API Settings
-Google IME API への接続に関する設定です.
+Settings related to the connection to the Google IME API.
-| 設定キー | デフォルト | 説明 |
-|----------|-----------|------|
-| `api.timeout` | `3000` | リクエストタイムアウト (ミリ秒) |
-| `api.retryAttempts` | `2` | 失敗時のリトライ回数 |
+| Setting Key | Default | Description |
+|-------------|---------|-------------|
+| `api.timeout` | `3000` | Request timeout (milliseconds) |
+| `api.retryAttempts` | `2` | Number of retry attempts on failure |
-API がタイムアウトまたは失敗した場合,ひらがなのまま送信されます.
+If the API times out or fails, the message is sent in hiragana as-is.
diff --git a/website/src/docs/features/message-logging.md b/website/src/docs/features/message-logging.md
index 944b9e9..5e929bc 100644
--- a/website/src/docs/features/message-logging.md
+++ b/website/src/docs/features/message-logging.md
@@ -2,11 +2,11 @@
layout: doc
---
-# メッセージログ
+# Message Logging
-チャンネルチャットのメッセージを NDJSON (Newline Delimited JSON) 形式でファイルに記録します.この機能はチャンネルチャットが有効な場合に利用でき,デフォルトで有効です.
+Records channel chat messages in NDJSON (Newline Delimited JSON) format to files. This feature is available when channel chat is enabled and is turned on by default.
-## 設定
+## Configuration
```yaml
# config.yml
@@ -19,33 +19,33 @@ features:
maxFileSizeMB: 100
```
-| 設定キー | デフォルト | 説明 |
-|----------|-----------|------|
-| `enabled` | `true` | メッセージログを有効にする |
-| `retentionDays` | `30` | ログファイルの保持日数 (`0` で無期限保持) |
-| `maxFileSizeMB` | `100` | 単一ログファイルの最大サイズ (MB) |
+| Setting Key | Default | Description |
+|-------------|---------|-------------|
+| `enabled` | `true` | Enable message logging |
+| `retentionDays` | `30` | Number of days to retain log files (`0` for unlimited retention) |
+| `maxFileSizeMB` | `100` | Maximum size of a single log file (MB) |
-## ログファイルの形式
+## Log File Format
-ログファイルは `plugins/LunaticChat/logs/` ディレクトリに保存されます.各行が1つの JSON オブジェクトです.
+Log files are saved in the `plugins/LunaticChat/logs/` directory. Each line is a single JSON object.
-### ファイル名
+### File Naming
```
channel-messages-YYYY-MM-dd.json
```
-ファイルサイズが `maxFileSizeMB` を超えた場合,サフィックス付きの新しいファイルが作成されます.
+When the file size exceeds `maxFileSizeMB`, a new file with a suffix is created.
```
-channel-messages-2026-04-05.json # 基本ファイル
-channel-messages-2026-04-05-1.json # サイズ超過時
-channel-messages-2026-04-05-2.json # さらに超過時
+channel-messages-2026-04-05.json # Base file
+channel-messages-2026-04-05-1.json # On size overflow
+channel-messages-2026-04-05-2.json # On further overflow
```
-### エントリ形式
+### Entry Format
-各行は以下の JSON 構造を持ちます.
+Each line has the following JSON structure.
```json
{
@@ -57,37 +57,37 @@ channel-messages-2026-04-05-2.json # さらに超過時
}
```
-| フィールド | 型 | 説明 |
-|-----------|------|------|
-| `timestamp` | String | ISO 8601 形式のタイムスタンプ (UTC) |
-| `playerId` | String | プレイヤーの UUID |
-| `playerName` | String | プレイヤーの表示名 |
-| `channelId` | String | メッセージが送信されたチャンネルの ID |
-| `message` | String | メッセージの内容 |
+| Field | Type | Description |
+|-------|------|-------------|
+| `timestamp` | String | ISO 8601 timestamp (UTC) |
+| `playerId` | String | Player UUID |
+| `playerName` | String | Player display name |
+| `channelId` | String | ID of the channel the message was sent to |
+| `message` | String | Message content |
-## ファイルローテーション
+## File Rotation
-- **日次ローテーション**: 日付が変わると新しいファイルが作成されます
-- **サイズローテーション**: `maxFileSizeMB` を超えるとサフィックス付きファイルに切り替わります
-- **自動クリーンアップ**: `retentionDays` で指定した日数を超えたログファイルは自動的に削除されます (`0` の場合は削除されません)
+- **Daily rotation**: A new file is created when the date changes
+- **Size rotation**: Switches to a suffixed file when `maxFileSizeMB` is exceeded
+- **Automatic cleanup**: Log files older than the number of days specified by `retentionDays` are automatically deleted (no deletion when set to `0`)
-## ログの活用例
+## Usage Examples
-NDJSON 形式のため,`jq` などのツールで簡単にフィルタリング・集計が可能です.
+Since the format is NDJSON, you can easily filter and aggregate logs using tools like `jq`.
-### 特定チャンネルのメッセージを抽出
+### Extract Messages from a Specific Channel
```bash
jq 'select(.channelId == "general")' channel-messages-2026-04-05.json
```
-### 特定プレイヤーのメッセージを抽出
+### Extract Messages from a Specific Player
```bash
jq 'select(.playerName == "Steve")' channel-messages-2026-04-05.json
```
-### メッセージ数をチャンネルごとに集計
+### Count Messages by Channel
```bash
jq -s 'group_by(.channelId) | map({channel: .[0].channelId, count: length})' channel-messages-2026-04-05.json
diff --git a/website/src/docs/features/velocity.md b/website/src/docs/features/velocity.md
index 3fa919e..f43fd65 100644
--- a/website/src/docs/features/velocity.md
+++ b/website/src/docs/features/velocity.md
@@ -2,87 +2,87 @@
layout: doc
---
-# Velocity 連携
+# Velocity Integration
-Velocity プロキシを経由して複数の Paper / Folia サーバー間でグローバルチャットをリレーします.
+Relays global chat across multiple Paper / Folia servers via a Velocity proxy.
-::: tip 互換性について
-Paper プラグインと Velocity プラグインは独立にバージョン管理されています.**両方の最新版を使えば常に動作します.** 古いバージョンを混在させたい場合は,[Paper / Velocity 互換性](/docs/reference/compatibility) を参照してください.
+::: tip About compatibility
+The Paper and Velocity plugins are versioned independently. **Using the latest of both always works.** If you need to mix older versions, see [Paper / Velocity Compatibility](/docs/reference/compatibility).
:::
-## セットアップ
+## Setup
-### 1. Velocity プラグインの導入
+### 1. Install the Velocity Plugin
-`LunaticChat-<version>-velocity.jar` を Velocity の `plugins/` ディレクトリに配置し,プロキシを再起動します.
+Place `LunaticChat-<version>-velocity.jar` in the Velocity `plugins/` directory and restart the proxy.
-### 2. Paper 側の設定
+### 2. Paper-Side Configuration
-各 Paper サーバーの `config.yml` で以下を設定します.
+Set the following in each Paper server's `config.yml`.
```yaml
features:
velocityIntegration:
enabled: true
crossServerGlobalChat: true
- serverName: "survival" # Velocity 設定のサーバー名に合わせる
+ serverName: "survival" # Must match the server name in the Velocity configuration
```
-### 3. 接続の確認
+### 3. Verify the Connection
```
/lcv status
```
-接続状態,プロトコルバージョン,Velocity プラグインのバージョンなどを確認できます (パーミッション: `lunaticchat.command.lcv.status`, デフォルト: op) .
+You can check the connection status, protocol version, Velocity plugin version, and more (permission: `lunaticchat.command.lcv.status`, default: op).
-## クロスサーバーグローバルチャット
+## Cross-Server Global Chat
-`crossServerGlobalChat` を `true` にすると,プレイヤーのチャットメッセージが Velocity を経由して他のすべての Paper サーバーに中継されます.
+When `crossServerGlobalChat` is set to `true`, player chat messages are relayed via Velocity to all other Paper servers.
-### メッセージの流れ
+### Message Flow
-1. プレイヤーがチャットメッセージを送信
-2. Paper サーバーがメッセージを Velocity に送信
-3. Velocity が送信元以外の全サーバーにメッセージを中継
-4. 各サーバーのプレイヤーにメッセージが表示される
+1. A player sends a chat message
+2. The Paper server sends the message to Velocity
+3. Velocity relays the message to all servers except the sender's
+4. The message is displayed to players on each server
-### メッセージ重複排除
+### Message Deduplication
-各メッセージに一意な ID が付与され,キャッシュにより同じメッセージが重複して表示されることを防ぎます.キャッシュサイズは `messageDeduplicationCacheSize` (デフォルト: `100`) で設定できます.
+Each message is assigned a unique ID, and a cache prevents the same message from being displayed more than once. The cache size can be configured with `messageDeduplicationCacheSize` (default: `100`).
-## 接続状態
+## Connection States
-`/lcv status` で確認できる状態と,それぞれの意味は以下の通りです.
+The states reported by `/lcv status` and their meanings:
-| 状態 | 説明 |
-|------|------|
-| `DISCONNECTED` | 未接続 |
-| `HANDSHAKING` | ハンドシェイク中 |
-| `CONNECTED` | 接続済み |
-| `FAILED` | 接続失敗 |
+| State | Description |
+|-------|-------------|
+| `DISCONNECTED` | Not connected |
+| `HANDSHAKING` | Handshake in progress |
+| `CONNECTED` | Connected |
+| `FAILED` | Connection failed |
-ハンドシェイクのタイムアウトは 5 秒です.タイムアウトした場合,状態は `FAILED` になります.
+The handshake timeout is 5 seconds. If the handshake times out, the state becomes `FAILED`.
-### `FAILED` になったときの確認ポイント
+### Troubleshooting `FAILED`
-- Velocity プラグインが正しく導入され,プロキシが起動しているか
-- Paper の `serverName` が Velocity 設定のサーバー名と一致しているか
-- Paper / Velocity プラグインの**プロトコルバージョン**が互換であるか — [互換性マトリクス](/docs/reference/compatibility#互換性マトリクス) で確認できます
+- Confirm the Velocity plugin is installed and the proxy is running
+- Confirm the Paper `serverName` matches the server name configured in Velocity
+- Confirm the **protocol versions** of the Paper and Velocity plugins are compatible — see the [compatibility matrix](/docs/reference/compatibility#compatibility-matrix)
-## 設定一覧
+## Configuration Reference
-| 設定キー | デフォルト | 説明 |
-|----------|-----------|------|
-| `enabled` | `false` | Velocity 連携を有効にする |
-| `crossServerGlobalChat` | `false` | クロスサーバーグローバルチャットを有効にする |
-| `serverName` | `"Unknown"` | クロスサーバーチャットで表示されるサーバー名 |
-| `messageDeduplicationCacheSize` | `100` | メッセージ重複排除キャッシュのサイズ |
+| Setting Key | Default | Description |
+|-------------|---------|-------------|
+| `enabled` | `false` | Enable Velocity integration |
+| `crossServerGlobalChat` | `false` | Enable cross-server global chat |
+| `serverName` | `"Unknown"` | Server name displayed in cross-server chat |
+| `messageDeduplicationCacheSize` | `100` | Size of the message deduplication cache |
-## メッセージフォーマット
+## Message Format
-クロスサーバーチャットの表示形式は `config.yml` の `messageFormat.crossServerGlobalChatFormat` でカスタマイズできます.詳細は[メッセージフォーマット](/docs/reference/message-format)を参照してください.
+The display format for cross-server chat can be customized via `messageFormat.crossServerGlobalChatFormat` in `config.yml`. See [Message Format](/docs/reference/message-format) for details.
-## 関連ドキュメント
+## Related Documents
-- [Paper / Velocity 互換性](/docs/reference/compatibility) — プロトコルバージョンとローリングアップデートの詳細
+- [Paper / Velocity Compatibility](/docs/reference/compatibility) — protocol version and rolling update details