summaryrefslogtreecommitdiff
path: root/docs/src/en/reference
diff options
context:
space:
mode:
authorSho Sakuma <me@m1sk9.dev>2026-02-23 18:46:56 +0900
committerSho Sakuma <me@m1sk9.dev>2026-02-23 18:46:56 +0900
commitf4b57c95a1622cb009eec25e64da79b139e3dcf1 (patch)
treec2ef4407725bb0bd35f63b92a2875d4a2d153525 /docs/src/en/reference
parent02574e0f606d0af3535d58b794fc5304de3ba37c (diff)
downloadLunaticChat-f4b57c95a1622cb009eec25e64da79b139e3dcf1.tar.gz
LunaticChat-f4b57c95a1622cb009eec25e64da79b139e3dcf1.tar.bz2
LunaticChat-f4b57c95a1622cb009eec25e64da79b139e3dcf1.zip
docs: Update guide
Diffstat (limited to 'docs/src/en/reference')
-rw-r--r--docs/src/en/reference/commands/jp.md17
-rw-r--r--docs/src/en/reference/commands/lc/channel.md77
-rw-r--r--docs/src/en/reference/commands/lc/chatmode.md17
-rw-r--r--docs/src/en/reference/commands/lc/settings.md19
-rw-r--r--docs/src/en/reference/commands/lc/status.md9
-rw-r--r--docs/src/en/reference/commands/lcv/status.md9
-rw-r--r--docs/src/en/reference/commands/notice.md17
-rw-r--r--docs/src/en/reference/commands/reply.md17
-rw-r--r--docs/src/en/reference/commands/tell.md11
-rw-r--r--docs/src/en/reference/index.md23
-rw-r--r--docs/src/en/reference/permissions.md179
11 files changed, 0 insertions, 395 deletions
diff --git a/docs/src/en/reference/commands/jp.md b/docs/src/en/reference/commands/jp.md
deleted file mode 100644
index 839e6e1..0000000
--- a/docs/src/en/reference/commands/jp.md
+++ /dev/null
@@ -1,17 +0,0 @@
-# /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/channel.md b/docs/src/en/reference/commands/lc/channel.md
deleted file mode 100644
index 31941ca..0000000
--- a/docs/src/en/reference/commands/lc/channel.md
+++ /dev/null
@@ -1,77 +0,0 @@
-# /lc channel <Badge type="tip" text="v0.6.0" /> <Badge type="tip" text="Paper" />
-
-### `/lc channel create <channel-id> <channel-name> [channel-description] [private-setting]`
-
-| Permission |
-|------------------------------|
-| `lunaticchat.command.lc.channel.create` |
-
-Creates a channel.
-
-- `<channel-id>` specifies the channel ID.
-- `<channel-name>` specifies the channel name.
-- `[channel-description]` specifies the channel description (optional).
- - The description will be displayed when viewing the channel list with the `/lc channel list` command.
-- `[private-setting]` specifies the channel's privacy setting.
- - If `true` is specified, it will be created as a private channel, and only invited players can join.
- - If `false` is specified or omitted, it will be created as a public channel, and anyone can join.
-
-::: warning Notes on Entering Channel Names and Descriptions
-
-When entering channel names and descriptions, arguments must be enclosed in `"` (double quotes).
-
-Example:
-
-```
-/lc channel create pvp_channel "PvP Enthusiasts Club" "A gathering of people who love PvP" false
-```
-
-:::
-
-### `/lc channel list`
-
-| Permission |
-|---------------------------------------|
-| `lunaticchat.command.lc.channel.list` |
-
-Displays the list of channels.
-
-### `/lc channel join <channel-id>`
-
-| Permission |
-|---------------------------------------|
-| `lunaticchat.command.lc.channel.join` |
-
-Joins the specified channel.
-
-### `/lc channel leave`
-
-| Permission |
-|----------------------------------------|
-| `lunaticchat.command.lc.channel.leave` |
-
-Leaves the currently active channel.
-
-### `/lc channel switch <channel-id>`
-
-| Permission |
-|-----------------------------------------|
-| `lunaticchat.command.lc.channel.switch` |
-
-Switches to the specified channel. Use this when you want to switch to another channel while in channel chat mode.
-
-### `/lc channel status`
-
-| Permission |
-|-----------------------------------------|
-| `lunaticchat.command.lc.channel.status` |
-
-Displays information about the currently joined and active channels.
-
-### `/lc channel delete <channel-id>`
-
-| Permission |
-|-----------------------------------------|
-| `lunaticchat.command.lc.channel.delete` |
-
-Deletes the specified channel. You must be the channel creator (owner).
diff --git a/docs/src/en/reference/commands/lc/chatmode.md b/docs/src/en/reference/commands/lc/chatmode.md
deleted file mode 100644
index e3f335f..0000000
--- a/docs/src/en/reference/commands/lc/chatmode.md
+++ /dev/null
@@ -1,17 +0,0 @@
-# /lc chatmode <Badge type="tip" text="v0.6.0" /> <Badge type="tip" text="Paper" />
-
-### `/lc chatmode`
-
-| Permission |
-|-----------------------------------|
-| `lunaticchat.command.lc.chatmode` |
-
-Displays the current chat mode.
-
-### `/lc chatmode toggle`
-
-| Permission |
-|------------------------------------|
-| `lunaticchat.command.lc.chatmode.toggle` |
-
-Toggles the chat mode.
diff --git a/docs/src/en/reference/commands/lc/settings.md b/docs/src/en/reference/commands/lc/settings.md
deleted file mode 100644
index 8b88066..0000000
--- a/docs/src/en/reference/commands/lc/settings.md
+++ /dev/null
@@ -1,19 +0,0 @@
-# /lc settings <Badge type="tip" text="v0.5.0" /> <Badge type="tip" text="Paper" />
-
-### `/lc settings <key> [value]`
-
-| Permission |
-|-----------------------------------|
-| `lunaticchat.command.lc.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 |
-|----------|----------------------------------------------------------|--------|
-| `japanese` | Toggles romanization conversion on or off. | `true` |
-| `notice` | Toggles whether to receive notifications when receiving direct messages via `/tell` or `/reply`. | `true` |
-| `chNotice` | Toggles whether to receive notifications when receiving channel chat messages. | `true` |
diff --git a/docs/src/en/reference/commands/lc/status.md b/docs/src/en/reference/commands/lc/status.md
deleted file mode 100644
index 1fa6a39..0000000
--- a/docs/src/en/reference/commands/lc/status.md
+++ /dev/null
@@ -1,9 +0,0 @@
-# /lc status <Badge type="tip" text="v0.5.0" /> <Badge type="tip" text="Paper" />
-
-### `/lc status`
-
-| Permission |
-|---------------------------------|
-| `lunaticchat.command.lc.status` |
-
-Displays the status of LunaticChat.
diff --git a/docs/src/en/reference/commands/lcv/status.md b/docs/src/en/reference/commands/lcv/status.md
deleted file mode 100644
index 2b85283..0000000
--- a/docs/src/en/reference/commands/lcv/status.md
+++ /dev/null
@@ -1,9 +0,0 @@
-# /lcv status <Badge type="tip" text="v0.8.0" /> <Badge type="tip" text="Velocity" />
-
-### `/lcv status`
-
-| Permission |
-|------------------------------|
-| `lunaticchat.command.lcv.status` |
-
-Displays the current LunaticChat Velocity integration status.
diff --git a/docs/src/en/reference/commands/notice.md b/docs/src/en/reference/commands/notice.md
deleted file mode 100644
index 4e7f41f..0000000
--- a/docs/src/en/reference/commands/notice.md
+++ /dev/null
@@ -1,17 +0,0 @@
-# /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
deleted file mode 100644
index 1b26be2..0000000
--- a/docs/src/en/reference/commands/reply.md
+++ /dev/null
@@ -1,17 +0,0 @@
-# /reply <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper/Velocity" />
-
-### `/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
deleted file mode 100644
index fb2b8e1..0000000
--- a/docs/src/en/reference/commands/tell.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# /tell <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper/Velocity" />
-
-### `/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
deleted file mode 100644
index 338694e..0000000
--- a/docs/src/en/reference/index.md
+++ /dev/null
@@ -1,23 +0,0 @@
-# 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
deleted file mode 100644
index 4508808..0000000
--- a/docs/src/en/reference/permissions.md
+++ /dev/null
@@ -1,179 +0,0 @@
-# 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.channelbypass`
-
-- Default: `OP`
-
-Bypasses moderation features and restrictions on private channels.
-
-## `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`
-
-- Default: `non OP`
-
-Toggles the use of the `/lc` 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.lc.channel`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc channel`](commands/lc/channel.md) command.
-
-### `lunaticchat.command.lc.channel.create`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc channel create`](commands/lc/channel.md) command.
-
-### `lunaticchat.command.lc.channel.list`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc channel list`](commands/lc/channel.md) command.
-
-### `lunaticchat.command.lc.channel.join`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc channel join`](commands/lc/channel.md) command.
-
-### `lunaticchat.command.lc.channel.leave`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc channel leave`](commands/lc/channel.md) command.
-
-### `lunaticchat.command.lc.channel.switch`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc channel switch`](commands/lc/channel.md) command.
-
-### `lunaticchat.command.lc.channel.status`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc channel status`](commands/lc/channel.md) command.
-
-### `lunaticchat.command.lc.channel.info`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc channel info`](commands/lc/channel.md) command.
-
-### `lunaticchat.command.lc.channel.delete`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc channel delete`](commands/lc/channel.md) command.
-
-### `lunaticchat.command.lc.channel.invite`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc channel invite`](commands/lc/channel.md) command.
-
-### `lunaticchat.command.lc.channel.kick`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc channel kick`](commands/lc/channel.md) command.
-
-### `lunaticchat.command.lc.channel.ban`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc channel ban`](commands/lc/channel.md) command.
-
-### `lunaticchat.command.lc.channel.unban`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc channel unban`](commands/lc/channel.md) command.
-
-### `lunaticchat.command.lc.channel.mod`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc channel mod`](commands/lc/channel.md) command.
-
-### `lunaticchat.command.lc.channel.ownership`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc channel ownership`](commands/lc/channel.md) command.
-
-### `lunaticchat.command.lc.chatmode`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc chatmode`](commands/lc/chatmode.md) command.
-
-### `lunaticchat.command.lc.chatmode.toggle`
-
-- Default: `non OP`
-
-Toggles the use of the [`/lc chatmode toggle`](commands/lc/chatmode.md) command.
-
-### `lunaticchat.command.lcv.status`
-
-- Default: `OP`
-
-Toggles the use of the [`/lcv status`](commands/lcv/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.