summaryrefslogtreecommitdiff
path: root/docs/src/en/guide/player
diff options
context:
space:
mode:
authorSho Sakuma <me@m1sk9.dev>2026-01-24 05:01:27 +0900
committerGitHub <noreply@github.com>2026-01-24 05:01:27 +0900
commite3387a401c6d0d094b3afa734558e9257465a42b (patch)
tree4202c404fc72249f117162a37a573bcec274d555 /docs/src/en/guide/player
parentac80dc3ce71f9be0397442208cac80f6069eea03 (diff)
parentf6b0baf90c20a1d3b0cd53629102883b4bd913c6 (diff)
downloadLunaticChat-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/en/guide/player')
-rw-r--r--docs/src/en/guide/player/channel-chat.md13
-rw-r--r--docs/src/en/guide/player/direct-message.md65
-rw-r--r--docs/src/en/guide/player/japanese-romanization.md101
3 files changed, 179 insertions, 0 deletions
diff --git a/docs/src/en/guide/player/channel-chat.md b/docs/src/en/guide/player/channel-chat.md
new file mode 100644
index 0000000..f1dcbf0
--- /dev/null
+++ b/docs/src/en/guide/player/channel-chat.md
@@ -0,0 +1,13 @@
+# Channel Chat <Badge type="tip" text="v0.6.0" /> <Badge type="warning" text="Experimental" />
+
+This feature allows specific players to share chat.
+
+::: warning Experimental Feature
+
+This feature is currently implemented experimentally, and specifications may change in future updates.
+
+Since this is a large-scale feature, we plan to implement it gradually rather than all at once.
+
+For detailed implementation plans, see the [Roadmap (m1sk9/LunaticChat #54)](https://github.com/m1sk9/LunaticChat/issues/54).
+
+:::
diff --git a/docs/src/en/guide/player/direct-message.md b/docs/src/en/guide/player/direct-message.md
new file mode 100644
index 0000000..2cbc084
--- /dev/null
+++ b/docs/src/en/guide/player/direct-message.md
@@ -0,0 +1,65 @@
+# Direct Messages <Badge type="tip" text="v0.1.0" />
+
+The direct message feature allows you to send messages to specific players only.
+
+## Sending Messages
+
+To send a message, use the [`/tell`](../../reference/commands/tell.md) command.
+
+You can only send messages to online players. Messages cannot be sent to offline players.
+
+```
+/tell <player> <message>
+```
+
+::: tip Auto-completion Feature
+
+LunaticChat supports player name auto-completion during chat input.
+
+For example, if you type `/tell Al`, online player names starting with `Al` will be suggested as candidates.
+
+:::
+
+::: warning Operation in GeyserMC Environments
+
+We do not guarantee functionality for players connecting from Minecraft Bedrock Edition using GeyserMC environments.
+
+Since LunaticChat is designed based on the Minecraft Java Edition/Paper chat system, issues may occur when operating through GeyserMC. There are no plans to support this.
+
+:::
+
+## Quick Reply Feature <Badge type="tip" text="v0.1.0" />
+
+LunaticChat provides a quick reply feature that allows you to quickly respond to the most recent player who sent you a direct message.
+
+To use quick reply, use the [`/reply`](../../reference/commands/reply.md) command.
+
+```
+/reply <message>
+```
+
+::: warning If This Command Cannot Be Used
+
+This command may be disabled (this feature can be toggled ON/OFF in the configuration).
+
+Please contact your server administrator.
+
+:::
+
+## Notification Settings <Badge type="tip" text="v0.4.0" />
+
+As of v0.4.0, you can change the notification settings for direct messages.
+
+A notification sound will play when you receive or send a direct message.
+
+To change notification settings, use the [`/lc settings`](../../reference/commands/lc/settings.md) command.
+
+::: tip Client Volume Settings
+
+This notification sound depends on the **Players** category volume setting on the client.
+
+If you cannot hear LunaticChat's notification sound, check your client's volume settings.
+
+![](/static/direct-message/minecraft-player-sound.png)
+
+:::
diff --git a/docs/src/en/guide/player/japanese-romanization.md b/docs/src/en/guide/player/japanese-romanization.md
new file mode 100644
index 0000000..e851bb9
--- /dev/null
+++ b/docs/src/en/guide/player/japanese-romanization.md
@@ -0,0 +1,101 @@
+# Romanization Conversion <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper" />
+
+LunaticChat provides a feature to convert Japanese text from romaji.
+
+## Enabling/Disabling
+
+The romanization conversion feature is enabled by default.
+
+You can toggle the romanization conversion setting using the [`/lc settings`](../../reference/commands/lc/settings.md) command.
+
+## Conversion Process
+
+LunaticChat converts text from players through the following steps:
+
+1. Verify that the player's text is composed of romaji
+2. Check if the phrase exists in the memory cache
+ 1. If a matching phrase is found here, return it to the server
+3. If it doesn't exist in the memory cache, convert from romaji to hiragana
+4. Send the converted string to the Google IME API to convert it to a human-readable form
+5. Save to memory cache and return it to the server
+
+```
+┌───────────────────────────────────────────────────┐
+│ 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 Saving to File
+
+To avoid adding load, the contents of the memory cache are automatically saved to file cache at configured intervals and after server shutdown.
+
+:::
+
+For information on cache files, see [here](../admin/cache.md).
+
+## Improved Cache Strategy <Badge type="tip" text="v0.5.0" />
+
+As of v0.5.0, LunaticChat has improved the cache strategy for romanization conversion.
+
+Player chat is now cached word by word, enabling more efficient conversion.
+
+For example, consider the following long chat message:
+
+> 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 doesn't convert this sentence all at once, but splits and caches it word by word.
+
+This means that if words like "konnichiwa" or "minna" are already cached, those words don't need to be converted again, significantly improving conversion speed.
+
+### First Conversion
+
+```
+Input: "konnichiwa minna ohayou gozaimasu"
+
+konnichiwa → API → こんにちは (cached)
+minna → API → みんな (cached)
+ohayou → API → おはよう (cached)
+gozaimasu → API → ございます (cached)
+
+Result: "こんにちは みんな おはよう ございます"
+API Calls: 4
+```
+
+### Second Conversion
+
+```
+Input: "ohayou gozaimasu kyou wa ii tenki desu"
+
+ohayou → Cache hit → おはよう
+gozaimasu → Cache hit → ございます
+kyou → API → 今日 (cached)
+wa → API → は (cached)
+ii → API → いい (cached)
+tenki → API → 天気 (cached)
+desu → API → です (cached)
+
+Result: "おはよう ございます 今日 は いい 天気 です"
+API Calls: 5 (Cache hits: 2)
+```