Merge pull request #167 from m1sk9/docs/Update-v1-docsv1.0.0

docs: Update v1 Document

3 files changed, 293 insertions, 0 deletions

diff --git a/website/src/en/docs/reference/commands.md b/website/src/en/docs/reference/commands.md
new file mode 100644
index 0000000..3ed72df
--- /dev/null
+++ b/website/src/en/docs/reference/commands.md
@@ -0,0 +1,157 @@
+---
+layout: doc
+---
+
+# Command Reference
+
+A reference for all commands available in LunaticChat.
+
+## Direct Messages
+
+### `/tell <player> <message>`
+
+Sends a direct message to a player.
+
+- **Aliases**: `t`, `msg`, `m`, `w`, `whisper`
+- **Permission**: `lunaticchat.command.tell`
+
+### `/reply <message>`
+
+Replies to the last player who sent you a message.
+
+- **Aliases**: `r`
+- **Permission**: `lunaticchat.command.reply`
+- **Prerequisite**: Quick reply feature must be enabled
+
+## Main Command (`/lc`)
+
+**Aliases**: `lunaticchat`
+
+### `/lc status`
+
+Displays the plugin version, health, enabled features, and configuration values.
+
+- **Permission**: `lunaticchat.command.lc.status`
+
+### `/lc settings [key] [on|off]`
+
+Views or changes your personal settings. Without arguments, displays the settings list.
+
+- **Permission**: `lunaticchat.command.lc.settings`
+- **Setting keys**: `japanese`, `notice`, `chNotice` (see [Player Settings](/en/docs/reference/player-settings) for details)
+
+## Channel Commands (`/lc channel`)
+
+Only available when the channel chat feature is enabled.
+
+### Create & Browse
+
+#### `/lc channel create <channelId> <name> [description] [isPrivate]`
+
+Creates a new channel. The creator becomes the owner.
+
+- **Permission**: `lunaticchat.command.lc.channel.create`
+- `channelId`: Only alphanumeric characters, underscores, and hyphens are allowed
+- `isPrivate`: `true` / `false` (default: `false`)
+
+#### `/lc channel list [page]`
+
+Displays a list of public channels (10 per page).
+
+- **Permission**: `lunaticchat.command.lc.channel.list`
+
+#### `/lc channel info [channelId]`
+
+Displays detailed information about a channel. Without arguments, shows information about the active channel.
+
+- **Permission**: `lunaticchat.command.lc.channel.info`
+
+### Join & Leave
+
+#### `/lc channel join <channelId>`
+
+Joins a channel. An invitation is required for private channels.
+
+- **Permission**: `lunaticchat.command.lc.channel.join`
+
+#### `/lc channel leave`
+
+Leaves the active channel.
+
+- **Permission**: `lunaticchat.command.lc.channel.leave`
+
+#### `/lc channel switch <channelId>`
+
+Switches the active channel to another channel you have already joined.
+
+- **Permission**: `lunaticchat.command.lc.channel.switch`
+
+#### `/lc channel status`
+
+Displays your channel membership status (active channel and list of joined channels).
+
+- **Permission**: `lunaticchat.command.lc.channel.status`
+
+### Moderation (Owner / Moderator)
+
+#### `/lc channel invite <playerName>`
+
+Invites a player to the active channel. Bypasses private channel restrictions.
+
+- **Permission**: `lunaticchat.command.lc.channel.invite`
+- **Required role**: OWNER or MODERATOR
+
+#### `/lc channel kick <playerName>`
+
+Kicks a player from the active channel.
+
+- **Permission**: `lunaticchat.command.lc.channel.kick`
+- **Required role**: OWNER or MODERATOR
+
+#### `/lc channel ban <playerName>`
+
+Bans a player from the active channel. Banned players cannot rejoin.
+
+- **Permission**: `lunaticchat.command.lc.channel.ban`
+- **Required role**: OWNER or MODERATOR
+
+#### `/lc channel unban <playerName>`
+
+Unbans a player from the channel.
+
+- **Permission**: `lunaticchat.command.lc.channel.unban`
+- **Required role**: OWNER or MODERATOR
+
+### Administration (Owner Only)
+
+#### `/lc channel delete <channelId>`
+
+Deletes a channel.
+
+- **Permission**: `lunaticchat.command.lc.channel.delete`
+- **Required role**: OWNER (can be bypassed with `lunaticchat.channelbypass` permission)
+
+#### `/lc channel mod <playerName>`
+
+Grants or revokes moderator privileges for a channel member.
+
+- **Permission**: `lunaticchat.command.lc.channel.mod`
+- **Required role**: OWNER
+
+#### `/lc channel ownership <playerName>`
+
+Transfers channel ownership to another member.
+
+- **Permission**: `lunaticchat.command.lc.channel.ownership`
+- **Required role**: OWNER
+
+## Velocity Commands (`/lcv`)
+
+**Aliases**: `lunaticvelocity`
+
+### `/lcv status`
+
+Displays the connection status with the Velocity proxy, protocol version, and online player count.
+
+- **Permission**: `lunaticchat.command.lcv.status`
+- **Default**: op only
diff --git a/website/src/en/docs/reference/message-format.md b/website/src/en/docs/reference/message-format.md
new file mode 100644
index 0000000..2669adb
--- /dev/null
+++ b/website/src/en/docs/reference/message-format.md
@@ -0,0 +1,86 @@
+---
+layout: doc
+---
+
+# Message Format
+
+You can customize the display format of chat messages in the `messageFormat` section of `config.yml`.
+
+## Placeholders
+
+| Placeholder | Description | Available formats |
+|-------------|-------------|-------------------|
+| `{sender}` | Name of the message sender | All |
+| `{recipient}` | Name of the message recipient | `directMessageFormat` |
+| `{message}` | Message content | All |
+| `{channel}` | Channel name | `channelMessageFormat` |
+| `{server}` | Server name | `crossServerGlobalChatFormat` |
+
+## Format List
+
+### `directMessageFormat`
+
+The display format for direct messages sent via `/tell` or `/reply`.
+
+**Default:**
+```
+§7[§e{sender} §7>> §e{recipient}§7] §f{message}
+```
+
+**Example:** <span style="color: gray">[</span><span style="color: gold">Steve</span> <span style="color: gray">>></span> <span style="color: gold">Alex</span><span style="color: gray">]</span> <span style="color: white">Hello!</span>
+
+### `channelMessageFormat`
+
+The display format for messages sent in channel chat.
+
+**Default:**
+```
+§7[§b#{channel}§7] §e{sender}: §f{message}
+```
+
+**Example:** <span style="color: gray">[</span><span style="color: aqua">#general</span><span style="color: gray">]</span> <span style="color: gold">Steve:</span> <span style="color: white">Hello!</span>
+
+### `crossServerGlobalChatFormat`
+
+The display format for cross-server global chat when using Velocity integration.
+
+**Default:**
+```
+§7[§6{server}§7] §e{sender}: §f{message}
+```
+
+**Example:** <span style="color: gray">[</span><span style="color: gold">survival</span><span style="color: gray">]</span> <span style="color: gold">Steve:</span> <span style="color: white">Hello!</span>
+
+## Color Codes
+
+You can use color codes with the Minecraft section sign (`§`).
+
+| Code | Color |
+|------|-------|
+| `§0` | Black |
+| `§1` | Dark blue |
+| `§2` | Dark green |
+| `§3` | Dark aqua |
+| `§4` | Dark red |
+| `§5` | Dark purple |
+| `§6` | Gold |
+| `§7` | Gray |
+| `§8` | Dark gray |
+| `§9` | Blue |
+| `§a` | Green |
+| `§b` | Aqua |
+| `§c` | Red |
+| `§d` | Pink |
+| `§e` | Yellow |
+| `§f` | White |
+
+### Formatting Codes
+
+| Code | Effect |
+|------|--------|
+| `§l` | **Bold** |
+| `§o` | *Italic* |
+| `§n` | <u>Underline</u> |
+| `§m` | ~~Strikethrough~~ |
+| `§k` | Obfuscated (characters change randomly) |
+| `§r` | Reset |
diff --git a/website/src/en/docs/reference/player-settings.md b/website/src/en/docs/reference/player-settings.md
new file mode 100644
index 0000000..6db48ac
--- /dev/null
+++ b/website/src/en/docs/reference/player-settings.md
@@ -0,0 +1,50 @@
+---
+layout: doc
+---
+
+# Player Settings
+
+Players can change their personal settings using the `/lc settings` command. Settings are saved per UUID in the server's `player-settings.yaml` (the file path can be changed via `userSettingsFilePath` in the configuration file).
+
+## Command
+
+```
+/lc settings                  # Display settings list
+/lc settings <key>            # Check current value
+/lc settings <key> on|off     # Change value
+```
+
+## Setting Keys
+
+| Key | Description | Default |
+|-----|-------------|---------|
+| `japanese` | Enable romaji-to-Japanese conversion | `true` |
+| `notice` | Enable direct message notifications | `true` |
+| `chNotice` | Enable channel message notifications | `true` |
+
+### `japanese`
+
+Automatically converts chat messages typed in romaji to Japanese (hiragana). This setting only works when `features.japaneseConversion.enabled` is set to `true` on the server side.
+
+```
+/lc settings japanese on      # Enable conversion
+/lc settings japanese off     # Disable conversion
+```
+
+### `notice`
+
+Controls notifications when receiving direct messages (`/tell` / `/reply`).
+
+```
+/lc settings notice on        # Enable notifications
+/lc settings notice off       # Disable notifications
+```
+
+### `chNotice`
+
+Controls notifications when receiving channel chat messages. This setting only works when `features.channelChat.enabled` is set to `true` on the server side.
+
+```
+/lc settings chNotice on      # Enable notifications
+/lc settings chNotice off     # Disable notifications
+```