From 15b5bb3ebe0b4beb09b70878767db1c13445392b Mon Sep 17 00:00:00 2001 From: Sho Sakuma Date: Mon, 26 Jan 2026 01:29:07 +0900 Subject: feat: Add channel-chat handle --- docs/src/guide/player/channel-chat.md | 140 ++++++++++++++++++++++++++++++++++ 1 file changed, 140 insertions(+) (limited to 'docs/src') diff --git a/docs/src/guide/player/channel-chat.md b/docs/src/guide/player/channel-chat.md index ce5a43e..57f86ed 100644 --- a/docs/src/guide/player/channel-chat.md +++ b/docs/src/guide/player/channel-chat.md @@ -11,3 +11,143 @@ 詳しい実装計画は [ロードマップ (m1sk9/LunaticChat #54)](https://github.com/m1sk9/LunaticChat/issues/54) をご覧ください． ::: + +::: tip この機能はサーバーで有効化する必要があります + +チャンネルチャットがサーバーで無効化されている場合，これらの機能は使用できません． + +サーバー管理者にお問い合わせください． + +::: + +## 使い方 + +### チャンネルを作成する + +チャンネルチャットを利用するには，まずチャットチャンネルを作成する必要があります． + +`/lc channnel create` コマンドを使用して，チャットチャンネルを作成します． + +``` +/lc channel create <チャンネルID> <チャンネル名> [チャンネルの説明] [プライベート設定] +``` + +- `<チャンネルID>` はチャンネルのIDを指定します． +- `<チャンネル名>` はチャンネルの名前を指定します． +- `[チャンネルの説明]` はチャンネルの説明を指定します (省略可能)． + - `/lc channel list` コマンドでチャンネル一覧を表示した際に，説明が表示されます． +- `[プライベート設定]` はチャンネルの公開設定を指定します． + - `true` を指定するとプライベートチャンネルとして作成され，招待されたプレイヤーのみが参加できます． + - `false` を指定するか，省略した場合はパブリックチャンネルとして作成され，誰でも参加できます． + +::: tip チャンネルIDの要件 + +チャンネルIDは次の要件に従う必要があります: + +- 3文字以上，30文字以下であること +- 英数字，アンダースコア（_），ハイフン（-）のみを含むこと + +::: + +::: warning チャンネル名・チャンネルの説明を入力する際の注意点 + +チャンネル名・チャンネルの説明を入力する際は，引数を `"` (ダブルクォーテーション) で囲む必要があります． + +実行例は次のとおりです: + +``` +/lc channel create pvp_channel "PvP大好きクラブ" "PvPが大好きな人たちの集まり" false +``` + +::: + +チャンネルが正常に作成されると，チャットで確認メッセージが表示されます． + +### チャンネルに参加する + +作成されたチャンネルに参加するには，`/lc channel join` コマンドを使用します． + +``` +/lc channel join <チャンネルID> +``` + +チャンネルに参加すると，チャットモードが全体チャットからチャンネルチャットに切り替わります． + +### チャンネル一覧を表示する + +参加可能なチャンネル一覧を表示するには，`/lc channel list` コマンドを使用します． + +``` +/lc channel list +``` + +チャット欄に参加可能なチャンネルの一覧が表示されます．クリックするか [`/lc channel join`](#チャンネルに参加する) コマンドを使用して，チャンネルに参加できます． + +## プライベートチャンネル + +プライベートチャンネルは，招待されたプレイヤーのみが参加できるチャットチャンネルです． + +::: tip プライベートチャンネルに対する権限 + +プライベートチャンネルに対する権限は，チャンネルの作成者にのみ付与されます． + +::: + +### プレイヤーを招待する + +プライベートチャンネルにプレイヤーを招待するには，`/lc channel invite` コマンドを使用します． + +なお，招待するにはチャンネルの作成者(オーナー)もしくは管理者である必要があります． + +``` +/lc channel invite <チャンネルID> <プレイヤー名> +``` + +### 再参加する + +プライベートチャンネルから退出した後，再度参加するには，[`/lc channel join`](#チャンネルに参加する) コマンドを使用します． + +一度参加したプライベートチャンネルには招待なしで再参加できます． + +::: tip 参加できないようにするには + +プライベートチャンネルから退出した後，再度参加できないようにするには，`/lc channel kick` コマンドを使用して，プレイヤーをチャンネルから強制退出させる必要があります． + +詳しくは [チャンネルの管理]() をご覧ください． + +::: + +## チャンネルチャットに伴う挙動 + +### チャットモードについて + +LunaticChat では，チャットモードが以下の2種類あります: + +1. 全体チャットモード: すべてのプレイヤーとチャットを共有します． +2. チャンネルチャットモード: 参加している特定のチャンネル内のプレイヤーとチャットを共有します． + +チャンネルチャットモード中は，全てのチャットが参加しているチャンネルのプレイヤーのみに表示され，全体チャットには表示されません． + +全体チャットモードに切り替えるには一度チャンネルから退出する必要があります． + +現在のチャットモードは `/chatmode` コマンドで確認できるほか，サーバーにログインした際にも表示されます． + +::: tip 一時的に全体チャットを送信する + +チャンネルチャットモード中に，一時的に全体チャットを送信したい場合は，メッセージの先頭に `!` を付けて送信します． + +``` +!こんにちは、みんな元気？ +``` + +::: + +#### 一時的にチャットモードを切り替える + +チャットモードを一時的に切り替えるには，`/chatmode toggle` コマンドを使用します． + +このコマンドで切り替えた場合はチャンネルの入退出なしで，チャットモードを切り替えることができます． + +ただし，サーバーに再接続した際には元のチャットモードに戻ります． + + -- cgit v1.2.1 From 64abf8c7a06839fdf662cb0e781ed1dc14da16a9 Mon Sep 17 00:00:00 2001 From: Sho Sakuma Date: Mon, 26 Jan 2026 01:56:29 +0900 Subject: docs: Add about channel and chatmode guide --- docs/src/en/guide/admin/configuration.md | 21 +++ docs/src/en/guide/player/channel-chat/about.md | 112 ++++++++++++++++ docs/src/en/guide/player/channel-chat/chatmode.md | 30 +++++ docs/src/en/reference/commands/lc/channel.md | 77 +++++++++++ docs/src/en/reference/commands/lc/chatmode.md | 17 +++ docs/src/en/reference/permissions.md | 66 ++++++++++ docs/src/guide/admin/configuration.md | 21 +++ docs/src/guide/player/channel-chat.md | 153 ---------------------- docs/src/guide/player/channel-chat/about.md | 112 ++++++++++++++++ docs/src/guide/player/channel-chat/chatmode.md | 30 +++++ docs/src/reference/commands/lc/channel.md | 78 +++++++++++ docs/src/reference/commands/lc/chatmode.md | 17 +++ docs/src/reference/permissions.md | 66 ++++++++++ 13 files changed, 647 insertions(+), 153 deletions(-) create mode 100644 docs/src/en/guide/player/channel-chat/about.md create mode 100644 docs/src/en/guide/player/channel-chat/chatmode.md create mode 100644 docs/src/en/reference/commands/lc/channel.md create mode 100644 docs/src/en/reference/commands/lc/chatmode.md delete mode 100644 docs/src/guide/player/channel-chat.md create mode 100644 docs/src/guide/player/channel-chat/about.md create mode 100644 docs/src/guide/player/channel-chat/chatmode.md create mode 100644 docs/src/reference/commands/lc/channel.md create mode 100644 docs/src/reference/commands/lc/chatmode.md (limited to 'docs/src') 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 + +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-description] [private-setting] +``` + +- `` specifies the channel ID. +- `` 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 +``` + +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 +``` + +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. diff --git a/docs/src/en/reference/commands/lc/channel.md b/docs/src/en/reference/commands/lc/channel.md new file mode 100644 index 0000000..31941ca --- /dev/null +++ b/docs/src/en/reference/commands/lc/channel.md @@ -0,0 +1,77 @@ +# /lc channel + +### `/lc channel create [channel-description] [private-setting]` + +| Permission | +|------------------------------| +| `lunaticchat.command.lc.channel.create` | + +Creates a channel. + +- `` specifies the channel ID. +- `` 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 ` + +| 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 ` + +| 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 ` + +| 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 new file mode 100644 index 0000000..e3f335f --- /dev/null +++ b/docs/src/en/reference/commands/lc/chatmode.md @@ -0,0 +1,17 @@ +# /lc chatmode + +### `/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/permissions.md b/docs/src/en/reference/permissions.md index ed30a77..718e5f9 100644 --- a/docs/src/en/reference/permissions.md +++ b/docs/src/en/reference/permissions.md @@ -34,6 +34,12 @@ Toggles the use of the [`/tell`](commands/tell.md) command. Toggles the use of the [`/reply`](commands/reply.md) command. +### `lunaticchat.command.lc` + +- Default: `non OP` + +Toggles the use of the [`/lc`](commands/lc/index.md) command. + ### `lunaticchat.command.lc.settings` - Default: `non OP` @@ -46,6 +52,66 @@ Toggles the use of the [`/lc settings`](commands/lc/settings.md) command. 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.delete` + +- Default: `non OP` + +Toggles the use of the [`/lc channel delete`](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.jp` - Default: `non OP` diff --git a/docs/src/guide/admin/configuration.md b/docs/src/guide/admin/configuration.md index 2c70f55..ac63eb7 100644 --- a/docs/src/guide/admin/configuration.md +++ b/docs/src/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 @@ LunaticChat の [`/reply`](../../reference/commands/reply.md) コマンドによ ローマ字変換 API へのリクエストが失敗した場合の再試行回数を指定します． +### `features.channelChat.enabled` + +- Type: `boolean` +- Default: `false` + +チャンネルチャット機能を有効にします． + ## Message Format Settings 使用できるプレースホルダー: @@ -172,6 +185,7 @@ LunaticChat の [`/reply`](../../reference/commands/reply.md) コマンドによ - `{sender}`: メッセージ送信者の名前 - `{recipient}`: メッセージ受信者の名前 - `{message}`: メッセージの内容 +- `{channel}`: チャットチャンネルの名前 (チャンネルチャットの場合のみ) ### `messageFormat.directMessageFormat` @@ -179,3 +193,10 @@ LunaticChat の [`/reply`](../../reference/commands/reply.md) コマンドによ - Default: `§7[§e{sender} §7>> §e{recipient}§7] §f{message}` ダイレクトメッセージ（ [`/tell`](../../reference/commands/tell.md) や [`/reply`](../../reference/commands/reply.md) コマンド）で送信されるメッセージのフォーマットを指定します． + +### `messageFormat.channelMessageFormat` + +- Type: `string` +- Default: `§7[§b#{channel}§7] §e{sender}: §f{message}` + +チャンネルチャットで送信されるメッセージのフォーマットを指定します． diff --git a/docs/src/guide/player/channel-chat.md b/docs/src/guide/player/channel-chat.md deleted file mode 100644 index 57f86ed..0000000 --- a/docs/src/guide/player/channel-chat.md +++ /dev/null @@ -1,153 +0,0 @@ -# チャンネルチャット - -特定のプレイヤー間で，チャットを共有できる機能です． - -::: warning 試験的機能 - -この機能は現在，試験的に実装されており，今後のアップデートで仕様が変更される可能性があります． - -規模が大きい機能なので，一気に実装はせず段階的な展開を予定しています． - -詳しい実装計画は [ロードマップ (m1sk9/LunaticChat #54)](https://github.com/m1sk9/LunaticChat/issues/54) をご覧ください． - -::: - -::: tip この機能はサーバーで有効化する必要があります - -チャンネルチャットがサーバーで無効化されている場合，これらの機能は使用できません． - -サーバー管理者にお問い合わせください． - -::: - -## 使い方 - -### チャンネルを作成する - -チャンネルチャットを利用するには，まずチャットチャンネルを作成する必要があります． - -`/lc channnel create` コマンドを使用して，チャットチャンネルを作成します． - -``` -/lc channel create <チャンネルID> <チャンネル名> [チャンネルの説明] [プライベート設定] -``` - -- `<チャンネルID>` はチャンネルのIDを指定します． -- `<チャンネル名>` はチャンネルの名前を指定します． -- `[チャンネルの説明]` はチャンネルの説明を指定します (省略可能)． - - `/lc channel list` コマンドでチャンネル一覧を表示した際に，説明が表示されます． -- `[プライベート設定]` はチャンネルの公開設定を指定します． - - `true` を指定するとプライベートチャンネルとして作成され，招待されたプレイヤーのみが参加できます． - - `false` を指定するか，省略した場合はパブリックチャンネルとして作成され，誰でも参加できます． - -::: tip チャンネルIDの要件 - -チャンネルIDは次の要件に従う必要があります: - -- 3文字以上，30文字以下であること -- 英数字，アンダースコア（_），ハイフン（-）のみを含むこと - -::: - -::: warning チャンネル名・チャンネルの説明を入力する際の注意点 - -チャンネル名・チャンネルの説明を入力する際は，引数を `"` (ダブルクォーテーション) で囲む必要があります． - -実行例は次のとおりです: - -``` -/lc channel create pvp_channel "PvP大好きクラブ" "PvPが大好きな人たちの集まり" false -``` - -::: - -チャンネルが正常に作成されると，チャットで確認メッセージが表示されます． - -### チャンネルに参加する - -作成されたチャンネルに参加するには，`/lc channel join` コマンドを使用します． - -``` -/lc channel join <チャンネルID> -``` - -チャンネルに参加すると，チャットモードが全体チャットからチャンネルチャットに切り替わります． - -### チャンネル一覧を表示する - -参加可能なチャンネル一覧を表示するには，`/lc channel list` コマンドを使用します． - -``` -/lc channel list -``` - -チャット欄に参加可能なチャンネルの一覧が表示されます．クリックするか [`/lc channel join`](#チャンネルに参加する) コマンドを使用して，チャンネルに参加できます． - -## プライベートチャンネル - -プライベートチャンネルは，招待されたプレイヤーのみが参加できるチャットチャンネルです． - -::: tip プライベートチャンネルに対する権限 - -プライベートチャンネルに対する権限は，チャンネルの作成者にのみ付与されます． - -::: - -### プレイヤーを招待する - -プライベートチャンネルにプレイヤーを招待するには，`/lc channel invite` コマンドを使用します． - -なお，招待するにはチャンネルの作成者(オーナー)もしくは管理者である必要があります． - -``` -/lc channel invite <チャンネルID> <プレイヤー名> -``` - -### 再参加する - -プライベートチャンネルから退出した後，再度参加するには，[`/lc channel join`](#チャンネルに参加する) コマンドを使用します． - -一度参加したプライベートチャンネルには招待なしで再参加できます． - -::: tip 参加できないようにするには - -プライベートチャンネルから退出した後，再度参加できないようにするには，`/lc channel kick` コマンドを使用して，プレイヤーをチャンネルから強制退出させる必要があります． - -詳しくは [チャンネルの管理]() をご覧ください． - -::: - -## チャンネルチャットに伴う挙動 - -### チャットモードについて - -LunaticChat では，チャットモードが以下の2種類あります: - -1. 全体チャットモード: すべてのプレイヤーとチャットを共有します． -2. チャンネルチャットモード: 参加している特定のチャンネル内のプレイヤーとチャットを共有します． - -チャンネルチャットモード中は，全てのチャットが参加しているチャンネルのプレイヤーのみに表示され，全体チャットには表示されません． - -全体チャットモードに切り替えるには一度チャンネルから退出する必要があります． - -現在のチャットモードは `/chatmode` コマンドで確認できるほか，サーバーにログインした際にも表示されます． - -::: tip 一時的に全体チャットを送信する - -チャンネルチャットモード中に，一時的に全体チャットを送信したい場合は，メッセージの先頭に `!` を付けて送信します． - -``` -!こんにちは、みんな元気？ -``` - -::: - -#### 一時的にチャットモードを切り替える - -チャットモードを一時的に切り替えるには，`/chatmode toggle` コマンドを使用します． - -このコマンドで切り替えた場合はチャンネルの入退出なしで，チャットモードを切り替えることができます． - -ただし，サーバーに再接続した際には元のチャットモードに戻ります． - - diff --git a/docs/src/guide/player/channel-chat/about.md b/docs/src/guide/player/channel-chat/about.md new file mode 100644 index 0000000..67aa170 --- /dev/null +++ b/docs/src/guide/player/channel-chat/about.md @@ -0,0 +1,112 @@ +# チャンネルチャット + +特定のプレイヤー間で，チャットを共有できる機能です． + +::: warning 試験的機能 + +この機能は現在，試験的に実装されており，今後のアップデートで仕様が変更される可能性があります． + +規模が大きい機能なので，一気に実装はせず段階的な展開を予定しています． + +詳しい実装計画は [ロードマップ (m1sk9/LunaticChat #54)](https://github.com/m1sk9/LunaticChat/issues/54) をご覧ください． + +::: + +::: tip この機能はサーバーで有効化する必要があります + +チャンネルチャットがサーバーで無効化されている場合，これらの機能は使用できません． + +サーバー管理者にお問い合わせください． + +::: + +## チャンネルを作成する + +チャンネルチャットを利用するには，まずチャットチャンネルを作成する必要があります． + +[`/lc channnel create`](../../../reference/commands/lc/channel.md#lc-channel-create-チャンネルid-チャンネル名-チャンネルの説明-プライベート設定) コマンドを使用して，チャットチャンネルを作成します． + +``` +/lc channel create <チャンネルID> <チャンネル名> [チャンネルの説明] [プライベート設定] +``` + +- `<チャンネルID>` はチャンネルのIDを指定します． +- `<チャンネル名>` はチャンネルの名前を指定します． +- `[チャンネルの説明]` はチャンネルの説明を指定します (省略可能)． + - `/lc channel list` コマンドでチャンネル一覧を表示した際に，説明が表示されます． +- `[プライベート設定]` はチャンネルの公開設定を指定します． + - `true` を指定するとプライベートチャンネルとして作成され，招待されたプレイヤーのみが参加できます． + - `false` を指定するか，省略した場合はパブリックチャンネルとして作成され，誰でも参加できます． + +::: tip チャンネルIDの要件 + +チャンネルIDは次の要件に従う必要があります: + +- 3文字以上，30文字以下であること +- 英数字，アンダースコア（_），ハイフン（-）のみを含むこと + +::: + +::: warning チャンネル名・チャンネルの説明を入力する際の注意点 + +チャンネル名・チャンネルの説明を入力する際は，引数を `"` (ダブルクォーテーション) で囲む必要があります． + +実行例は次のとおりです: + +``` +/lc channel create pvp_channel "PvP大好きクラブ" "PvPが大好きな人たちの集まり" false +``` + +::: + +チャンネルが正常に作成されると，チャットで確認メッセージが表示されます． + +## チャンネルに参加する + +作成されたチャンネルに参加するには，[`/lc channel join`](../../../reference/commands/lc/channel.md#lc-channel-join-チャンネルid) コマンドを使用します． + +``` +/lc channel join <チャンネルID> +``` + +チャンネルに参加すると，チャットモードが全体チャットからチャンネルチャットに切り替わります． + +## チャンネル一覧を表示する + +参加可能なチャンネル一覧を表示するには，[`/lc channel list`](../../../reference/commands/lc/channel.md#lc-channel-list) コマンドを使用します． + +``` +/lc channel list +``` + +チャット欄に参加可能なチャンネルの一覧が表示されます．クリックするか [`/lc channel join`](#チャンネルに参加する) コマンドを使用して，チャンネルに参加できます． + +## チャットモード + +LunaticChat では，プレイヤーがチャットを送信する際のモードとして，以下の2種類のチャットモードが存在します: + +1. 全体チャットモード: すべてのプレイヤーとチャットを共有します． +2. チャンネルチャットモード: 参加している特定のチャンネル内のプレイヤーとチャットを共有します． + +チャンネルチャットでは主に `2` のチャットモードが使用されます． + +詳しくは [こちら](./chatmode.md) をご覧ください． + +## アクティブチャンネルとメンバーシップ状態の違い + +LunaticChat では，プレイヤーのアクティブチャンネルとメンバーシップ状態は別々に管理されています． + +- アクティブチャンネル: チャンネルチャットモードで使用されるチャンネル +- メンバーシップ状態: プレイヤーが参加しているチャンネルの一覧 + +アクティブチャンネルは一度に一つのチャンネルのみを指定できます．メンバーシップ状態のチャンネルにアクティブチャンネルを切り替える場合は [`/lc channel switch`](../../../reference/commands/lc/channel.md#lc-channel-switch-チャンネルid) コマンドを使用します． + +``` +/lc channel switch <チャンネルID> +``` + +メンバーシップ状態のチャンネルからアクティブチャンネルを解除してもチャンネルからは削除されません．チャンネルから退出するにはアクティブチャンネルに切り替えてから [`/lc channel leave`](../../../reference/commands/lc/channel.md#lc-channel-leave) コマンドを使用します． + +``` +/lc channel leave +``` diff --git a/docs/src/guide/player/channel-chat/chatmode.md b/docs/src/guide/player/channel-chat/chatmode.md new file mode 100644 index 0000000..9e2712d --- /dev/null +++ b/docs/src/guide/player/channel-chat/chatmode.md @@ -0,0 +1,30 @@ +# チャットモード + +チャットモードは LunaticChat におけるプレイヤーがチャットを送信する際のモードを指します．LunaticChat では以下の2種類のチャットモードが存在します． + +1. 全体チャットモード: すべてのプレイヤーとチャットを共有します． +2. チャンネルチャットモード: 参加している特定のチャンネル内のプレイヤーとチャットを共有します． + +## チャットチャットモード + +チャンネルチャットモード中は，全てのチャットが参加しているチャンネルのプレイヤーのみに表示され，全体チャットには表示されません． + +::: tip 一時的に全体チャットを送信する + +チャンネルチャットモード中に，一時的に全体チャットを送信したい場合は，メッセージの先頭に `!` を付けて送信します． + +``` +!こんにちは、みんな元気？ +``` + +::: + +## 全体チャットモード + +全体チャットモード中は，サーバー内のすべてのプレイヤーとチャットを共有します．通常の Minecraft チャットと同様の動作をします． + +## 一時的にチャットモードを切り替える + +チャットモードを一時的に切り替えるには，`/chatmode toggle` コマンドを使用します． + +このコマンドで切り替えた場合はチャンネルの入退出なしで，チャットモードを切り替えることができます． diff --git a/docs/src/reference/commands/lc/channel.md b/docs/src/reference/commands/lc/channel.md new file mode 100644 index 0000000..9cc96e2 --- /dev/null +++ b/docs/src/reference/commands/lc/channel.md @@ -0,0 +1,78 @@ +# /lc channel + +### `/lc channel create <チャンネルID> <チャンネル名> [チャンネルの説明] [プライベート設定]` + +| パーミッション | +|------------------------------| +| `lunaticchat.command.lc.channel.create` | + +チャンネルを作成します． + +- `<チャンネルID>` はチャンネルのIDを指定します． +- `<チャンネル名>` はチャンネルの名前を指定します． +- `[チャンネルの説明]` はチャンネルの説明を指定します (省略可能)． + - `/lc channel list` コマンドでチャンネル一覧を表示した際に，説明が表示されます． +- `[プライベート設定]` はチャンネルの公開設定を指定します． + - `true` を指定するとプライベートチャンネルとして作成され，招待されたプレイヤーのみが参加できます． + - `false` を指定するか，省略した場合はパブリックチャンネルとして作成され，誰でも参加できます． + +::: warning チャンネル名・チャンネルの説明を入力する際の注意点 + +チャンネル名・チャンネルの説明を入力する際は，引数を `"` (ダブルクォーテーション) で囲む必要があります． + +実行例は次のとおりです: + +``` +/lc channel create pvp_channel "PvP大好きクラブ" "PvPが大好きな人たちの集まり" false +``` + +::: + +### `/lc channel list` + +| パーミッション | +|---------------------------------------| +| `lunaticchat.command.lc.channel.list` | + +チャンネルの一覧を表示します． + +### `/lc channel join <チャンネルID>` + +| パーミッション | +|---------------------------------------| +| `lunaticchat.command.lc.channel.join` | + +指定したチャンネルに参加します． + +### `/lc channel leave` + +| パーミッション | +|----------------------------------------| +| `lunaticchat.command.lc.channel.leave` | + +現在アクティブなチャンネルから退出します． + +### `/lc channel switch <チャンネルID>` + +| パーミッション | +|-----------------------------------------| +| `lunaticchat.command.lc.channel.switch` | + +指定したチャンネルに切り替えます．チャンネルチャットモード中に他のチャンネルに切り替えたい場合に使用します． + +### `/lc channel status` + +| パーミッション | +|-----------------------------------------| +| `lunaticchat.command.lc.channel.status` | + +現在参加・アクティブ状態のチャンネルの情報を表示します． + +### `/lc channel delete <チャンネルID>` + +| パーミッション | +|-----------------------------------------| +| `lunaticchat.command.lc.channel.delete` | + +指定したチャンネルを削除します．チャンネルの作成者(オーナー)である必要があります． + diff --git a/docs/src/reference/commands/lc/chatmode.md b/docs/src/reference/commands/lc/chatmode.md new file mode 100644 index 0000000..659aca5 --- /dev/null +++ b/docs/src/reference/commands/lc/chatmode.md @@ -0,0 +1,17 @@ +# /lc chatmode + +### `/lc chatmode` + +| パーミッション | +|-----------------------------------| +| `lunaticchat.command.lc.chatmode` | + +現在のチャットモードを表示します． + +### `/lc chatmode toggle` + +| パーミッション | +|------------------------------------| +| `lunaticchat.command.lc.chatmode.toggle` | + +チャットモードを切り替えます． diff --git a/docs/src/reference/permissions.md b/docs/src/reference/permissions.md index 0f3cd97..1487990 100644 --- a/docs/src/reference/permissions.md +++ b/docs/src/reference/permissions.md @@ -34,6 +34,12 @@ LunaticChat のアップデート通知を受け取ります． [`/reply`](commands/reply.md) コマンドの使用を切り替えます． +### `lunaticchat.command.lc` + +- Default: `non OP` + +[`/lc`](commands/lc/index.md) コマンドの使用を切り替えます． + ### `lunaticchat.command.lc.settings` - Default: `non OP` @@ -46,6 +52,66 @@ LunaticChat のアップデート通知を受け取ります． [`/lc status`](commands/lc/status.md) コマンドの使用を切り替えます． +### `lunaticchat.command.lc.channel` + +- Default: `non OP` + +[`/lc channel`](commands/lc/channel.md) コマンドの使用を切り替えます． + +### `lunaticchat.command.lc.channel.create` + +- Default: `non OP` + +[`/lc channel create`](commands/lc/channel.md) コマンドの使用を切り替えます． + +### `lunaticchat.command.lc.channel.list` + +- Default: `non OP` + +[`/lc channel list`](commands/lc/channel.md) コマンドの使用を切り替えます． + +### `lunaticchat.command.lc.channel.join` + +- Default: `non OP` + +[`/lc channel join`](commands/lc/channel.md) コマンドの使用を切り替えます． + +### `lunaticchat.command.lc.channel.leave` + +- Default: `non OP` + +[`/lc channel leave`](commands/lc/channel.md) コマンドの使用を切り替えます． + +### `lunaticchat.command.lc.channel.switch` + +- Default: `non OP` + +[`/lc channel switch`](commands/lc/channel.md) コマンドの使用を切り替えます． + +### `lunaticchat.command.lc.channel.status` + +- Default: `non OP` + +[`/lc channel status`](commands/lc/channel.md) コマンドの使用を切り替えます． + +### `lunaticchat.command.lc.channel.delete` + +- Default: `non OP` + +[`/lc channel delete`](commands/lc/channel.md) コマンドの使用を切り替えます． + +### `lunaticchat.command.lc.chatmode` + +- Default: `non OP` + +[`/lc chatmode`](commands/lc/chatmode.md) コマンドの使用を切り替えます． + +### `lunaticchat.command.lc.chatmode.toggle` + +- Default: `non OP` + +[`/lc chatmode toggle`](commands/lc/chatmode.md) コマンドの使用を切り替えます． + ### `lunaticchat.command.jp` - Default: `non OP` -- cgit v1.2.1 From c7714add1934baf55a5e6268b1a70780eaa84fea Mon Sep 17 00:00:00 2001 From: Sho Sakuma Date: Mon, 26 Jan 2026 02:54:11 +0900 Subject: docs: Fix image path --- .../assets/direct-message/minecraft-player-sound.png | Bin 0 -> 1609414 bytes docs/src/en/guide/player/direct-message.md | 2 +- docs/src/en/reference/commands/lc/settings.md | 2 +- docs/src/en/reference/permissions.md | 2 +- docs/src/guide/player/direct-message.md | 2 +- .../public/direct-message/minecraft-player-sound.png | Bin 1609414 -> 0 bytes docs/src/public/favicon.ico | Bin 4286 -> 0 bytes docs/src/public/icon.png | Bin 122601 -> 0 bytes docs/src/reference/commands/lc/settings.md | 8 ++++---- docs/src/reference/permissions.md | 2 +- 10 files changed, 9 insertions(+), 9 deletions(-) create mode 100644 docs/src/assets/direct-message/minecraft-player-sound.png delete mode 100644 docs/src/public/direct-message/minecraft-player-sound.png delete mode 100644 docs/src/public/favicon.ico delete mode 100644 docs/src/public/icon.png (limited to 'docs/src') diff --git a/docs/src/assets/direct-message/minecraft-player-sound.png b/docs/src/assets/direct-message/minecraft-player-sound.png new file mode 100644 index 0000000..56059e5 Binary files /dev/null and b/docs/src/assets/direct-message/minecraft-player-sound.png differ diff --git a/docs/src/en/guide/player/direct-message.md b/docs/src/en/guide/player/direct-message.md index 460de51..64c99b8 100644 --- a/docs/src/en/guide/player/direct-message.md +++ b/docs/src/en/guide/player/direct-message.md @@ -60,6 +60,6 @@ This notification sound depends on the **Players** category volume setting on th If you cannot hear LunaticChat's notification sound, check your client's volume settings. -![](/direct-message/minecraft-player-sound.png) +![](../../../assets/direct-message/minecraft-player-sound.png) ::: diff --git a/docs/src/en/reference/commands/lc/settings.md b/docs/src/en/reference/commands/lc/settings.md index 742e85c..4d09301 100644 --- a/docs/src/en/reference/commands/lc/settings.md +++ b/docs/src/en/reference/commands/lc/settings.md @@ -14,5 +14,5 @@ This setting is saved by UUID, so the setting will not be lost even if you chang | Key | Description | Default Value | |----------|----------------------------------------------------------|--------| -| `jp` | Toggles romanization conversion on or off. | `true` | +| `japanese` | 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/permissions.md b/docs/src/en/reference/permissions.md index 718e5f9..65825c1 100644 --- a/docs/src/en/reference/permissions.md +++ b/docs/src/en/reference/permissions.md @@ -38,7 +38,7 @@ Toggles the use of the [`/reply`](commands/reply.md) command. - Default: `non OP` -Toggles the use of the [`/lc`](commands/lc/index.md) command. +Toggles the use of the `/lc` command. ### `lunaticchat.command.lc.settings` diff --git a/docs/src/guide/player/direct-message.md b/docs/src/guide/player/direct-message.md index b6f1424..8edd16e 100644 --- a/docs/src/guide/player/direct-message.md +++ b/docs/src/guide/player/direct-message.md @@ -60,6 +60,6 @@ v0.4.0 以降，ダイレクトメッセージの通知設定を変更できる LunaticChat の通知音が聞こえない場合は，クライアントの音量設定を確認してください． -![](/direct-message/minecraft-player-sound.png) +![](../../assets/direct-message/minecraft-player-sound.png) ::: diff --git a/docs/src/public/direct-message/minecraft-player-sound.png b/docs/src/public/direct-message/minecraft-player-sound.png deleted file mode 100644 index 56059e5..0000000 Binary files a/docs/src/public/direct-message/minecraft-player-sound.png and /dev/null differ diff --git a/docs/src/public/favicon.ico b/docs/src/public/favicon.ico deleted file mode 100644 index 46c0cad..0000000 Binary files a/docs/src/public/favicon.ico and /dev/null differ diff --git a/docs/src/public/icon.png b/docs/src/public/icon.png deleted file mode 100644 index 064445a..0000000 Binary files a/docs/src/public/icon.png and /dev/null differ diff --git a/docs/src/reference/commands/lc/settings.md b/docs/src/reference/commands/lc/settings.md index 86e0a9d..ab595ef 100644 --- a/docs/src/reference/commands/lc/settings.md +++ b/docs/src/reference/commands/lc/settings.md @@ -12,7 +12,7 @@ LunaticChat のプレイヤー設定を管理します．値を指定しなか #### 利用可能なキー -| キー | 説明 | デフォルト値 | -|----------|----------------------------------------------------------|--------| -| `jp` | ローマ字変換の有効化・無効化を切り替えます． | `true` | -| `notice` | `/tell` や `/reply` でダイレクトメッセージを受信した際に通知を受け取るかどうかを切り替えます． | `true` | +| キー | 説明 | デフォルト値 | +|------------|----------------------------------------------------------|--------| +| `japanese` | ローマ字変換の有効化・無効化を切り替えます． | `true` | +| `notice` | `/tell` や `/reply` でダイレクトメッセージを受信した際に通知を受け取るかどうかを切り替えます． | `true` | diff --git a/docs/src/reference/permissions.md b/docs/src/reference/permissions.md index 1487990..b557ae9 100644 --- a/docs/src/reference/permissions.md +++ b/docs/src/reference/permissions.md @@ -38,7 +38,7 @@ LunaticChat のアップデート通知を受け取ります． - Default: `non OP` -[`/lc`](commands/lc/index.md) コマンドの使用を切り替えます． +`/lc` コマンドの使用を切り替えます． ### `lunaticchat.command.lc.settings` -- cgit v1.2.1