diff options
Diffstat (limited to 'docs/src/en/player-guide')
18 files changed, 781 insertions, 0 deletions
diff --git a/docs/src/en/player-guide/about.md b/docs/src/en/player-guide/about.md new file mode 100644 index 0000000..388df7b --- /dev/null +++ b/docs/src/en/player-guide/about.md @@ -0,0 +1,60 @@ +# About LunaticChat + +LunaticChat is a chat plugin for the Minecraft server software Paper/Velocity. + +In 2013, [ucchyocean](https://github.com/ucchyocean) released [LunaChat](https://github.com/ucchyocean/LunaChat). LunaticChat is developed as a successor to LunaChat, rewritten from scratch to work with the latest versions. + +LunaChat is no longer being developed and does not support the latest Minecraft versions. While many server administrators have forked LunaChat, LunaticChat is designed as an alternative that inherits LunaChat's features while being designed to work with the latest Minecraft versions. + +## Key Features + +- **Lightweight and Fast**: LunaticChat is designed to maintain high performance while minimizing server load. +- **1-on-1 Direct Messaging**: Chat one-on-one using /tell or /msg commands. +- **Quick Reply**: Quickly reply to the most recent message sender with /reply. +- **Japanese Romanization Conversion**: Automatically converts messages input in romaji to Japanese. +- **CoreProtect Support**: LunaticChat's chat logs are compatible with CoreProtect. +- **High-Speed Performance with Caching**: Uses caching for romaji-to-Japanese conversion, operating faster than traditional LunaChat. +- **Latest Version Support**: Reduces dependencies on other plugins, always supporting the latest Minecraft versions. + +## Comparison + +| | LunaticChat | LunaChat | +| ----- |-------------|----------------------------------------| +| Development Status | Actively Developed | Development Ended | +| Supported Platforms | Paper / Velocity | Bukkit / Spigot / BungeeCord | +| Supported Versions | 1.21.x ~ | Up to 1.16.x | +| Language | Kotlin | Java | +| Plugin Dependencies | None | EssentialsX, etc. | +| Caching | Yes | No | +| Documentation | Yes | No | +| License | GNU General Public License v3.0 | GNU Lesser General Public License v3.0 | + +## FAQ + +### Is LunaticChat free to use? + +As open-source software, LunaticChat can be used, modified, and distributed for free. + +### Which Minecraft versions does LunaticChat support? + +LunaticChat supports Minecraft version 1.21.x and later. + +### Can LunaticChat be used alongside other chat plugins? + +LunaticChat can be used alongside other chat plugins, but to avoid conflicts, ensure that chat-related features do not overlap. + +### Where can I get support for LunaticChat? + +Support for LunaticChat is available on the [official GitHub Discussions](https://github.com/m1sk9/LunaticChat/discussions). + +### Where can I get the source code for LunaticChat? + +The source code for LunaticChat is available on [GitHub](https://github.com/m1sk9/LunaticChat). + +### Is there a Spigot/BungeeCord version of LunaticChat? + +No. There are no plans to support these platforms. Please use Paper/Velocity. + +### Under what license is LunaticChat distributed? + +LunaticChat is distributed under the GNU General Public License v3.0 (GPLv3). diff --git a/docs/src/en/player-guide/channel-chat/about.md b/docs/src/en/player-guide/channel-chat/about.md new file mode 100644 index 0000000..5130064 --- /dev/null +++ b/docs/src/en/player-guide/channel-chat/about.md @@ -0,0 +1,112 @@ +# 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). + +::: + +::: tip This feature must be enabled on the server + +If channel chat is disabled on the server, these features cannot be used. + +Please contact your server administrator. + +::: + +## Creating a Channel + +To use channel chat, you must first create a chat channel. + +Use the [`/lc channnel create`](../commands/lc/channel.md#lc-channel-create-channel-id-channel-name-channel-description-private-setting) command to create a chat channel. + +``` +/lc channel create <channel-id> <channel-name> [channel-description] [private-setting] +``` + +- `<channel-id>` specifies the channel ID. +- `<channel-name>` specifies the channel name. +- `[channel-description]` specifies the channel description (optional). + - The description will be displayed when viewing the channel list with the `/lc channel list` command. +- `[private-setting]` specifies the channel's privacy setting. + - If `true` is specified, it will be created as a private channel, and only invited players can join. + - If `false` is specified or omitted, it will be created as a public channel, and anyone can join. + +::: tip Channel ID Requirements + +Channel IDs must follow these requirements: + +- Must be between 3 and 30 characters long +- Can only contain alphanumeric characters, underscores (_), and hyphens (-) + +::: + +::: warning Notes on Entering Channel Names and Descriptions + +When entering channel names and descriptions, arguments must be enclosed in `"` (double quotes). + +Example: + +``` +/lc channel create pvp_channel "PvP Enthusiasts Club" "A gathering of people who love PvP" false +``` + +::: + +The channel will be created and a confirmation message will be displayed in chat. + +## Joining a Channel + +To join a created channel, use the [`/lc channel join`](../commands/lc/channel.md#lc-channel-join-channel-id) command. + +``` +/lc channel join <channel-id> +``` + +When you join a channel, your chat mode will switch from global chat to channel chat. + +## Viewing the Channel List + +To view the list of channels you can join, use the [`/lc channel list`](../commands/lc/channel.md#lc-channel-list) command. + +``` +/lc channel list +``` + +A list of available channels will be displayed in the chat. You can click on them or use the [`/lc channel join`](#joining-a-channel) command to join a channel. + +## Chat Modes + +In LunaticChat, there are two types of chat modes for players when sending chat messages: + +1. Global chat mode: Share chat with all players. +2. Channel chat mode: Share chat with players in a specific channel you have joined. + +Channel chat primarily uses chat mode `2`. + +For more details, see [here](./chatmode.md). + +## Difference Between Active Channel and Membership Status + +In LunaticChat, a player's active channel and membership status are managed separately. + +- Active channel: The channel used in channel chat mode +- Membership status: List of channels the player has joined + +Only one channel can be designated as the active channel at a time. To switch the active channel to a channel in your membership status, use the [`/lc channel switch`](../commands/lc/channel.md#lc-channel-switch-channel-id) command. + +``` +/lc channel switch <channel-id> +``` + +Removing a channel from your active status does not remove it from your membership status. To leave a channel, switch to it as your active channel first, then use the [`/lc channel leave`](../commands/lc/channel.md#lc-channel-leave) command. + +``` +/lc channel leave +``` diff --git a/docs/src/en/player-guide/channel-chat/chatmode.md b/docs/src/en/player-guide/channel-chat/chatmode.md new file mode 100644 index 0000000..02d6a18 --- /dev/null +++ b/docs/src/en/player-guide/channel-chat/chatmode.md @@ -0,0 +1,30 @@ +# Chat Mode + +Chat mode refers to the mode in which players send chat messages in LunaticChat. LunaticChat has the following two types of chat modes: + +1. Global chat mode: Share chat with all players. +2. Channel chat mode: Share chat with players in a specific channel you have joined. + +## Channel Chat Mode + +While in channel chat mode, all chat messages are displayed only to players in the channel you have joined and will not be displayed in global chat. + +::: tip Temporarily Send to Global Chat + +If you want to temporarily send a message to global chat while in channel chat mode, prefix your message with `!`. + +``` +!Hello everyone, how are you? +``` + +::: + +## Global Chat Mode + +While in global chat mode, you share chat with all players on the server. It functions the same as normal Minecraft chat. + +## Temporarily Switching Chat Modes + +To temporarily switch chat modes, use the `/chatmode toggle` command. + +When you switch using this command, you can change chat modes without joining or leaving channels. diff --git a/docs/src/en/player-guide/channel-chat/moderation.md b/docs/src/en/player-guide/channel-chat/moderation.md new file mode 100644 index 0000000..1867ec7 --- /dev/null +++ b/docs/src/en/player-guide/channel-chat/moderation.md @@ -0,0 +1,95 @@ +# Channel Management + +You can manage member behavior within a channel using channel chat moderation features. + +::: danger Warning + +These moderation features are only available for LunaticChat channel chat. + +If you need to punish actual rule violators, we recommend reporting them to the server administrator. + +::: + +## Moderation Feature Specifications + +Moderation features have several specifications: + +- Players with Bypass permissions are not affected by moderation features. + - This means you cannot use these features against server administrators. +- To use moderation features, you need the respective channel role and server permissions. +- The effects of moderation features are independent for each channel. + - For example, a player permanently banned (BAN) from one channel can chat normally in other channels. + +## Roles + +Channels have the following roles: + +- Member: Regular players participating in the channel +- Moderator: Players who can use channel moderation features +- Owner: The channel creator who can use all moderation features + +::: tip Moderation by Server Administrators + +Server administrators uniformly have the same permissions as owner permissions in all channels. + +::: + +## Temporarily Expel a Member (Kick) + +To temporarily expel a member from a channel, use the [`/lc channel kick`](../commands/lc/channel.md#lc-channel-kick-player-id) command. + +``` +/lc channel kick <player ID> +``` + +Executing this command will immediately expel the specified player from the channel. + +However, the expelled player can rejoin. + +## Permanently Ban a Member (Ban) + +To permanently ban a member from a channel, use the [`/lc channel ban`](../commands/lc/channel.md#lc-channel-ban-player-id) command. + +``` +/lc channel ban <player ID> +``` + +Executing this command will immediately expel the specified player from the channel and also prohibit them from rejoining. + +## Unban a Permanently Banned Member + +To unban a permanently banned member, use the [`/lc channel unban`](../commands/lc/channel.md#lc-channel-unban-player-id) command. + +``` +/lc channel unban <player ID> +``` + +## Appoint/Dismiss Moderators + +To appoint/dismiss a channel member as a moderator, use the [`/lc channel mod`](../commands/lc/channel.md#lc-channel-mod-player-id) command. + +``` +/lc channel mod <player ID> +``` + +Executing this command will appoint the specified player as a moderator. Executing this command again on an appointed player will dismiss them from being a moderator. + +## Transfer Owner Permissions + +To transfer channel owner permissions to another member, use the [`/lc channel ownership`](../commands/lc/channel.md#lc-channel-ownership-player-id) command. + +``` +/lc channel ownership <player ID> +``` + +Executing this command will transfer all owner permissions to the specified player. The original owner becomes a moderator. + +::: danger Important Notes on Execution + +- Owner permission transfer is an irreversible operation. + - Once transferred, the original owner cannot regain owner permissions unless the player with owner permissions transfers them again. + - This applies even to server administrators. +- The recipient of owner permissions must be a member of the channel. +- Owner permissions can use all moderation features and delete the channel, which is a powerful privilege. Choose carefully to whom you transfer permissions. + +::: diff --git a/docs/src/en/player-guide/channel-chat/private-channel.md b/docs/src/en/player-guide/channel-chat/private-channel.md new file mode 100644 index 0000000..414f783 --- /dev/null +++ b/docs/src/en/player-guide/channel-chat/private-channel.md @@ -0,0 +1,25 @@ +# Private Channels + +Private channels are chat channels that only specific users can join. + +## Creating a Private Channel + +To create a private channel, use the [`/lc channel create`](../commands/lc/channel.md) command and specify `true` for the private setting argument. + +``` +/lc channel create <channel ID> <channel name> [channel description] [private setting] +``` + +## Inviting to a Channel + +Private channels are not listed in the `/lc channel list` command and cannot be joined using the `/lc channel join` command. + +To join, you need to receive an invitation from the owner or moderator. + +To invite someone, use the [`/lc channel invite`](../commands/lc/channel.md#lc-channel-invite-player-id) command. + +``` +/lc channel invite <player ID> +``` + +The invited player automatically joins the channel. diff --git a/docs/src/en/player-guide/commands/jp.md b/docs/src/en/player-guide/commands/jp.md new file mode 100644 index 0000000..839e6e1 --- /dev/null +++ b/docs/src/en/player-guide/commands/jp.md @@ -0,0 +1,17 @@ +# /jp <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper" /> + +### `/jp [on | off]` <Badge type="danger" text="Deprecated: Will be removed in v1.0.0" /> + +::: danger Deprecated + +This command was deprecated in v0.5.0. Please use the [`/lc settings`](lc/settings.md) command instead. + +::: + +| Permission | +|--------------------------| +| `lunaticchat.command.jp` | + +Toggles the romanization conversion setting. + +This setting is saved by UUID, so the setting will not be lost even if you change your MCID. diff --git a/docs/src/en/player-guide/commands/lc/channel.md b/docs/src/en/player-guide/commands/lc/channel.md new file mode 100644 index 0000000..31941ca --- /dev/null +++ b/docs/src/en/player-guide/commands/lc/channel.md @@ -0,0 +1,77 @@ +# /lc channel <Badge type="tip" text="v0.6.0" /> <Badge type="tip" text="Paper" /> + +### `/lc channel create <channel-id> <channel-name> [channel-description] [private-setting]` + +| Permission | +|------------------------------| +| `lunaticchat.command.lc.channel.create` | + +Creates a channel. + +- `<channel-id>` specifies the channel ID. +- `<channel-name>` specifies the channel name. +- `[channel-description]` specifies the channel description (optional). + - The description will be displayed when viewing the channel list with the `/lc channel list` command. +- `[private-setting]` specifies the channel's privacy setting. + - If `true` is specified, it will be created as a private channel, and only invited players can join. + - If `false` is specified or omitted, it will be created as a public channel, and anyone can join. + +::: warning Notes on Entering Channel Names and Descriptions + +When entering channel names and descriptions, arguments must be enclosed in `"` (double quotes). + +Example: + +``` +/lc channel create pvp_channel "PvP Enthusiasts Club" "A gathering of people who love PvP" false +``` + +::: + +### `/lc channel list` + +| Permission | +|---------------------------------------| +| `lunaticchat.command.lc.channel.list` | + +Displays the list of channels. + +### `/lc channel join <channel-id>` + +| Permission | +|---------------------------------------| +| `lunaticchat.command.lc.channel.join` | + +Joins the specified channel. + +### `/lc channel leave` + +| Permission | +|----------------------------------------| +| `lunaticchat.command.lc.channel.leave` | + +Leaves the currently active channel. + +### `/lc channel switch <channel-id>` + +| Permission | +|-----------------------------------------| +| `lunaticchat.command.lc.channel.switch` | + +Switches to the specified channel. Use this when you want to switch to another channel while in channel chat mode. + +### `/lc channel status` + +| Permission | +|-----------------------------------------| +| `lunaticchat.command.lc.channel.status` | + +Displays information about the currently joined and active channels. + +### `/lc channel delete <channel-id>` + +| Permission | +|-----------------------------------------| +| `lunaticchat.command.lc.channel.delete` | + +Deletes the specified channel. You must be the channel creator (owner). diff --git a/docs/src/en/player-guide/commands/lc/chatmode.md b/docs/src/en/player-guide/commands/lc/chatmode.md new file mode 100644 index 0000000..e3f335f --- /dev/null +++ b/docs/src/en/player-guide/commands/lc/chatmode.md @@ -0,0 +1,17 @@ +# /lc chatmode <Badge type="tip" text="v0.6.0" /> <Badge type="tip" text="Paper" /> + +### `/lc chatmode` + +| Permission | +|-----------------------------------| +| `lunaticchat.command.lc.chatmode` | + +Displays the current chat mode. + +### `/lc chatmode toggle` + +| Permission | +|------------------------------------| +| `lunaticchat.command.lc.chatmode.toggle` | + +Toggles the chat mode. diff --git a/docs/src/en/player-guide/commands/lc/settings.md b/docs/src/en/player-guide/commands/lc/settings.md new file mode 100644 index 0000000..8b88066 --- /dev/null +++ b/docs/src/en/player-guide/commands/lc/settings.md @@ -0,0 +1,19 @@ +# /lc settings <Badge type="tip" text="v0.5.0" /> <Badge type="tip" text="Paper" /> + +### `/lc settings <key> [value]` + +| Permission | +|-----------------------------------| +| `lunaticchat.command.lc.settings` | + +Manages player settings for LunaticChat. If no value is specified, the current setting value will be displayed. + +This setting is saved by UUID, so the setting will not be lost even if you change your MCID. + +#### Available Keys + +| Key | Description | Default Value | +|----------|----------------------------------------------------------|--------| +| `japanese` | Toggles romanization conversion on or off. | `true` | +| `notice` | Toggles whether to receive notifications when receiving direct messages via `/tell` or `/reply`. | `true` | +| `chNotice` | Toggles whether to receive notifications when receiving channel chat messages. | `true` | diff --git a/docs/src/en/player-guide/commands/lc/status.md b/docs/src/en/player-guide/commands/lc/status.md new file mode 100644 index 0000000..1fa6a39 --- /dev/null +++ b/docs/src/en/player-guide/commands/lc/status.md @@ -0,0 +1,9 @@ +# /lc status <Badge type="tip" text="v0.5.0" /> <Badge type="tip" text="Paper" /> + +### `/lc status` + +| Permission | +|---------------------------------| +| `lunaticchat.command.lc.status` | + +Displays the status of LunaticChat. diff --git a/docs/src/en/player-guide/commands/lcv/status.md b/docs/src/en/player-guide/commands/lcv/status.md new file mode 100644 index 0000000..2b85283 --- /dev/null +++ b/docs/src/en/player-guide/commands/lcv/status.md @@ -0,0 +1,9 @@ +# /lcv status <Badge type="tip" text="v0.8.0" /> <Badge type="tip" text="Velocity" /> + +### `/lcv status` + +| Permission | +|------------------------------| +| `lunaticchat.command.lcv.status` | + +Displays the current LunaticChat Velocity integration status. diff --git a/docs/src/en/player-guide/commands/notice.md b/docs/src/en/player-guide/commands/notice.md new file mode 100644 index 0000000..4e7f41f --- /dev/null +++ b/docs/src/en/player-guide/commands/notice.md @@ -0,0 +1,17 @@ +# /notice <Badge type="tip" text="v0.4.0" /> <Badge type="tip" text="Paper" /> + +### `/notice [on | off]` <Badge type="danger" text="Deprecated: Will be removed in v1.0.0" /> + +::: danger Deprecated + +This command was deprecated in v0.5.0. Please use the [`/lc settings`](lc/settings.md) command instead. + +::: + +| Permission | Aliases | +|-----------------------------|-------------| +| `lunaticchat.command.notice` | `/dmnotice` | + +Toggles notifications for direct messages sent via [`/tell`](tell.md) or [`/reply`](reply.md) commands on or off. + +This setting is saved by UUID, so the setting will not be lost even if you change your MCID. diff --git a/docs/src/en/player-guide/commands/reply.md b/docs/src/en/player-guide/commands/reply.md new file mode 100644 index 0000000..1b26be2 --- /dev/null +++ b/docs/src/en/player-guide/commands/reply.md @@ -0,0 +1,17 @@ +# /reply <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper/Velocity" /> + +### `/reply <message>` + +| Permission | Aliases | +|-----------------------------|-------| +| `lunaticchat.command.reply` | `/r` | + +Replies to the player with whom you most recently communicated using [`/tell`](tell.md). + +::: info 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. + +::: diff --git a/docs/src/en/player-guide/commands/tell.md b/docs/src/en/player-guide/commands/tell.md new file mode 100644 index 0000000..fb2b8e1 --- /dev/null +++ b/docs/src/en/player-guide/commands/tell.md @@ -0,0 +1,11 @@ +# /tell <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper/Velocity" /> + +### `/tell <player ID> <message>` + +| Permission | Aliases | +| ---- | ---- | +| `lunaticchat.command.tell` | `/t`, `/msg`, `/m`, `/w`, `/whisper` | + +Sends a message to the specified player. + +Clicking on a sent message will automatically input this command into the chat bar. diff --git a/docs/src/en/player-guide/direct-message.md b/docs/src/en/player-guide/direct-message.md new file mode 100644 index 0000000..54f7404 --- /dev/null +++ b/docs/src/en/player-guide/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`](./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`](./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`](./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. + + + +::: diff --git a/docs/src/en/player-guide/getting-started.md b/docs/src/en/player-guide/getting-started.md new file mode 100644 index 0000000..19f7c83 --- /dev/null +++ b/docs/src/en/player-guide/getting-started.md @@ -0,0 +1,77 @@ +# Player Guide: Getting Started + +This guide is for players who have joined a server with LunaticChat installed. + +::: info For Server Administrators + +For plugin installation and configuration, refer to the [Admin Guide: Getting Started](../admin-guide/getting-started.md). + +::: + +## What You Can Do with LunaticChat + +LunaticChat is a plugin that extends the chat features of your Minecraft server. The following features are available: + +- **Direct Messages**: Send one-on-one messages to specific players +- **Quick Reply**: Quickly reply to the last player who messaged you with a single command +- **Channel Chat**: Create and join channels with other players to chat only among specific members +- **Romanization Conversion**: Automatically converts messages typed in romaji to hiragana + +::: tip + +Available features may vary depending on server configuration. Contact your server administrator for details. + +::: + +## Sending Direct Messages + +Use the [`/tell`](./commands/tell.md) command to send a message to a specific player. + +``` +/tell <player> <message> +``` + +After receiving a message, you can quickly reply using the [`/reply`](./commands/reply.md) command. + +``` +/reply <message> +``` + +For more details, see [Direct Messages](./direct-message.md). + +## Joining Channel Chat + +Channel chat lets you create and join channels where only specific members can converse. + +You can see available channels with [`/lc channel list`](./commands/lc/channel.md). + +``` +/lc channel list +``` + +To join a channel, use [`/lc channel join`](./commands/lc/channel.md). + +``` +/lc channel join <channel-id> +``` + +For more details, see [Channel Chat](./channel-chat/about.md). + +## Using Romanization Conversion + +LunaticChat can automatically convert messages typed in romaji to hiragana. + +You can toggle romanization conversion on or off with the [`/lc settings`](./commands/lc/settings.md) command. + +``` +/lc settings romanization <on|off> +``` + +For more details, see [Romanization Conversion](./japanese-romanization.md). + +## What's Next? + +- [Channel Chat](./channel-chat/about.md): Learn how to use channel chat +- [Direct Messages](./direct-message.md): Learn how to use direct messages +- [Romanization Conversion](./japanese-romanization.md): Details on the romanization conversion feature +- [Command List](./index.md): View all commands available in LunaticChat diff --git a/docs/src/en/player-guide/index.md b/docs/src/en/player-guide/index.md new file mode 100644 index 0000000..545d0f6 --- /dev/null +++ b/docs/src/en/player-guide/index.md @@ -0,0 +1,23 @@ +# Player Reference + +This page is a reference for players using LunaticChat. + +For plugin installation and configuration, refer to the [Guide](../admin-guide/getting-started.md). + +## Legend + +The legend used in the command reference is as follows: + +- `<argument>`: Indicates a required argument. Must be specified for execution. +- `[argument]`: Indicates an optional argument. Can be omitted during execution. +- `|`: Used when there are multiple choices. For example, `<yes|no>` means specifying either `yes` or `no`. +- `...`: Indicates that multiple arguments can be specified. For example, `<item>...` means multiple items can be specified. + +## Labels + +When the following labels are present, they have these meanings: + +- <Badge type="info" text="v0.1.0" />: Indicates this feature was introduced in LunaticChat version 0.1.0. +- <Badge type="tip" text="Paper" />: Indicates this feature is available in Paper environments. +- <Badge type="tip" text="Velocity" />: Indicates this feature is available in Velocity environments. +- <Badge type="tip" text="Paper / Velocity" />: Indicates this feature is available in both Paper and Velocity environments. diff --git a/docs/src/en/player-guide/japanese-romanization.md b/docs/src/en/player-guide/japanese-romanization.md new file mode 100644 index 0000000..104d6d0 --- /dev/null +++ b/docs/src/en/player-guide/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`](./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-guide/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) +``` |