diff options
| author | Sho Sakuma <me@m1sk9.dev> | 2026-08-05 04:36:50 +0900 |
|---|---|---|
| committer | Sho Sakuma <me@m1sk9.dev> | 2026-08-05 04:36:50 +0900 |
| commit | 418be2d127ce2d6a3ed5e9c876deb9c2aafc089b (patch) | |
| tree | db800a91ac8fb05ae870b50014dc7fe06f274c47 /website/src/ja/docs/features | |
| parent | 048932276d0c1e11d463f8b9aea872e498b04743 (diff) | |
| download | LunaticChat-418be2d127ce2d6a3ed5e9c876deb9c2aafc089b.tar.gz LunaticChat-418be2d127ce2d6a3ed5e9c876deb9c2aafc089b.tar.bz2 LunaticChat-418be2d127ce2d6a3ed5e9c876deb9c2aafc089b.zip | |
docs: correct the website where it had drifted from the implementation
Several statements were wrong rather than merely thin, and each would have set
the wrong expectation:
- the conversion example implied romaji replaces the input, when the result is
appended in parentheses and both are sent
- the handshake was described as happening at startup, when it waits for the
first player to join, so a DISCONNECTED status on an empty server read as a
fault
- cache eviction was called oldest-first, which the unordered in-memory map
cannot provide
- the Velocity settings table omitted crossServerDirectMessage
- ConfigManager was described as reading Bukkit's FileConfiguration, and the
settings storage as recovering from a backup that does not exist
It also documents behaviour that had no mention anywhere: the `!` force-global
prefix, that spy sees channel messages and not only DMs, the nightly build
warnings, the overall 1000ms conversion budget that makes api.timeout above it
ineffective, and the data files the plugin writes.
Co-Authored-By: Claude <noreply@anthropic.com>
Diffstat (limited to 'website/src/ja/docs/features')
| -rw-r--r-- | website/src/ja/docs/features/admin.md | 15 | ||||
| -rw-r--r-- | website/src/ja/docs/features/channel-chat.md | 17 | ||||
| -rw-r--r-- | website/src/ja/docs/features/direct-message.md | 9 | ||||
| -rw-r--r-- | website/src/ja/docs/features/japanese-conversion.md | 12 | ||||
| -rw-r--r-- | website/src/ja/docs/features/velocity.md | 5 |
5 files changed, 53 insertions, 5 deletions
diff --git a/website/src/ja/docs/features/admin.md b/website/src/ja/docs/features/admin.md index 57d38c0..7d3874a 100644 --- a/website/src/ja/docs/features/admin.md +++ b/website/src/ja/docs/features/admin.md @@ -24,8 +24,10 @@ layout: doc ## スパイモード -`lunaticchat.spy` パーミッション (デフォルト: op) を持つプレイヤーは,サーバー上で送受信されるすべてのダイレクトメッセージを閲覧できます. +`lunaticchat.spy` パーミッション (デフォルト: op) を持つプレイヤーは,サーバー上で送信されるダイレクトメッセージとチャンネルメッセージの両方を閲覧できます. +- ダイレクトメッセージは,送信者と受信者を除いてスパイプレイヤーに配信されます +- チャンネルメッセージは,送信者とそのチャンネルのメンバーを除いてスパイプレイヤーに配信されます - スパイプレイヤーにはローマ字変換前の元のメッセージが表示されます - ホバーテキストでスパイメッセージであることが示されます - スパイプレイヤー自身は通常の送受信者リストには含まれません @@ -46,6 +48,15 @@ layout: doc checkForUpdates: true ``` +## Nightly ビルド + +リリース以外で `main` ブランチから作られたビルドは nightly として扱われ,プラグインがその旨を明示します. + +- すべてのプレイヤーに対して,ログイン時に不安定な可能性があることと GitHub Issues への案内が警告として表示されます +- `/lc status` にも同じ警告が表示され,リリースチャンネルが緑ではなく黄色で表示されます + +nightly ビルドは[セキュリティポリシー](https://github.com/m1sk9/LunaticChat/blob/main/.github/SECURITY.md)のサポート対象外です.本番サーバーではリリースビルドを使用してください. + ## デバッグモード `debug` を `true` にすると,プラグインの詳細なログが出力されます.問題の調査やバグ報告時に有用です. @@ -68,7 +79,7 @@ language: "ja" # "en" または "ja" | パーミッション | デフォルト | 説明 | |---------------|-----------|------| -| `lunaticchat.spy` | op | 全ダイレクトメッセージの閲覧 | +| `lunaticchat.spy` | op | 全ダイレクトメッセージ・チャンネルメッセージの閲覧 | | `lunaticchat.channelbypass` | op | チャンネル制限のバイパス | | `lunaticchat.noticeupdate` | op | アップデート通知の受信 | | `lunaticchat.command.lcv.status` | op | `/lcv status` コマンドの使用 | diff --git a/website/src/ja/docs/features/channel-chat.md b/website/src/ja/docs/features/channel-chat.md index dce3c85..b9723ee 100644 --- a/website/src/ja/docs/features/channel-chat.md +++ b/website/src/ja/docs/features/channel-chat.md @@ -37,6 +37,19 @@ layout: doc /lc channel status # 現在のアクティブチャンネルと参加チャンネル一覧を表示 ``` +## グローバルチャットへの送信 (`!` プレフィックス) + +アクティブチャンネルがある間,チャットはそのチャンネルに送信されます.メッセージの先頭に `!` を付けると,チャンネルから退出したり切り替えたりせずに,そのメッセージだけをグローバルチャットへ送信できます. + +``` +!みんなこんにちは # アクティブチャンネルがあってもグローバルチャットへ送信される +``` + +`!` とその直後の空白は送信前に除去されるため,メッセージ本文には残りません.`!` のみのメッセージは破棄され,何も送信されません. + +> [!NOTE] +> このプレフィックスはチャットリスナーが処理します.リスナーはチャンネルチャット・クロスサーバーグローバルチャット・ローマ字変換のいずれかが有効なときのみ登録されるため,3つすべてが無効な場合は先頭の `!` は入力したまま残ります. + ## ロールと権限 チャンネルには3つのロールがあります. @@ -87,6 +100,10 @@ layout: doc `lunaticchat.channelbypass` パーミッション (デフォルト: op) を持つプレイヤーは,キック・BAN の保護やチャンネルの強制削除が可能です. +## スパイモード + +チャンネルメッセージは管理者に対して非公開ではありません.`lunaticchat.spy` パーミッション (デフォルト: op) を持つプレイヤーには,送信者とそのチャンネルのメンバーを除いてチャンネルメッセージが配信されます.詳細は[スパイモード](/ja/docs/features/admin#スパイモード)を参照してください. + ## メッセージフォーマット チャンネルメッセージの表示形式は `config.yml` の `messageFormat.channelMessageFormat` でカスタマイズできます.詳細は[メッセージフォーマット](/ja/docs/reference/message-format)を参照してください. diff --git a/website/src/ja/docs/features/direct-message.md b/website/src/ja/docs/features/direct-message.md index 945a2db..337759d 100644 --- a/website/src/ja/docs/features/direct-message.md +++ b/website/src/ja/docs/features/direct-message.md @@ -42,6 +42,15 @@ layout: doc /tell <player>@<server> <message> ``` +ここでのサーバー名は,**宛先サーバー側**の `features.velocityIntegration.serverName` に設定した値であり,Velocity が内部で使う名前ではありません.デフォルトの `"Unknown"` のままではサーバーを指定できないため,この機能を有効にする前に各サーバーへ名前を設定してください. + +送信が失敗する場合は次の2種類があり,送信者にどちらであるかが通知されます. + +| 理由 | 意味 | +|------|------| +| `SERVER_NOT_FOUND` | プロキシ配下にその `serverName` を報告しているサーバーが存在しない | +| `TARGET_OFFLINE` | サーバーは見つかったが,そのプレイヤーがオンラインでない | + ## 通知設定 プレイヤーはダイレクトメッセージ受信時のサウンド通知を個別に制御できます. diff --git a/website/src/ja/docs/features/japanese-conversion.md b/website/src/ja/docs/features/japanese-conversion.md index b94542e..1cc7d6b 100644 --- a/website/src/ja/docs/features/japanese-conversion.md +++ b/website/src/ja/docs/features/japanese-conversion.md @@ -19,8 +19,11 @@ layout: doc 入力: konnichiha sekai 変換1: こんにちは せかい 変換2: こんにちは 世界 +送信: konnichiha sekai §e(こんにちは 世界) ``` +入力した文字列は**置き換えられません**.入力したそのままの文字列を残し,その後ろに変換結果を括弧付きで併記するため,受信側には両方が表示されます. + ## 変換対象 - 通常チャット @@ -48,7 +51,7 @@ layout: doc | `cache.saveIntervalSeconds` | `300` | ディスク保存の間隔 (秒) | | `cache.filePath` | `"conversion_cache.json"` | キャッシュファイルのパス | -キャッシュが上限に達すると,古いエントリの10%が自動的に削除されます. +キャッシュが上限に達すると,エントリの10%が削除されます.どのエントリが削除されるかは規定されていません.メモリ上のキャッシュは順序を持たないため,古い順ではなく実質的に任意のエントリが対象になります. ## API 設定 @@ -56,6 +59,11 @@ Google IME API への接続に関する設定です. | 設定キー | デフォルト | 説明 | |----------|-----------|------| -| `api.timeout` | `3000` | リクエストタイムアウト (ミリ秒) | +| `api.timeout` | `3000` | API リクエスト1回あたりのタイムアウト (ミリ秒) | API がタイムアウトまたは失敗した場合,ひらがなのまま送信されます. + +> [!WARNING] +> `api.timeout` とは別に,1メッセージの変換処理全体に **1000ミリ秒**の上限があります.この上限に達すると変換は中断され,入力したそのままの文字列が (何も併記されずに) 送信されます. +> +> 変換全体の上限が `api.timeout` のデフォルト値より短いため,`api.timeout` を `1000` より大きくしても実質的な効果はありません. diff --git a/website/src/ja/docs/features/velocity.md b/website/src/ja/docs/features/velocity.md index 55ee653..010165c 100644 --- a/website/src/ja/docs/features/velocity.md +++ b/website/src/ja/docs/features/velocity.md @@ -51,6 +51,8 @@ features: 各メッセージに一意な ID が付与され,キャッシュにより同じメッセージが重複して表示されることを防ぎます.キャッシュサイズは `messageDeduplicationCacheSize` (デフォルト: `100`) で設定できます. +エントリは記録から 60 秒で期限切れになります.期限切れエントリを削除してもなお設定サイズを超えている場合は,残りのうち古いものから削除されます. + ## クロスサーバーダイレクトメッセージ <Badge type="tip" text="v1.3.0~" /> `crossServerDirectMessage` を `true` にすると,同プロキシ内で接続しているサーバーのプレイヤー同士でメッセージのやり取りができるようになります. @@ -80,7 +82,8 @@ features: |----------|-----------|------| | `enabled` | `false` | Velocity 連携を有効にする | | `crossServerGlobalChat` | `false` | クロスサーバーグローバルチャットを有効にする | -| `serverName` | `"Unknown"` | クロスサーバーチャットで表示されるサーバー名 | +| `crossServerDirectMessage` | `false` | クロスサーバーダイレクトメッセージを有効にする | +| `serverName` | `"Unknown"` | クロスサーバーチャットで表示されるサーバー名.`/tell <player>@<server>` の照合先にもなる | | `messageDeduplicationCacheSize` | `100` | メッセージ重複排除キャッシュのサイズ | ## メッセージフォーマット |
