summaryrefslogtreecommitdiff
path: root/docs/src/guide
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src/guide')
-rw-r--r--docs/src/guide/admin/configuration.md21
-rw-r--r--docs/src/guide/player/channel-chat.md13
-rw-r--r--docs/src/guide/player/channel-chat/about.md112
-rw-r--r--docs/src/guide/player/channel-chat/chatmode.md30
-rw-r--r--docs/src/guide/player/direct-message.md2
5 files changed, 164 insertions, 14 deletions
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 ce5a43e..0000000
--- a/docs/src/guide/player/channel-chat.md
+++ /dev/null
@@ -1,13 +0,0 @@
-# チャンネルチャット <Badge type="tip" text="v0.6.0" /> <Badge type="warning" text="試験的" />
-
-特定のプレイヤー間で,チャットを共有できる機能です.
-
-::: warning 試験的機能
-
-この機能は現在,試験的に実装されており,今後のアップデートで仕様が変更される可能性があります.
-
-規模が大きい機能なので,一気に実装はせず段階的な展開を予定しています.
-
-詳しい実装計画は [ロードマップ (m1sk9/LunaticChat #54)](https://github.com/m1sk9/LunaticChat/issues/54) をご覧ください.
-
-:::
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 @@
+# チャンネルチャット <Badge type="tip" text="v0.6.0" /> <Badge type="warning" text="試験的" />
+
+特定のプレイヤー間で,チャットを共有できる機能です.
+
+::: 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/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)
:::