Merge pull request #65 from m1sk9/chore/release-beta-stagev0.5.0

chore: Release to beta stage

3 files changed, 234 insertions, 0 deletions

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).
+
+:::