docs: Add LunaticChat docs

8 files changed, 302 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) コマンドの使用を切り替えます．
diff --git a/docs/src/index.md b/docs/src/index.md
new file mode 100644
index 0000000..af03977
--- /dev/null
+++ b/docs/src/index.md
@@ -0,0 +1,27 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: "LunaticChat Docs"
+  tagline: Next-generation channel chat plugin
+  actions:
+    - theme: brand
+      text: はじめる
+      link: /guide/getting-started
+    - theme: brand
+      text: リファレンス
+      link: /reference
+    - theme: alt
+      text: GitHub
+      link: https://github.com/m1sk9/LunaticChat
+
+features:
+  - title: キャッシュによる高速動作
+    details: ローマ字から日本語の変換はキャッシュを使用し，従来の LunaChat よりも高速に動作します
+  - title: マルチプラットフォーム対応 (予定)
+    details: Paper と Velocity のマルチプラットフォームに対応し，サーバ間チャットを実現します
+  - title: 最新版の対応
+    details: 他プラグインとの依存を減らし，常に最新の Minecraft バージョンに対応します
+---
+
diff --git a/docs/src/reference/commands/jp.md b/docs/src/reference/commands/jp.md
new file mode 100644
index 0000000..04fed27
--- /dev/null
+++ b/docs/src/reference/commands/jp.md
@@ -0,0 +1,13 @@
+# /jp <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper / Velocity" />
+
+### /jp [on | off]
+
+| パーミッション                  |
+|--------------------------|
+| `lunaticchat.command.jp` |
+
+ローマ字変換の設定を切り替えます．
+
+この設定は UUID で保存されるため， MCID を切り替えても設定が消えることはありません．
+
+
diff --git a/docs/src/reference/commands/reply.md b/docs/src/reference/commands/reply.md
new file mode 100644
index 0000000..27e0660
--- /dev/null
+++ b/docs/src/reference/commands/reply.md
@@ -0,0 +1,17 @@
+# /reply　<Badge type="tip" text="v0.1.0" />　<Badge type="tip" text="Paper / Velocity" />
+
+### `/reply <メッセージ>`
+
+| パーミッション                     | エイリアス |
+|-----------------------------|-------|
+| `lunaticchat.command.reply` | `/r` |
+
+直近で [`/tell`](./tell.md) を使用し，やりとりをしたプレイヤーに対して返信します．
+
+::: info このコマンドが使用できない場合 
+
+このコマンドが無効化されている可能性があります (この機能は設定で ON/OFF できるため)
+
+サーバーの管理者に連絡してください．
+
+:::
diff --git a/docs/src/reference/commands/tell.md b/docs/src/reference/commands/tell.md
new file mode 100644
index 0000000..cf38815
--- /dev/null
+++ b/docs/src/reference/commands/tell.md
@@ -0,0 +1,11 @@
+# /tell <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper / Velocity" />
+
+### `/tell <プレイヤーID> <メッセージ>`
+
+| パーミッション | エイリアス |
+| ---- | ---- |
+| `lunaticchat.command.tell` | `/t`, `/msg`, `/m`, `/w`, `/whisper` |
+
+指定したプレイヤーに対してメッセージを送信します．
+
+送信されたメッセージをクリックするとこのコマンドがチャット欄に自動入力されます．
diff --git a/docs/src/reference/index.md b/docs/src/reference/index.md
new file mode 100644
index 0000000..0563bca
--- /dev/null
+++ b/docs/src/reference/index.md
@@ -0,0 +1,24 @@
+# プレイヤー向けリファレンス
+
+このページは LunaticChat を使用するプレイヤー向けのリファレンスです。
+
+プラグインの導入方法や設定方法については [ガイド](../guide/getting-started.md) を参照してください。
+
+## 凡例
+
+コマンドリファレンスで使用される凡例は以下の通りです。
+
+- `<引数>`: 必須の引数を示します．実行には必ず指定する必要があります．
+- `[引数]`: 任意の引数を示します．実行時に省略可能です．
+- `|`: 複数の選択肢がある場合に使用します．例えば，`<yes|no>` は `yes` または `no` のいずれかを指定することを意味します．
+- `...` : 複数の引数を指定できることを示します．例えば，`<item>...` は複数のアイテムを指定できることを意味します．
+
+## ラベル
+
+以下のようなラベルが記載されている場合は，次のような意味を持ちます．
+
+- <Badge type="info" text="v0.1.0" /> : この機能が LunaticChat バージョン 0.1.0 で導入されたことを示します．
+- <Badge type="tip" text="Paper" /> : この機能が Paper 環境で利用可能であることを示します．
+- <Badge type="tip" text="Velocity" /> : この機能が Velocity 環境で利用可能であることを示します．
+- <Badge type="tip" text="Paper / Velocity" /> : この機能が Paper / Velocity 環境で利用可能であることを示します．
+