diff options
Diffstat (limited to 'docs/src/en')
| -rw-r--r-- | docs/src/en/guide/about.md | 60 | ||||
| -rw-r--r-- | docs/src/en/guide/admin/cache.md | 41 | ||||
| -rw-r--r-- | docs/src/en/guide/admin/configuration.md | 180 | ||||
| -rw-r--r-- | docs/src/en/guide/admin/velocity.md | 13 | ||||
| -rw-r--r-- | docs/src/en/guide/getting-started.md | 29 | ||||
| -rw-r--r-- | docs/src/en/guide/patch-notes/cache-file.md | 5 | ||||
| -rw-r--r-- | docs/src/en/guide/patch-notes/plugin.md | 9 | ||||
| -rw-r--r-- | docs/src/en/guide/player/channel-chat.md | 13 | ||||
| -rw-r--r-- | docs/src/en/guide/player/direct-message.md | 65 | ||||
| -rw-r--r-- | docs/src/en/guide/player/japanese-romanization.md | 101 | ||||
| -rw-r--r-- | docs/src/en/index.md | 51 | ||||
| -rw-r--r-- | docs/src/en/reference/commands/jp.md | 17 | ||||
| -rw-r--r-- | docs/src/en/reference/commands/lc/settings.md | 18 | ||||
| -rw-r--r-- | docs/src/en/reference/commands/lc/status.md | 9 | ||||
| -rw-r--r-- | docs/src/en/reference/commands/notice.md | 17 | ||||
| -rw-r--r-- | docs/src/en/reference/commands/reply.md | 17 | ||||
| -rw-r--r-- | docs/src/en/reference/commands/tell.md | 11 | ||||
| -rw-r--r-- | docs/src/en/reference/index.md | 23 | ||||
| -rw-r--r-- | docs/src/en/reference/permissions.md | 59 |
19 files changed, 738 insertions, 0 deletions
diff --git a/docs/src/en/guide/about.md b/docs/src/en/guide/about.md new file mode 100644 index 0000000..388df7b --- /dev/null +++ b/docs/src/en/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/guide/admin/cache.md b/docs/src/en/guide/admin/cache.md new file mode 100644 index 0000000..2fa2802 --- /dev/null +++ b/docs/src/en/guide/admin/cache.md @@ -0,0 +1,41 @@ +# Cache System + +LunaticChat includes a system that automatically caches phrases from Japanese romanization conversion to both memory and disk. + +For information on Japanese romanization conversion, see [here](../player/japanese-romanization.md). + +## Memory Cache + +LunaticChat caches converted phrases in memory, allowing for fast responses when the same phrase is requested again. + +This cache is temporary and is saved to disk cache at server restart or at configured intervals. + +## Disk Cache + +LunaticChat periodically saves the contents of the memory cache to disk. This allows the cache contents to be retained even after server restarts. + +The file used for disk cache can be [changed in the configuration](configuration.md#cachefilepath). + +## Cache Release + +Memory cache is automatically released by the JVM's garbage collection after being cached to disk. + +Disk cache can be released by manually deleting the file. LunaticChat will recreate the cache file on restart. + +::: warning About Purge Functionality + +LunaticChat does not implement a cache purge feature. + +This is because allowing players to manipulate the host's file system is not desirable from a security perspective. + +::: + +## Cache Version + +The file used for disk cache includes a `version` field, which handles changes to the cache format due to LunaticChat version updates. + +If the version does not match, LunaticChat recognizes the cache file as **an old format cache**, ignores its contents, and recreates it in the new format. + +```json +{"version":"1","entries":{}} +``` diff --git a/docs/src/en/guide/admin/configuration.md b/docs/src/en/guide/admin/configuration.md new file mode 100644 index 0000000..1fdf5b5 --- /dev/null +++ b/docs/src/en/guide/admin/configuration.md @@ -0,0 +1,180 @@ +# Configuration + +```yaml +# ---------------------------------------------- +# -------------- LunaticChat --------------- +# ---------------------------------------------- +# +# Docs: https://lc.m1sk9.dev +# GitHub: https://github.com/m1sk9/LunaticChat +# +# This configuration file is for customizing LunaticChat's behavior. +# Please specify appropriate values to ensure LunaticChat functions correctly. +# +# For detailed configuration options, please refer to the documentation: +# https://lc.m1sk9.dev/guide/configuration +# ---------------------------------------------- + +# If enabled, Activate LunaticChat's debug mode, which provides detailed logging for troubleshooting. +debug: false + +# Path to the YAML file storing player settings +userSettingsFilePath: "player-settings.yaml" + +# If enabled, LunaticChat will check for updates on startup. +checkForUpdates: true + +# Plugin Configuration Language. This setting applies only to player feedback and does not affect plugin logs or similar outputs. +language: "en" + +# ---------------------------------------------- +# ----------- Features Settings ------------ +# ---------------------------------------------- + +features: + quickReplies: + # If enabled, the quick reply feature via the /reply command will be activated. + enabled: true + japaneseConversion: + # If enabled, enables the conversion function from Roman letters to hiragana. + enabled: false + cache: + # Specifies the maximum number of entries to store in the Romanization conversion cache. + maxEntries: 500 + # Specify the interval (in seconds) for saving the Romanization conversion cache to disk. + saveIntervalSeconds: 300 + # Specify the file path where the cache for Romanization conversion is saved. + filePath: "conversion_cache.json" + api: + # Specify the timeout duration (in milliseconds) for API requests to the Romanization conversion service. + timeout: 3000 + # Specify the number of retry attempts for failed API requests to the Romanization conversion service. + retryAttempts: 2 + +# ---------------------------------------------- +# --------- Message Format Settings -------- +# ---------------------------------------------- +# +# Customize the format of various chat messages here. +# You can use placeholders such as {sender}, {message}, etc. +# +# {sender} - The name of the message sender +# {recipient} - The name of the message recipient +# {message} - The content of the message +# ---------------------------------------------- + +messageFormat: + # Configure the format for direct messages sent via /tell or /msg + directMessageFormat: "§7[§e{sender} §7>> §e{recipient}§7] §f{message}" +``` + +## General Settings + +### `debug` + +- Type: `boolean` +- Default: `false` + +Starts LunaticChat in debug mode. + +### `userSettingsFilePath` + +- Type: `string` +- Default: `player-settings.yaml` + +Specifies the path to the YAML file where LunaticChat saves player settings. + +### `checkForUpdates` + +- Type: `boolean` +- Default: `true` + +Configures whether to prompt for LunaticChat updates at startup and when players with the required permissions join the server. + +### `language` + +- Type: `string` +- Default: `en` + +Specifies the language for LunaticChat's player-facing messages. + +### Supported languages: + +- `en`: English +- `ja`: Japanese (日本語) + +## Features Settings + +### `features.quickReplies.enabled` + +- Type: `boolean` +- Default: `true` + +Enables the quick reply feature via the [`/reply`](../../reference/commands/reply.md) command in LunaticChat. + +When disabled, the [`/reply`](../../reference/commands/reply.md) command will not be registered with Paper and cannot be used. + +### `features.japaneseConversion.enabled` + +- Type: `boolean` +- Default: `false` + +Enables the conversion feature from romaji to hiragana. + +### `features.japaneseConversion` + +#### `cache.maxEntries` + +- Type: `integer` +- Default: `500` + +Specifies the maximum number of entries to store in the romanization conversion cache. + +When this value is exceeded, the oldest entries are deleted first. + +Setting a higher value improves conversion performance, but also increases memory usage and cache file size. + +#### `cache.saveIntervalSeconds` + +- Type: `integer` +- Default: `300` + +Specifies the interval (in seconds) for saving the romanization conversion cache to disk. + +#### `cache.filePath` + +- Type: `string` +- Default: `conversion_cache.json` + +Specifies the file path where the romanization conversion cache is saved. + +The path set here is interpreted as a relative path from the `plugins/LunaticChat/` directory. + +#### `api.timeout` + +- Type: `integer` +- Default: `3000` + +Specifies the timeout duration (in milliseconds) for API requests to the romanization conversion service. + +#### `api.retryAttempts` + +- Type: `integer` +- Default: `2` + +Specifies the number of retry attempts for failed API requests to the romanization conversion service. + +## Message Format Settings + +Available placeholders: + +- `{sender}`: Name of the message sender +- `{recipient}`: Name of the message recipient +- `{message}`: Content of the message + +### `messageFormat.directMessageFormat` + +- Type: `string` +- Default: `§7[§e{sender} §7>> §e{recipient}§7] §f{message}` + +Specifies the format for messages sent via direct message ([`/tell`](../../reference/commands/tell.md) or [`/reply`](../../reference/commands/reply.md) commands). diff --git a/docs/src/en/guide/admin/velocity.md b/docs/src/en/guide/admin/velocity.md new file mode 100644 index 0000000..b9ec3b5 --- /dev/null +++ b/docs/src/en/guide/admin/velocity.md @@ -0,0 +1,13 @@ +# Velocity Integration (Cross-Server Chat) <Badge type="tip" text="v1.0.0" /> <Badge type="warning" text="Experimental" /> + +This feature enables cross-server chat between Paper servers connected through a Velocity proxy server. + +::: 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/getting-started.md b/docs/src/en/guide/getting-started.md new file mode 100644 index 0000000..1fd9f0d --- /dev/null +++ b/docs/src/en/guide/getting-started.md @@ -0,0 +1,29 @@ +# Getting Started + +## Installation + +Install LunaticChat. LunaticChat can be obtained from: + +- [GitHub](https://github.com/m1sk9/LunaticChat/releases) +- [Modrinth](https://modrinth.com/project/lunaticchat) + +Place the downloaded plugin file in your server's `plugins` folder and restart the server. + +## Configuration + +When LunaticChat starts, the following files will be created: + +- `plugins/LunaticChat/config.yml`: Plugin configuration file +- `plugins/LunaticChat/player-settings.yaml`: User-specific settings file +- `plugins/LunaticChat/conversion_cache.json`: Romanization conversion cache file + +Open the configuration file `config.yml` and modify the settings as needed. For details on configuration options, refer to the [Configuration Guide](admin/configuration.md). + +## Permissions + +Set LunaticChat's permissions using a permission management plugin like LuckPerms. + +Basic permissions can be configured using Paper or Velocity's default permission system (`OP` / `non OP`), but LuckPerms is recommended for more detailed control. + +- For details on permission nodes, refer to the [Permissions Guide](../reference/permissions.md). +- For permission nodes corresponding to each command feature, refer to the [Command Reference](../reference/index.md). diff --git a/docs/src/en/guide/patch-notes/cache-file.md b/docs/src/en/guide/patch-notes/cache-file.md new file mode 100644 index 0000000..1f5fe05 --- /dev/null +++ b/docs/src/en/guide/patch-notes/cache-file.md @@ -0,0 +1,5 @@ +# Patch Notes: Cache File + +| Cache Version | Supported Versions | +|------------|-----------| +| v1 | v0.1.0 ~ | diff --git a/docs/src/en/guide/patch-notes/plugin.md b/docs/src/en/guide/patch-notes/plugin.md new file mode 100644 index 0000000..0559417 --- /dev/null +++ b/docs/src/en/guide/patch-notes/plugin.md @@ -0,0 +1,9 @@ +# Patch Notes: Plugin + +Plugin patch notes are not listed here. Please refer to the [GitHub releases page](https://github.com/m1sk9/LunaticChat/releases) or the [release notes category on the discussions page](https://github.com/m1sk9/LunaticChat/discussions/categories/announcements). + +---- + +| Major Version | Codename | Development Period | Supported Versions | +|-----------|---------|-----------|-----------| +| v0 | lunatic | 2026/01 ~ | 1.21.x | 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. + + + +::: 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) +``` diff --git a/docs/src/en/index.md b/docs/src/en/index.md new file mode 100644 index 0000000..ce77a87 --- /dev/null +++ b/docs/src/en/index.md @@ -0,0 +1,51 @@ +--- +# https://vitepress.dev/reference/default-theme-home-page +layout: home + +hero: + name: "LunaticChat" + tagline: Next-generation chat plugin for Paper/Velocity. + actions: + - theme: brand + text: Getting Started + link: /en/guide/getting-started + - theme: brand + text: About LunaticChat + link: /en/guide/about + - theme: brand + text: Reference + link: /en/reference + - theme: alt + text: GitHub + link: https://github.com/m1sk9/LunaticChat + image: + src: /static/icon.png + alt: LunaticChat Logo + +features: + - title: 1-on-1 Direct Messaging + details: Chat one-on-one using /tell or /msg commands + icon: ✉️ + - title: Quick Reply + details: Quickly reply to the most recent message sender with /reply + icon: 💌 + - title: Japanese Romanization Conversion + details: Automatically converts messages input in romaji to Japanese + icon: 🌍 + - title: CoreProtect Support + details: LunaticChat's chat logs are compatible with CoreProtect + icon: 🗒️ + - title: Channel Chat Feature (Planned) + details: Create and manage chat channels, send private messages between specific players + icon: ☎️ + - title: Multi-Platform Support (Planned) + details: Support for multi-platform Paper and Velocity, enabling cross-server chat + icon: 🚀 + - title: High-Speed Performance with Caching + details: Uses caching for romaji-to-Japanese conversion, operating faster than traditional LunaChat + icon: 🎈 + - title: Latest Version Support + details: Reduces dependencies on other plugins, always supporting the latest Minecraft versions + icon: ⛏️️ +--- + diff --git a/docs/src/en/reference/commands/jp.md b/docs/src/en/reference/commands/jp.md new file mode 100644 index 0000000..839e6e1 --- /dev/null +++ b/docs/src/en/reference/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/reference/commands/lc/settings.md b/docs/src/en/reference/commands/lc/settings.md new file mode 100644 index 0000000..742e85c --- /dev/null +++ b/docs/src/en/reference/commands/lc/settings.md @@ -0,0 +1,18 @@ +# /lc settings <Badge type="tip" text="v0.5.0" /> <Badge type="tip" text="Paper" /> + +### `/lc settings <key> [value]` + +| Permission | +|--------------------------------| +| `lunaticchat.command.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 | +|----------|----------------------------------------------------------|--------| +| `jp` | Toggles romanization conversion on or off. | `true` | +| `notice` | Toggles whether to receive notifications when receiving direct messages via `/tell` or `/reply`. | `true` | diff --git a/docs/src/en/reference/commands/lc/status.md b/docs/src/en/reference/commands/lc/status.md new file mode 100644 index 0000000..365519a --- /dev/null +++ b/docs/src/en/reference/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.status` | + +Displays the status of LunaticChat. diff --git a/docs/src/en/reference/commands/notice.md b/docs/src/en/reference/commands/notice.md new file mode 100644 index 0000000..4e7f41f --- /dev/null +++ b/docs/src/en/reference/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/reference/commands/reply.md b/docs/src/en/reference/commands/reply.md new file mode 100644 index 0000000..0884eb8 --- /dev/null +++ b/docs/src/en/reference/commands/reply.md @@ -0,0 +1,17 @@ +# /reply <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper" /> + +### `/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/reference/commands/tell.md b/docs/src/en/reference/commands/tell.md new file mode 100644 index 0000000..6687e94 --- /dev/null +++ b/docs/src/en/reference/commands/tell.md @@ -0,0 +1,11 @@ +# /tell <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper" /> + +### `/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/reference/index.md b/docs/src/en/reference/index.md new file mode 100644 index 0000000..338694e --- /dev/null +++ b/docs/src/en/reference/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](../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/reference/permissions.md b/docs/src/en/reference/permissions.md new file mode 100644 index 0000000..ed30a77 --- /dev/null +++ b/docs/src/en/reference/permissions.md @@ -0,0 +1,59 @@ +# Permissions + +For details on configuration using LuckPerms, refer to the [LuckPerms Wiki](https://luckperms.net/wiki/Home). + +## `lunaticchat.*` + +### `lunaticchat.spy` + +- Default: `OP` + +Visualizes communication via [`/tell`](commands/tell.md) / [`/reply`](commands/reply.md) commands. + +Players with this permission will have messages from other players' [`/tell`](commands/tell.md) / [`/reply`](commands/reply.md) commands broadcast to them. + +### `lunaticchat.noticeUpdate` + +- Default: `OP` + +Receives LunaticChat update notifications. + +[You must have `checkForUpdates` enabled](../guide/admin/configuration.md#checkforupdates) to receive notifications. + +## `lunaticchat.command.*` + +### `lunaticchat.command.tell` + +- Default: `non OP` + +Toggles the use of the [`/tell`](commands/tell.md) command. + +### `lunaticchat.command.reply` + +- Default: `non OP` + +Toggles the use of the [`/reply`](commands/reply.md) command. + +### `lunaticchat.command.lc.settings` + +- Default: `non OP` + +Toggles the use of the [`/lc settings`](commands/lc/settings.md) command. + +### `lunaticchat.command.lc.status` + +- Default: `non OP` + +Toggles the use of the [`/lc status`](commands/lc/status.md) command. + +### `lunaticchat.command.jp` <Badge type="danger" text="Deprecated: Will be removed in v1.0.0" /> + +- Default: `non OP` + +Toggles the use of the [`/jp`](commands/jp.md) command. + +### `lunaticchat.command.notice` <Badge type="danger" text="Deprecated: Will be removed in v1.0.0" /> + +- Default: `non OP` + +Toggles the use of the [`/notice`](commands/notice.md) command. |
