summaryrefslogtreecommitdiff
path: root/docs/src/en/guide
diff options
context:
space:
mode:
authorSho Sakuma <me@m1sk9.dev>2026-01-26 01:56:29 +0900
committerSho Sakuma <me@m1sk9.dev>2026-01-26 01:56:29 +0900
commit64abf8c7a06839fdf662cb0e781ed1dc14da16a9 (patch)
treeb1223c8cc47594397ff0a94619391367d985c3bd /docs/src/en/guide
parent15b5bb3ebe0b4beb09b70878767db1c13445392b (diff)
downloadLunaticChat-64abf8c7a06839fdf662cb0e781ed1dc14da16a9.tar.gz
LunaticChat-64abf8c7a06839fdf662cb0e781ed1dc14da16a9.tar.bz2
LunaticChat-64abf8c7a06839fdf662cb0e781ed1dc14da16a9.zip
docs: Add about channel and chatmode guide
Diffstat (limited to 'docs/src/en/guide')
-rw-r--r--docs/src/en/guide/admin/configuration.md21
-rw-r--r--docs/src/en/guide/player/channel-chat/about.md112
-rw-r--r--docs/src/en/guide/player/channel-chat/chatmode.md30
3 files changed, 163 insertions, 0 deletions
diff --git a/docs/src/en/guide/admin/configuration.md b/docs/src/en/guide/admin/configuration.md
index 0a0bee2..6ce63b4 100644
--- a/docs/src/en/guide/admin/configuration.md
+++ b/docs/src/en/guide/admin/configuration.md
@@ -51,6 +51,9 @@ features:
timeout: 3000
# Specify the number of retry attempts for failed API requests to the Romanization conversion service.
retryAttempts: 2
+ channelChat:
+ # If enabled, channel-based chat functionality will be activated.
+ enabled: false
# ----------------------------------------------
# --------- Message Format Settings --------
@@ -62,11 +65,14 @@ features:
# {sender} - The name of the message sender
# {recipient} - The name of the message recipient
# {message} - The content of the message
+# {channel} - The name of the chat channel (only for channel chat)
# ----------------------------------------------
messageFormat:
# Configure the format for direct messages sent via /tell or /msg
directMessageFormat: "§7[§e{sender} §7>> §e{recipient}§7] §f{message}"
+ # Configure the format for messages sent in channel chat
+ channelMessageFormat: "§7[§b#{channel}§7] §e{sender}: §f{message}"
```
## General Settings
@@ -165,6 +171,13 @@ Specifies the timeout duration (in milliseconds) for API requests to the romaniz
Specifies the number of retry attempts for failed API requests to the romanization conversion service.
+### `features.channelChat.enabled`
+
+- Type: `boolean`
+- Default: `false`
+
+Enables channel-based chat functionality.
+
## Message Format Settings
Available placeholders:
@@ -172,6 +185,7 @@ Available placeholders:
- `{sender}`: Name of the message sender
- `{recipient}`: Name of the message recipient
- `{message}`: Content of the message
+- `{channel}`: Name of the chat channel (only for channel chat)
### `messageFormat.directMessageFormat`
@@ -179,3 +193,10 @@ Available placeholders:
- Default: `§7[§e{sender} §7>> §e{recipient}§7] §f{message}`
Specifies the format for messages sent via direct message ([`/tell`](../../reference/commands/tell.md) or [`/reply`](../../reference/commands/reply.md) commands).
+
+### `messageFormat.channelMessageFormat`
+
+- Type: `string`
+- Default: `§7[§b#{channel}§7] §e{sender}: §f{message}`
+
+Specifies the format for messages sent in channel chat.
diff --git a/docs/src/en/guide/player/channel-chat/about.md b/docs/src/en/guide/player/channel-chat/about.md
new file mode 100644
index 0000000..3b9b088
--- /dev/null
+++ b/docs/src/en/guide/player/channel-chat/about.md
@@ -0,0 +1,112 @@
+# Channel Chat <Badge type="tip" text="v0.6.0" /> <Badge type="warning" text="Experimental" />
+
+This feature allows specific players to share chat.
+
+::: warning Experimental Feature
+
+This feature is currently implemented experimentally, and specifications may change in future updates.
+
+Since this is a large-scale feature, we plan to implement it gradually rather than all at once.
+
+For detailed implementation plans, see the [Roadmap (m1sk9/LunaticChat #54)](https://github.com/m1sk9/LunaticChat/issues/54).
+
+:::
+
+::: tip This feature must be enabled on the server
+
+If channel chat is disabled on the server, these features cannot be used.
+
+Please contact your server administrator.
+
+:::
+
+## Creating a Channel
+
+To use channel chat, you must first create a chat channel.
+
+Use the [`/lc channnel create`](../../../reference/commands/lc/channel.md#lc-channel-create-channel-id-channel-name-channel-description-private-setting) command to create a chat channel.
+
+```
+/lc channel create <channel-id> <channel-name> [channel-description] [private-setting]
+```
+
+- `<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.
+
+::: tip Channel ID Requirements
+
+Channel IDs must follow these requirements:
+
+- Must be between 3 and 30 characters long
+- Can only contain alphanumeric characters, underscores (_), and hyphens (-)
+
+:::
+
+::: 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
+```
+
+:::
+
+The channel will be created and a confirmation message will be displayed in chat.
+
+## Joining a Channel
+
+To join a created channel, use the [`/lc channel join`](../../../reference/commands/lc/channel.md#lc-channel-join-channel-id) command.
+
+```
+/lc channel join <channel-id>
+```
+
+When you join a channel, your chat mode will switch from global chat to channel chat.
+
+## Viewing the Channel List
+
+To view the list of channels you can join, use the [`/lc channel list`](../../../reference/commands/lc/channel.md#lc-channel-list) command.
+
+```
+/lc channel list
+```
+
+A list of available channels will be displayed in the chat. You can click on them or use the [`/lc channel join`](#joining-a-channel) command to join a channel.
+
+## Chat Modes
+
+In LunaticChat, there are two types of chat modes for players when sending chat messages:
+
+1. Global chat mode: Share chat with all players.
+2. Channel chat mode: Share chat with players in a specific channel you have joined.
+
+Channel chat primarily uses chat mode `2`.
+
+For more details, see [here](./chatmode.md).
+
+## Difference Between Active Channel and Membership Status
+
+In LunaticChat, a player's active channel and membership status are managed separately.
+
+- Active channel: The channel used in channel chat mode
+- Membership status: List of channels the player has joined
+
+Only one channel can be designated as the active channel at a time. To switch the active channel to a channel in your membership status, use the [`/lc channel switch`](../../../reference/commands/lc/channel.md#lc-channel-switch-channel-id) command.
+
+```
+/lc channel switch <channel-id>
+```
+
+Removing a channel from your active status does not remove it from your membership status. To leave a channel, switch to it as your active channel first, then use the [`/lc channel leave`](../../../reference/commands/lc/channel.md#lc-channel-leave) command.
+
+```
+/lc channel leave
+```
diff --git a/docs/src/en/guide/player/channel-chat/chatmode.md b/docs/src/en/guide/player/channel-chat/chatmode.md
new file mode 100644
index 0000000..02d6a18
--- /dev/null
+++ b/docs/src/en/guide/player/channel-chat/chatmode.md
@@ -0,0 +1,30 @@
+# Chat Mode
+
+Chat mode refers to the mode in which players send chat messages in LunaticChat. LunaticChat has the following two types of chat modes:
+
+1. Global chat mode: Share chat with all players.
+2. Channel chat mode: Share chat with players in a specific channel you have joined.
+
+## Channel Chat Mode
+
+While in channel chat mode, all chat messages are displayed only to players in the channel you have joined and will not be displayed in global chat.
+
+::: tip Temporarily Send to Global Chat
+
+If you want to temporarily send a message to global chat while in channel chat mode, prefix your message with `!`.
+
+```
+!Hello everyone, how are you?
+```
+
+:::
+
+## Global Chat Mode
+
+While in global chat mode, you share chat with all players on the server. It functions the same as normal Minecraft chat.
+
+## Temporarily Switching Chat Modes
+
+To temporarily switch chat modes, use the `/chatmode toggle` command.
+
+When you switch using this command, you can change chat modes without joining or leaving channels.