diff options
Diffstat (limited to 'docs/src/en/reference')
| -rw-r--r-- | docs/src/en/reference/commands/jp.md | 17 | ||||
| -rw-r--r-- | docs/src/en/reference/commands/lc/settings.md | 18 | ||||
| -rw-r--r-- | docs/src/en/reference/commands/lc/status.md | 9 | ||||
| -rw-r--r-- | docs/src/en/reference/commands/notice.md | 17 | ||||
| -rw-r--r-- | docs/src/en/reference/commands/reply.md | 17 | ||||
| -rw-r--r-- | docs/src/en/reference/commands/tell.md | 11 | ||||
| -rw-r--r-- | docs/src/en/reference/index.md | 23 | ||||
| -rw-r--r-- | docs/src/en/reference/permissions.md | 59 |
8 files changed, 171 insertions, 0 deletions
diff --git a/docs/src/en/reference/commands/jp.md b/docs/src/en/reference/commands/jp.md new file mode 100644 index 0000000..839e6e1 --- /dev/null +++ b/docs/src/en/reference/commands/jp.md @@ -0,0 +1,17 @@ +# /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/settings.md b/docs/src/en/reference/commands/lc/settings.md new file mode 100644 index 0000000..742e85c --- /dev/null +++ b/docs/src/en/reference/commands/lc/settings.md @@ -0,0 +1,18 @@ +# /lc settings <Badge type="tip" text="v0.5.0" /> <Badge type="tip" text="Paper" /> + +### `/lc settings <key> [value]` + +| Permission | +|--------------------------------| +| `lunaticchat.command.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 | +|----------|----------------------------------------------------------|--------| +| `jp` | Toggles romanization conversion on or off. | `true` | +| `notice` | Toggles whether to receive notifications when receiving direct messages via `/tell` or `/reply`. | `true` | diff --git a/docs/src/en/reference/commands/lc/status.md b/docs/src/en/reference/commands/lc/status.md new file mode 100644 index 0000000..365519a --- /dev/null +++ b/docs/src/en/reference/commands/lc/status.md @@ -0,0 +1,9 @@ +# /lc status <Badge type="tip" text="v0.5.0" /> <Badge type="tip" text="Paper" /> + +### `/lc status` + +| Permission | +|------------------------------| +| `lunaticchat.command.status` | + +Displays the status of LunaticChat. diff --git a/docs/src/en/reference/commands/notice.md b/docs/src/en/reference/commands/notice.md new file mode 100644 index 0000000..4e7f41f --- /dev/null +++ b/docs/src/en/reference/commands/notice.md @@ -0,0 +1,17 @@ +# /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 new file mode 100644 index 0000000..0884eb8 --- /dev/null +++ b/docs/src/en/reference/commands/reply.md @@ -0,0 +1,17 @@ +# /reply <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper" /> + +### `/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 new file mode 100644 index 0000000..6687e94 --- /dev/null +++ b/docs/src/en/reference/commands/tell.md @@ -0,0 +1,11 @@ +# /tell <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper" /> + +### `/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 new file mode 100644 index 0000000..338694e --- /dev/null +++ b/docs/src/en/reference/index.md @@ -0,0 +1,23 @@ +# 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 new file mode 100644 index 0000000..ed30a77 --- /dev/null +++ b/docs/src/en/reference/permissions.md @@ -0,0 +1,59 @@ +# 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.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.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.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. |