docs: Add LunaticChat docs

3 files changed, 210 insertions, 0 deletions

diff --git a/docs/src/guide/configuration.md b/docs/src/guide/configuration.md
new file mode 100644
index 0000000..b1d606a
--- /dev/null
+++ b/docs/src/guide/configuration.md
@@ -0,0 +1,148 @@
+# 設定
+
+```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
+
+# ----------------------------------------------
+# -----------   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:
+      maxEntries: 500
+      saveIntervalSeconds: 300
+      filePath: "conversion_cache.json"
+    api:
+      timeout: 3000
+      retryAttempts: 2
+    settings:
+      directory: "settings"
+
+# ----------------------------------------------
+# ---------   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
+# {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`
+
+LunaticChat をデバッグモードで起動します．
+
+## Features Settings
+
+### `features.quickReplies.enabled`
+
+- Type: `boolean`
+- Default: `true`
+
+LunaticChat の [`/reply`](../reference/commands/reply.md) コマンドによるクイックリプライ機能を有効にします．
+
+無効にすると [`/reply`](../reference/commands/reply.md) コマンドは Paper に登録されず，使用できなくなります．
+
+### `features.japaneseConversion.enabled`
+
+- Type: `boolean`
+- Default: `false`
+
+ローマ字からひらがなへの変換機能を有効にします．
+
+### `features.japaneseConversion`
+
+#### `cache.maxEntries`
+
+- Type: `integer`
+- Default: `500`
+
+ローマ字変換のキャッシュに保存する最大エントリ数を指定します．
+
+この値を超えると，最も古いエントリから順に削除されます．
+
+値を高く設定すれば，変換のパフォーマンスが向上しますが，メモリ使用量・キャッシュファイルサイズも増加します．
+
+#### `cache.saveIntervalSeconds`
+
+- Type: `integer`
+- Default: `300`
+
+ローマ字変換のキャッシュをディスクに保存する間隔（秒）を指定します．
+
+#### `cache.filePath`
+
+- Type: `string`
+- Default: `conversion_cache.json`
+
+ローマ字変換のキャッシュを保存するファイルパスを指定します．
+
+ここで設定したパスは `plugins/LunaticChat/` ディレクトリを基準とした相対パスとして解釈されます．
+
+#### `api.timeout`
+
+- Type: `integer`
+- Default: `3000`
+
+ローマ字変換 API へのリクエストのタイムアウト時間（ミリ秒）を指定します．
+
+#### `api.retryAttempts`
+
+- Type: `integer`
+- Default: `2`
+
+ローマ字変換 API へのリクエストが失敗した場合の再試行回数を指定します．
+
+#### `settings.directory`
+
+- Type: `string`
+- Default: `settings`
+
+ローマ字変換のユーザーごとの設定ファイルを保存するディレクトリを指定します．
+
+## Message Format Settings
+
+使用できるプレースホルダー:
+
+- `{sender}`: メッセージ送信者の名前
+- `{recipient}`: メッセージ受信者の名前
+- `{message}`: メッセージの内容
+
+### `messageFormat.directMessageFormat`
+
+- Type: `string`
+- Default: `§7[§e{sender} §7>> §e{recipient}§7] §f{message}`
+
+ダイレクトメッセージ（ [`/tell`](../reference/commands/tell.md) や [`/reply`](../reference/commands/reply.md) コマンド）で送信されるメッセージのフォーマットを指定します．
diff --git a/docs/src/guide/getting-started.md b/docs/src/guide/getting-started.md
new file mode 100644
index 0000000..db922f6
--- /dev/null
+++ b/docs/src/guide/getting-started.md
@@ -0,0 +1,29 @@
+# はじめる
+
+## インストール
+
+プラグインをインストールします．プラグインは以下から入手できます：
+
+- [GitHub](https://github.com/m1sk9/LunaticChat/releases)
+- [Modrinth](https://modrinth.com/project/lunaticchat)
+
+ダウンロードしたプラグインファイルをサーバーの `plugins` フォルダに配置し，サーバーを再起動します．
+
+## 設定
+
+LunaticChat を起動すると以下のファイルが作成されます．
+
+- `plugins/LunaticChat/config.yml`：プラグインの設定ファイル
+- `plugins/LunaticChat/settings/`：ユーザーごとの設定ファイルが保存されるフォルダ
+- `plugins/LunaticChat/conversion_cache.json`: ローマ字変換のキャッシュファイル
+
+設定ファイル `config.yml` を開き，必要に応じて設定を変更します．設定項目の詳細については，[設定ガイド](./configuration.md)を参照してください．
+
+## パーミッション
+
+LunaticChat のパーミッションを LuckPerms などのパーミッション管理プラグインで設定します．
+
+基本的なパーミッションは Paper や Velocity のデフォルトパーミッションシステム ( `OP` / `non OP` ) でも設定できますが，より詳細な制御を行う場合は LuckPerms の使用を推奨します．
+
+- パーミッションノードの詳細については [パーミッションガイド](./permissions.md)を参照してください．
+- コマンドの各機能に対応するパーミッションノードは，[コマンドリファレンス](../reference/index.md)を参照してください．
diff --git a/docs/src/guide/permissions.md b/docs/src/guide/permissions.md
new file mode 100644
index 0000000..eb37344
--- /dev/null
+++ b/docs/src/guide/permissions.md
@@ -0,0 +1,33 @@
+# パーミッション
+
+LuckPerms を使用した設定方法に関する詳細は [LuckPerms Wiki](https://luckperms.net/wiki/Home) を参照してください．
+
+## `lunaticchat.*`
+
+### `lunaticchat.spy`
+
+- Default: `OP`
+
+[`/tell`](../reference/commands/tell.md) / [`/reply`](../reference/commands/reply.md) コマンドでのやり取りを可視化します．
+
+この権限を持つプレイヤーは他プレイヤーの [`/tell`](../reference/commands/tell.md) / [`/reply`](../reference/commands/reply.md) でのメッセージがブロードキャストされます．
+
+## `lunaticchat.command.*`
+
+### `lunaticchat.command.tell`
+
+- Default: `non OP`
+
+[`/tell`](../reference/commands/tell.md) コマンドの使用を切り替えます．
+
+### `lunaticchat.command.reply`
+
+- Default: `non OP`
+
+[`/reply`](../reference/commands/reply.md) コマンドの使用を切り替えます．
+
+### `lunaticchat.command.jp`
+
+- Default: `non OP`
+
+[`/jp`](../reference/commands/jp.md) コマンドの使用を切り替えます．