diff options
| author | Sho Sakuma <me@m1sk9.dev> | 2026-01-24 05:01:27 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-01-24 05:01:27 +0900 |
| commit | e3387a401c6d0d094b3afa734558e9257465a42b (patch) | |
| tree | 4202c404fc72249f117162a37a573bcec274d555 /docs/src/guide/player | |
| parent | ac80dc3ce71f9be0397442208cac80f6069eea03 (diff) | |
| parent | f6b0baf90c20a1d3b0cd53629102883b4bd913c6 (diff) | |
| download | LunaticChat-0.5.0.tar.gz LunaticChat-0.5.0.tar.bz2 LunaticChat-0.5.0.zip | |
Merge pull request #65 from m1sk9/chore/release-beta-stagev0.5.0
chore: Release to beta stage
Diffstat (limited to 'docs/src/guide/player')
| -rw-r--r-- | docs/src/guide/player/channel-chat.md | 13 | ||||
| -rw-r--r-- | docs/src/guide/player/direct-message.md | 65 | ||||
| -rw-r--r-- | docs/src/guide/player/japanese-romanization.md | 101 |
3 files changed, 179 insertions, 0 deletions
diff --git a/docs/src/guide/player/channel-chat.md b/docs/src/guide/player/channel-chat.md new file mode 100644 index 0000000..ce5a43e --- /dev/null +++ b/docs/src/guide/player/channel-chat.md @@ -0,0 +1,13 @@ +# チャンネルチャット <Badge type="tip" text="v0.6.0" /> <Badge type="warning" text="試験的" /> + +特定のプレイヤー間で,チャットを共有できる機能です. + +::: warning 試験的機能 + +この機能は現在,試験的に実装されており,今後のアップデートで仕様が変更される可能性があります. + +規模が大きい機能なので,一気に実装はせず段階的な展開を予定しています. + +詳しい実装計画は [ロードマップ (m1sk9/LunaticChat #54)](https://github.com/m1sk9/LunaticChat/issues/54) をご覧ください. + +::: diff --git a/docs/src/guide/player/direct-message.md b/docs/src/guide/player/direct-message.md new file mode 100644 index 0000000..78de1c3 --- /dev/null +++ b/docs/src/guide/player/direct-message.md @@ -0,0 +1,65 @@ +# ダイレクトメッセージ <Badge type="tip" text="v0.1.0" /> + +特定のプレイヤーに対してのみメッセージを送信するダイレクトメッセージ機能です. + +## メッセージを送信する + +メッセージを送信するには [`/tell`](../../reference/commands/tell.md) コマンドを使用します. + +オンラインプレイヤーに対してのみメッセージを送信できます.オフラインプレイヤーには送信できません. + +``` +/tell <player> <message> +``` + +::: tip 補完機能 + +LunaticChat はチャット入力時にプレイヤー名の補完をサポートしています. + +例えば,`/tell Al` と入力した場合,`Al` で始まるオンラインプレイヤー名が候補として表示されます. + +::: + +::: warning GeyserMC 環境での動作 + +GeyserMC 環境を用いて Minecraft Bedrock Edition から接続しているプレイヤーに機能を提供している場合の動作は保証していません. + +LunaticChat は Minecraft Java Edition / Paper のチャットシステムを前提として設計されているため,GeyserMC 経由での動作に問題が発生する可能性があります.対応の予定はありません. + +::: + +## クイックリプライ機能 <Badge type="tip" text="v0.1.0" /> + +LunaticChat では,直前にダイレクトメッセージを送信した相手に対して素早く返信できるクイックリプライ機能が提供されています. + +クイックリプライを使用するには [`/reply`](../../reference/commands/reply.md) コマンドを使用します. + +``` +/reply <message> +``` + +::: warning このコマンドが使用できない場合 + +このコマンドが無効化されている可能性があります (この機能は設定で ON/OFF できるため) + +サーバーの管理者に連絡してください. + +::: + +## 通知設定 <Badge type="tip" text="v0.4.0" /> + +v0.4.0 以降,ダイレクトメッセージの通知設定を変更できるようになりました. + +ダイレクトメッセージを受信・送信時に通知音がなるようになります. + +通知設定を変更するには [`/lc settings`](../../reference/commands/lc/settings.md) コマンドを使用します. + +::: tip クライアントでの音量設定 + +この通知音はクライアント上の **プレイヤー** カテゴリーの音量設定に依存します. + +LunaticChat の通知音が聞こえない場合は,クライアントの音量設定を確認してください. + + + +::: diff --git a/docs/src/guide/player/japanese-romanization.md b/docs/src/guide/player/japanese-romanization.md new file mode 100644 index 0000000..3b62e51 --- /dev/null +++ b/docs/src/guide/player/japanese-romanization.md @@ -0,0 +1,101 @@ +# ローマ字変換 <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper" /> + +LunaticChat では、日本語のテキストをローマ字に変換する機能が提供されています. + +## 有効化・無効化 + +ローマ字変換機能はデフォルトで有効化されています. + +[`/lc settings`](../../reference/commands/lc/settings.md) コマンドを使用して,ローマ字変換の設定を切り替えることができます. + +## 変換の仕組み + +LunaticChat はプレイヤーからのテキストを以下の手順で変換を行います. + +1. プレイヤーからのテキストがローマ字で構成されているかを検証する +2. メモリキャッシュから該当のフレーズがあるかどうかを調べる + 1. ここで該当フレーズがヒットした場合はそれをサーバーに返す +3. メモリキャッシュに存在していない場合は,ローマ字からひらがなに変換する +4. 変換した文字列を Google IME API へ送り,人が読める形に変換する +5. メモリキャッシュに保存し,それをサーバーに返す + +``` +┌───────────────────────────────────────────────────┐ +│ User Input │ +│ (Romanji Text) │ +└─────────────────────┬─────────────────────────────┘ + │ + ▼ +┌───────────────────────────────────────────────────┐ +│ RomanjiConverter │ +│ ┌───────────────────────────────────────────┐ │ +│ │ 1. Check Memory Cache │ │ +│ │ └─→ Hit: Return immediately │ │ +│ │ │ │ +│ │ 2. Call Google IME API │ │ +│ │ │ │ +│ │ 3. Store in Memory Cache │ │ +│ │ │ │ +│ │ 4. Queue for Disk Save (async) │ │ +│ └───────────────────────────────────────────┘ │ +└─────────────────────┬─────────────────────────────┘ + │ + ▼ +┌───────────────────────────────────────────────────┐ +│ Converted Text │ +│ (Japanese Text) │ +└───────────────────────────────────────────────────┘ +``` + +::: tip ファイルへの保存 + +メモリキャッシュの内容は負荷にならないよう,設定した秒毎・サーバ停止後にファイルキャッシュへ自動でセーブします. + +::: + +キャッシュファイルに関する情報は [こちら](../admin/cache.md) をご覧ください. + +## 改善されたキャッシュ戦略 <Badge type="tip" text="v0.5.0" /> + +v0.5.0 以降,LunaticChat はローマ字変換のキャッシュ戦略を改善しました. + +プレイヤーのチャットを単語ごとにキャッシュするようになり,より効率的に変換を行えるようになりました. + +例えば,以下のような長文のチャットがあるとします. + +> konnichiwa minna ohayou gozaimasu kyou wa totemo ii tenki desu ne bokutachi wa issho ni asobi ni ikimashou kono atarashii game wo tameshite mitai to omoimasu sore wa totemo omoshiroi to kiite imasu arigatou gozaimasu mata ne + +LunaticChat はこの文章を一度に変換するのではなく,単語ごとに分割してキャッシュを行います. + +これにより,例えば「konnichiwa」や「minna」などの単語が既にキャッシュされている場合,それらの単語は再度変換する必要がなくなり,変換速度が大幅に向上します. + +### 1回目の変換 + +``` +入力: "konnichiwa minna ohayou gozaimasu" + +konnichiwa → API → こんにちは (キャッシュ保存) +minna → API → みんな (キャッシュ保存) +ohayou → API → おはよう (キャッシュ保存) +gozaimasu → API → ございます (キャッシュ保存) + +結果: "こんにちは みんな おはよう ございます" +APIコール: 4回 +``` + +### 2回目の変換 + +``` +入力: "ohayou gozaimasu kyou wa ii tenki desu" + +ohayou → キャッシュヒット → おはよう +gozaimasu → キャッシュヒット → ございます +kyou → API → 今日 (キャッシュ保存) +wa → API → は (キャッシュ保存) +ii → API → いい (キャッシュ保存) +tenki → API → 天気 (キャッシュ保存) +desu → API → です (キャッシュ保存) + +結果: "おはよう ございます 今日 は いい 天気 です" +APIコール: 5回(キャッシュヒット: 2回) +``` |
