diff options
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/admin-guide/cache.md (renamed from docs/src/guide/admin/cache.md) | 2 | ||||
| -rw-r--r-- | docs/src/admin-guide/channel-chat/introduction.md (renamed from docs/src/guide/admin/channel-chat/introduction.md) | 4 | ||||
| -rw-r--r-- | docs/src/admin-guide/channel-chat/logs.md (renamed from docs/src/guide/admin/channel-chat/logs.md) | 2 | ||||
| -rw-r--r-- | docs/src/admin-guide/configuration.md (renamed from docs/src/guide/admin/configuration.md) | 20 | ||||
| -rw-r--r-- | docs/src/admin-guide/getting-started.md (renamed from docs/src/guide/getting-started.md) | 28 | ||||
| -rw-r--r-- | docs/src/admin-guide/management-data.md (renamed from docs/src/guide/admin/management-data.md) | 59 | ||||
| -rw-r--r-- | docs/src/admin-guide/permissions.md | 179 | ||||
| -rw-r--r-- | docs/src/admin-guide/velocity.md (renamed from docs/src/guide/admin/velocity.md) | 18 | ||||
| -rw-r--r-- | docs/src/en/admin-guide/cache.md (renamed from docs/src/en/guide/admin/cache.md) | 4 | ||||
| -rw-r--r-- | docs/src/en/admin-guide/channel-chat/introduction.md (renamed from docs/src/en/guide/admin/channel-chat/introduction.md) | 4 | ||||
| -rw-r--r-- | docs/src/en/admin-guide/channel-chat/logs.md (renamed from docs/src/en/guide/admin/channel-chat/logs.md) | 2 | ||||
| -rw-r--r-- | docs/src/en/admin-guide/configuration.md (renamed from docs/src/en/guide/admin/configuration.md) | 20 | ||||
| -rw-r--r-- | docs/src/en/admin-guide/getting-started.md (renamed from docs/src/en/guide/getting-started.md) | 14 | ||||
| -rw-r--r-- | docs/src/en/admin-guide/management-data.md (renamed from docs/src/en/guide/admin/management-data.md) | 59 | ||||
| -rw-r--r-- | docs/src/en/admin-guide/permissions.md | 179 | ||||
| -rw-r--r-- | docs/src/en/admin-guide/velocity.md (renamed from docs/src/en/guide/admin/velocity.md) | 10 | ||||
| -rw-r--r-- | docs/src/en/guide/player/channel-chat.md | 13 | ||||
| -rw-r--r-- | docs/src/en/index.md | 18 | ||||
| -rw-r--r-- | docs/src/en/player-guide/about.md (renamed from docs/src/en/guide/about.md) | 20 | ||||
| -rw-r--r-- | docs/src/en/player-guide/channel-chat/about.md (renamed from docs/src/en/guide/player/channel-chat/about.md) | 12 | ||||
| -rw-r--r-- | docs/src/en/player-guide/channel-chat/chatmode.md (renamed from docs/src/en/guide/player/channel-chat/chatmode.md) | 0 | ||||
| -rw-r--r-- | docs/src/en/player-guide/channel-chat/moderation.md (renamed from docs/src/en/guide/player/channel-chat/moderation.md) | 14 | ||||
| -rw-r--r-- | docs/src/en/player-guide/channel-chat/private-channel.md (renamed from docs/src/en/guide/player/channel-chat/private-channel.md) | 4 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/jp.md (renamed from docs/src/en/reference/commands/jp.md) | 4 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/lc/channel.md (renamed from docs/src/en/reference/commands/lc/channel.md) | 34 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/lc/chatmode.md (renamed from docs/src/en/reference/commands/lc/chatmode.md) | 8 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/lc/settings.md | 19 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/lc/status.md (renamed from docs/src/en/reference/commands/lc/status.md) | 4 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/lcv/status.md (renamed from docs/src/en/reference/commands/lcv/status.md) | 4 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/notice.md (renamed from docs/src/en/reference/commands/notice.md) | 4 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/reply.md (renamed from docs/src/en/reference/commands/reply.md) | 6 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/tell.md (renamed from docs/src/en/reference/commands/tell.md) | 4 | ||||
| -rw-r--r-- | docs/src/en/player-guide/direct-message.md (renamed from docs/src/en/guide/player/direct-message.md) | 8 | ||||
| -rw-r--r-- | docs/src/en/player-guide/getting-started.md | 77 | ||||
| -rw-r--r-- | docs/src/en/player-guide/index.md (renamed from docs/src/en/reference/index.md) | 2 | ||||
| -rw-r--r-- | docs/src/en/player-guide/japanese-romanization.md (renamed from docs/src/en/guide/player/japanese-romanization.md) | 4 | ||||
| -rw-r--r-- | docs/src/en/reference/commands/lc/settings.md | 19 | ||||
| -rw-r--r-- | docs/src/en/reference/permissions.md | 179 | ||||
| -rw-r--r-- | docs/src/index.md | 18 | ||||
| -rw-r--r-- | docs/src/player-guide/about.md (renamed from docs/src/guide/about.md) | 20 | ||||
| -rw-r--r-- | docs/src/player-guide/channel-chat/about.md (renamed from docs/src/guide/player/channel-chat/about.md) | 12 | ||||
| -rw-r--r-- | docs/src/player-guide/channel-chat/chatmode.md (renamed from docs/src/guide/player/channel-chat/chatmode.md) | 0 | ||||
| -rw-r--r-- | docs/src/player-guide/channel-chat/moderation.md (renamed from docs/src/guide/player/channel-chat/moderation.md) | 16 | ||||
| -rw-r--r-- | docs/src/player-guide/channel-chat/private-channel.md (renamed from docs/src/guide/player/channel-chat/private-channel.md) | 4 | ||||
| -rw-r--r-- | docs/src/player-guide/commands/lc/channel.md (renamed from docs/src/reference/commands/lc/channel.md) | 64 | ||||
| -rw-r--r-- | docs/src/player-guide/commands/lc/chatmode.md (renamed from docs/src/reference/commands/lc/chatmode.md) | 10 | ||||
| -rw-r--r-- | docs/src/player-guide/commands/lc/settings.md (renamed from docs/src/reference/commands/lc/settings.md) | 16 | ||||
| -rw-r--r-- | docs/src/player-guide/commands/lc/status.md (renamed from docs/src/reference/commands/lc/status.md) | 6 | ||||
| -rw-r--r-- | docs/src/player-guide/commands/lcv/status.md (renamed from docs/src/reference/commands/lcv/status.md) | 4 | ||||
| -rw-r--r-- | docs/src/player-guide/commands/reply.md (renamed from docs/src/reference/commands/reply.md) | 10 | ||||
| -rw-r--r-- | docs/src/player-guide/commands/tell.md (renamed from docs/src/reference/commands/tell.md) | 6 | ||||
| -rw-r--r-- | docs/src/player-guide/direct-message.md (renamed from docs/src/guide/player/direct-message.md) | 8 | ||||
| -rw-r--r-- | docs/src/player-guide/getting-started.md | 77 | ||||
| -rw-r--r-- | docs/src/player-guide/index.md (renamed from docs/src/reference/index.md) | 3 | ||||
| -rw-r--r-- | docs/src/player-guide/japanese-romanization.md (renamed from docs/src/guide/player/japanese-romanization.md) | 4 | ||||
| -rw-r--r-- | docs/src/reference/commands/jp.md | 17 | ||||
| -rw-r--r-- | docs/src/reference/commands/notice.md | 17 | ||||
| -rw-r--r-- | docs/src/reference/permissions.md | 179 |
58 files changed, 823 insertions, 729 deletions
diff --git a/docs/src/guide/admin/cache.md b/docs/src/admin-guide/cache.md index afacac5..b1a6754 100644 --- a/docs/src/guide/admin/cache.md +++ b/docs/src/admin-guide/cache.md @@ -2,7 +2,7 @@ LunaticChat では,かな・ローマ字変換時のフレーズを自動でメモリ・ディスクにキャッシュするシステムが搭載されています. -かな・ローマ字変換に関する情報は [こちら](../player/japanese-romanization.md) をご覧ください. +かな・ローマ字変換に関する情報は [こちら](../player-guide/japanese-romanization.md) をご覧ください. ## メモリキャッシュ diff --git a/docs/src/guide/admin/channel-chat/introduction.md b/docs/src/admin-guide/channel-chat/introduction.md index cf9fe52..559283c 100644 --- a/docs/src/guide/admin/channel-chat/introduction.md +++ b/docs/src/admin-guide/channel-chat/introduction.md @@ -6,7 +6,7 @@ プレイヤー間でチャンネルを作成し,特定のプレイヤー間で,チャットを共有できる機能です. -詳しい機能については [プレイヤー向けガイド版](../../player/channel-chat/about.md) を参照してください. +詳しい機能については [プレイヤー向けガイド版](../../player-guide/channel-chat/about.md) を参照してください. ## チャンネルチャットの展開準備 @@ -57,7 +57,7 @@ LunaticChat では,チャンネルチャット機能に限り v0.7.0 以降 Co ## チャンネルの管理 -基本的に,[チャンネルの管理はプレイヤー自身が行います](../../player/channel-chat/moderation.md). +基本的に,[チャンネルの管理はプレイヤー自身が行います](../../player-guide/channel-chat/moderation.md). ただし,サーバー管理者として,以下の点に注意してください: diff --git a/docs/src/guide/admin/channel-chat/logs.md b/docs/src/admin-guide/channel-chat/logs.md index 9b88bdd..df09169 100644 --- a/docs/src/guide/admin/channel-chat/logs.md +++ b/docs/src/admin-guide/channel-chat/logs.md @@ -1,4 +1,4 @@ -# チャンネルチャット: ログ <Badge type="tip" text="v0.7.0" /> +# チャンネルチャット: ログ <Badge type="tip" text="v0.7.0" /> チャンネルチャットのログは,チャット内で行われたすべてのメッセージとアクティビティの記録です. diff --git a/docs/src/guide/admin/configuration.md b/docs/src/admin-guide/configuration.md index b641549..dfe8094 100644 --- a/docs/src/guide/admin/configuration.md +++ b/docs/src/admin-guide/configuration.md @@ -20,13 +20,13 @@ debug: false # Path to the YAML file storing player settings -userSettingsFilePath: "player-settings.yaml" +userSettingsFilePath: 'player-settings.yaml' # If enabled, LunaticChat will check for updates on startup. checkForUpdates: true # Plugin Configuration Language. This setting applies only to player feedback and does not affect plugin logs or similar outputs. -language: "en" +language: 'en' # ---------------------------------------------- # ----------- Features Settings ------------ @@ -45,7 +45,7 @@ features: # Specify the interval (in seconds) for saving the Romanization conversion cache to disk. saveIntervalSeconds: 300 # Specify the file path where the cache for Romanization conversion is saved. - filePath: "conversion_cache.json" + filePath: 'conversion_cache.json' api: # Specify the timeout duration (in milliseconds) for API requests to the Romanization conversion service. timeout: 3000 @@ -77,7 +77,7 @@ features: crossServerGlobalChat: false # Server name to display in cross-server chat (e.g., "survival", "creative", "lobby"). # This should match the server name defined in your Velocity configuration. - serverName: "Unknown" + serverName: 'Unknown' # Size of the message deduplication cache to prevent duplicate messages from appearing. # Keeps track of the most recent N message IDs to filter out duplicates. messageDeduplicationCacheSize: 100 @@ -98,11 +98,11 @@ features: messageFormat: # Configure the format for direct messages sent via /tell or /msg - directMessageFormat: "§7[§e{sender} §7>> §e{recipient}§7] §f{message}" + 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}" + channelMessageFormat: '§7[§b#{channel}§7] §e{sender}: §f{message}' # Configure the format for global chat messages in Velocity integration - crossServerGlobalChatFormat: "§7[§6{server}§7] §e{sender}: §f{message}" + crossServerGlobalChatFormat: '§7[§6{server}§7] §e{sender}: §f{message}' ``` ## General Settings @@ -147,9 +147,9 @@ LunaticChat のプレイヤー向けメッセージの言語を指定しますï¼ - Type: `boolean` - Default: `true` -LunaticChat の [`/reply`](../../reference/commands/reply.md) コマンドによるクイックリプライ機能を有効にします. +LunaticChat の [`/reply`](../player-guide/commands/reply.md) コマンドによるクイックリプライ機能を有効にします. -無効にすると [`/reply`](../../reference/commands/reply.md) コマンドは Paper に登録されず,使用できなくなります. +無効にすると [`/reply`](../player-guide/commands/reply.md) コマンドは Paper に登録されず,使用できなくなります. ### `features.japaneseConversion.enabled` @@ -308,7 +308,7 @@ Velocity クロスサーバーチャットで表示されるサーバー名をæŒ - Type: `string` - Default: `§7[§e{sender} §7>> §e{recipient}§7] §f{message}` -ダイレクトメッセージ( [`/tell`](../../reference/commands/tell.md) や [`/reply`](../../reference/commands/reply.md) コマンド)で送信されるメッセージのフォーマットを指定します. +ダイレクトメッセージ( [`/tell`](../player-guide/commands/tell.md) や [`/reply`](../player-guide/commands/reply.md) コマンド)で送信されるメッセージのフォーマットを指定します. ### `messageFormat.channelMessageFormat` diff --git a/docs/src/guide/getting-started.md b/docs/src/admin-guide/getting-started.md index 83b125f..9254f33 100644 --- a/docs/src/guide/getting-started.md +++ b/docs/src/admin-guide/getting-started.md @@ -6,7 +6,9 @@ LunaticChat を使用するには,以下のソフトウェアが必要ですï¼ - Java 21 (LTS 以降) - Paper 1.21 以降 - - 最新版は [こちら](https://papermc.io/downloads/paper), それ以降のバージョンは [こちら](https://fill-ui.papermc.io/projects/paper/family/1.21) から入手できます. + - または Folia 1.21 以降 + +最新版は [こちら](https://papermc.io/downloads/paper), それ以降のバージョンは [こちら](https://fill-ui.papermc.io/projects/paper/family/1.21) から入手できます. ::: warning Spigot 系プラットフォームでの動作について @@ -14,14 +16,6 @@ LunaticChat は Paper プラグインです.Spigot / Bukkit / CraftBukkit でã ::: -::: tip Folia のサポートについて - -Folia は現在サポートされていません.将来的に対応する可能性がありますが,現時点では Folia 上での動作は保証されていません. - -詳しくは [Folia Support (m1sk9/LunaticChat #42)](https://github.com/m1sk9/LunaticChat/issues/42) を参照してください. - -::: - ## インストール LunaticChat をインストールします.LunaticChat は以下から入手できます: @@ -35,7 +29,7 @@ LunaticChat をインストールします.LunaticChat は以下から入手ã� LunaticChat を起動すると設定ファイル `config.yml` が作成されます. -該当のファイルを開き,初期設定を変更してください.なお,全設定項目の詳細については,[設定ガイド](admin/configuration.md)を参照してください. +該当のファイルを開き,初期設定を変更してください.なお,全設定項目の詳細については,[設定ガイド](./configuration.md)を参照してください. ### 推奨する初期設定 @@ -59,10 +53,10 @@ LunaticChat を起動すると設定ファイル `config.yml` が作成されま LunaticChat のパーミッションを LuckPerms などのパーミッション管理プラグインで設定します. -基本的なパーミッションは Paper や Velocity のデフォルトパーミッションシステム ( `OP` / `non OP` ) でも使用できるように開発されていますが,より詳細な制御を行う場合は LuckPerms の使用を推奨します. +基本的なパーミッションは Paper, Folia や Velocity のデフォルトパーミッションシステム ( `OP` / `non OP` ) でも使用できるように開発されていますが,より詳細な制御を行う場合は LuckPerms の使用を推奨します. -- パーミッションノードの詳細については [パーミッションガイド](../reference/permissions.md)を参照してください. -- コマンドの各機能に対応するパーミッションノードは,[コマンドリファレンス](../reference/index.md)を参照してください. +- パーミッションノードの詳細については [パーミッションガイド](./permissions.md)を参照してください. +- コマンドの各機能に対応するパーミッションノードは,[コマンドリファレンス](../player-guide/index.md)を参照してください. ## サーバーの再起動 @@ -72,7 +66,7 @@ LunaticChat のパーミッションを LuckPerms などのパーミッション ## 次は? -- [キャッシュシステム](./admin/cache.md): LunaticChat のキャッシュシステムについて説明します. -- [チャンネルチャット](./admin/channel-chat/introduction.md): チャンネルチャット機能の概要を説明します. -- [コマンド一覧](../reference/index.md): LunaticChat のコマンド一覧を確認します. -- [パーミッション一覧](../reference/permissions.md): LunaticChat のパーミッションノード一覧を確認します. +- [キャッシュシステム](./cache.md): LunaticChat のキャッシュシステムについて説明します. +- [チャンネルチャット](./channel-chat/introduction.md): チャンネルチャット機能の概要を説明します. +- [コマンド一覧](../player-guide/index.md): LunaticChat のコマンド一覧を確認します. +- [パーミッション一覧](./permissions.md): LunaticChat のパーミッションノード一覧を確認します. diff --git a/docs/src/guide/admin/management-data.md b/docs/src/admin-guide/management-data.md index 5527ffa..e557894 100644 --- a/docs/src/guide/admin/management-data.md +++ b/docs/src/admin-guide/management-data.md @@ -27,30 +27,28 @@ LunaticChat のデータの安全性を確保するために,定期的にバム```json { - "channels": { - "general-channel": { - "id": "general-channel", - "name": "一般チャンネル", - "ownerId": "a01e3843-e521-3998-958a-f459800e4d11", - "createdAt": 1769507213150, - "bannedPlayers": [ - "ceaea267-39dd-3bac-931c-761ada671ebe" - ] - } - }, - "members": { - "general-channel": [ - { - "channelId": "test2", - "playerId": "a01e3843-e521-3998-958a-f459800e4d11", - "role": "OWNER", - "joinedAt": 1769507213150 - } - ] - }, - "activeChannels": { - "a01e3843-e521-3998-958a-f459800e4d11": "test2" + "channels": { + "general-channel": { + "id": "general-channel", + "name": "一般チャンネル", + "ownerId": "a01e3843-e521-3998-958a-f459800e4d11", + "createdAt": 1769507213150, + "bannedPlayers": ["ceaea267-39dd-3bac-931c-761ada671ebe"] } + }, + "members": { + "general-channel": [ + { + "channelId": "test2", + "playerId": "a01e3843-e521-3998-958a-f459800e4d11", + "role": "OWNER", + "joinedAt": 1769507213150 + } + ] + }, + "activeChannels": { + "a01e3843-e521-3998-958a-f459800e4d11": "test2" + } } ``` @@ -75,9 +73,8 @@ LunaticChat のデータの安全性を確保するために,定期的にバムキャッシュシステムに関する詳細は [こちら](./cache.md) をご覧ください. - ```json -{"version":"1","entries":{"hi":"日"}} +{ "version": "1", "entries": { "hi": "日" } } ``` ### `player-settings.yaml` @@ -87,13 +84,13 @@ LunaticChat のデータの安全性を確保するために,定期的にバム```yaml version: 1 japaneseConversion: - "aed5efd4-551b-3965-bc28-ae21aa072a66": false - "ceaea267-39dd-3bac-931c-761ada671ebe": false + 'aed5efd4-551b-3965-bc28-ae21aa072a66': false + 'ceaea267-39dd-3bac-931c-761ada671ebe': false directMessageNotification: - "aed5efd4-551b-3965-bc28-ae21aa072a66": true - "ceaea267-39dd-3bac-931c-761ada671ebe": true + 'aed5efd4-551b-3965-bc28-ae21aa072a66': true + 'ceaea267-39dd-3bac-931c-761ada671ebe': true channelMessageNotification: - "ceaea267-39dd-3bac-931c-761ada671ebe": true + 'ceaea267-39dd-3bac-931c-761ada671ebe': true ``` ## キャッシュバージョン @@ -103,5 +100,5 @@ channelMessageNotification: バージョンが不一致の場合,LunaticChat はキャッシュファイルを **古い形式のキャッシュ** として認識し,内容を無視して新しい形式で再作成します. ```json -{"version":"1","entries":{}} +{ "version": "1", "entries": {} } ``` diff --git a/docs/src/admin-guide/permissions.md b/docs/src/admin-guide/permissions.md new file mode 100644 index 0000000..a50d218 --- /dev/null +++ b/docs/src/admin-guide/permissions.md @@ -0,0 +1,179 @@ +# パーミッション + +LuckPerms を使用した設定方法に関する詳細は [LuckPerms Wiki](https://luckperms.net/wiki/Home) を参照してください. + +## `lunaticchat.*` + +### `lunaticchat.spy` + +- Default: `OP` + +各種プレイヤー間のやり取りを可視化します. + +この権限を持つプレイヤーは他プレイヤーの [`/tell`](../player-guide/commands/tell.md) / [`/reply`](../player-guide/commands/reply.md) でのメッセージ・全チャンネルチャットがブロードキャストされます. + +### `lunaticchat.noticeUpdate` + +- Default: `OP` + +LunaticChat のアップデート通知を受け取ります. + +[受け取るには `checkForUpdates` を有効にしておく](./configuration.md#checkforupdates) 必要があります. + +### `lunaticchat.channelbypass` + +- Default: `OP` + +各チャンネルのモデレート機能やプライベートチャンネルに対する制限を無視します. + +## `lunaticchat.command.*` + +### `lunaticchat.command.tell` + +- Default: `non OP` + +[`/tell`](../player-guide/commands/tell.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.reply` + +- Default: `non OP` + +[`/reply`](../player-guide/commands/reply.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc` + +- Default: `non OP` + +`/lc` コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.settings` + +- Default: `non OP` + +[`/lc settings`](../player-guide/commands/lc/settings.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.status` + +- Default: `non OP` + +[`/lc status`](../player-guide/commands/lc/status.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.channel` + +- Default: `non OP` + +[`/lc channel`](../player-guide/commands/lc/channel.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.channel.create` + +- Default: `non OP` + +[`/lc channel create`](../player-guide/commands/lc/channel.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.channel.list` + +- Default: `non OP` + +[`/lc channel list`](../player-guide/commands/lc/channel.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.channel.join` + +- Default: `non OP` + +[`/lc channel join`](../player-guide/commands/lc/channel.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.channel.leave` + +- Default: `non OP` + +[`/lc channel leave`](../player-guide/commands/lc/channel.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.channel.switch` + +- Default: `non OP` + +[`/lc channel switch`](../player-guide/commands/lc/channel.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.channel.status` + +- Default: `non OP` + +[`/lc channel status`](../player-guide/commands/lc/channel.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.channel.info` + +- Default: `non OP` + +[`/lc channel info`](../player-guide/commands/lc/channel.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.channel.delete` + +- Default: `non OP` + +[`/lc channel delete`](../player-guide/commands/lc/channel.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.channel.invite` + +- Default: `non OP` + +[`/lc channel invite`](../player-guide/commands/lc/channel.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.channel.kick` + +- Default: `non OP` + +[`/lc channel kick`](../player-guide/commands/lc/channel.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.channel.ban` + +- Default: `non OP` + +[`/lc channel ban`](../player-guide/commands/lc/channel.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.channel.unban` + +- Default: `non OP` + +[`/lc channel unban`](../player-guide/commands/lc/channel.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.channel.mod` + +- Default: `non OP` + +[`/lc channel mod`](../player-guide/commands/lc/channel.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.channel.ownership` + +- Default: `non OP` + +[`/lc channel ownership`](../player-guide/commands/lc/channel.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.chatmode` + +- Default: `non OP` + +[`/lc chatmode`](../player-guide/commands/lc/chatmode.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lc.chatmode.toggle` + +- Default: `non OP` + +[`/lc chatmode toggle`](../player-guide/commands/lc/chatmode.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.lcv.status` + +- Default: `OP` + +[`/lcv status`](../player-guide/commands/lcv/status.md) コマンドの使用を切り替えます. + +### `lunaticchat.command.jp` <Badge type="danger" text="非推奨: v1.0.0 で削除予定" /> + +- Default: `non OP` + +`/jp` コマンドの使用を切り替えます. + +### `lunaticchat.command.notice` <Badge type="danger" text="非推奨: v1.0.0 で削除予定" /> + +- Default: `non OP` + +`/notice` コマンドの使用を切り替えます. diff --git a/docs/src/guide/admin/velocity.md b/docs/src/admin-guide/velocity.md index 2b07ddb..b3652de 100644 --- a/docs/src/guide/admin/velocity.md +++ b/docs/src/admin-guide/velocity.md @@ -8,6 +8,14 @@ Velocity を使用して,プロキシサーバーを繋いだ Paper サーバã ::: +::: warning Folia との互換性 + +Velocity 連携機能は Folia とは互換性がありません. + +Folia を使用している場合は Velocity 連携機能を使用できません. + +::: + ## 連携機能を有効化する Velocity 連携を有効化するには以下の手順を行います: @@ -72,8 +80,8 @@ Velocity 連携が有効化されている場合,プロキシサーバーをä» Velocity 連携中に利用可能な主な機能は以下の通りです: -| | 互換性の有無 | 挙動 | 備考 | -|------------|--------|-----------------------------------|-----------------------------------| -| ダイレクトメッセージ | × | `/tell`, `/reply` コマンドはサーバー内限定で動作 | ダイレクトメッセージは Velocity 連携に対応していません. | -| チャンネルチャット | × | チャンネルチャットはサーバー内限定で動作 | チャンネルチャットは Velocity 連携に対応していません. | -| かな・ローマ字変換 | ◯ | かな・ローマ字変換は全サーバーで動作 | | +| | 互換性の有無 | 挙動 | 備考 | +| -------------------- | ------------ | ------------------------------------------------ | -------------------------------------------------------- | +| ダイレクトメッセージ | × | `/tell`, `/reply` コマンドはサーバー内限定で動作 | ダイレクトメッセージは Velocity 連携に対応していません. | +| チャンネルチャット | × | チャンネルチャットはサーバー内限定で動作 | チャンネルチャットは Velocity 連携に対応していません. | +| かな・ローマ字変換 | ◯ | かな・ローマ字変換は全サーバーで動作 | | diff --git a/docs/src/en/guide/admin/cache.md b/docs/src/en/admin-guide/cache.md index 2fa2802..5142a9e 100644 --- a/docs/src/en/guide/admin/cache.md +++ b/docs/src/en/admin-guide/cache.md @@ -2,7 +2,7 @@ LunaticChat includes a system that automatically caches phrases from Japanese romanization conversion to both memory and disk. -For information on Japanese romanization conversion, see [here](../player/japanese-romanization.md). +For information on Japanese romanization conversion, see [here](../player-guide/japanese-romanization.md). ## Memory Cache @@ -37,5 +37,5 @@ The file used for disk cache includes a `version` field, which handles changes t If the version does not match, LunaticChat recognizes the cache file as **an old format cache**, ignores its contents, and recreates it in the new format. ```json -{"version":"1","entries":{}} +{ "version": "1", "entries": {} } ``` diff --git a/docs/src/en/guide/admin/channel-chat/introduction.md b/docs/src/en/admin-guide/channel-chat/introduction.md index e755139..c87be1b 100644 --- a/docs/src/en/guide/admin/channel-chat/introduction.md +++ b/docs/src/en/admin-guide/channel-chat/introduction.md @@ -6,7 +6,7 @@ This guide explains how to deploy channel chat. Channel chat is a feature that allows players to create channels and share chat among specific players. -For detailed features, please refer to the [Player Guide](../../player/channel-chat/about.md). +For detailed features, please refer to the [Player Guide](../../player-guide/channel-chat/about.md). ## Preparing to Deploy Channel Chat @@ -57,7 +57,7 @@ For more details, see [Channel Chat: Logs](logs.md). ## Channel Management -Basically, [players manage channels themselves](../../player/channel-chat/moderation.md). +Basically, [players manage channels themselves](../../player-guide/channel-chat/moderation.md). However, as a server administrator, please note the following: diff --git a/docs/src/en/guide/admin/channel-chat/logs.md b/docs/src/en/admin-guide/channel-chat/logs.md index b65750b..632a572 100644 --- a/docs/src/en/guide/admin/channel-chat/logs.md +++ b/docs/src/en/admin-guide/channel-chat/logs.md @@ -1,4 +1,4 @@ -# Channel Chat: Logs <Badge type="tip" text="v0.7.0" /> +# Channel Chat: Logs <Badge type="tip" text="v0.7.0" /> Channel chat logs are a record of all messages and activities that occur within the chat. diff --git a/docs/src/en/guide/admin/configuration.md b/docs/src/en/admin-guide/configuration.md index 15c8f10..61d99ef 100644 --- a/docs/src/en/guide/admin/configuration.md +++ b/docs/src/en/admin-guide/configuration.md @@ -20,13 +20,13 @@ debug: false # Path to the YAML file storing player settings -userSettingsFilePath: "player-settings.yaml" +userSettingsFilePath: 'player-settings.yaml' # If enabled, LunaticChat will check for updates on startup. checkForUpdates: true # Plugin Configuration Language. This setting applies only to player feedback and does not affect plugin logs or similar outputs. -language: "en" +language: 'en' # ---------------------------------------------- # ----------- Features Settings ------------ @@ -45,7 +45,7 @@ features: # Specify the interval (in seconds) for saving the Romanization conversion cache to disk. saveIntervalSeconds: 300 # Specify the file path where the cache for Romanization conversion is saved. - filePath: "conversion_cache.json" + filePath: 'conversion_cache.json' api: # Specify the timeout duration (in milliseconds) for API requests to the Romanization conversion service. timeout: 3000 @@ -77,7 +77,7 @@ features: crossServerGlobalChat: false # Server name to display in cross-server chat (e.g., "survival", "creative", "lobby"). # This should match the server name defined in your Velocity configuration. - serverName: "Unknown" + serverName: 'Unknown' # Size of the message deduplication cache to prevent duplicate messages from appearing. # Keeps track of the most recent N message IDs to filter out duplicates. messageDeduplicationCacheSize: 100 @@ -98,11 +98,11 @@ features: messageFormat: # Configure the format for direct messages sent via /tell or /msg - directMessageFormat: "§7[§e{sender} §7>> §e{recipient}§7] §f{message}" + 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}" + channelMessageFormat: '§7[§b#{channel}§7] §e{sender}: §f{message}' # Configure the format for global chat messages in Velocity integration - crossServerGlobalChatFormat: "§7[§6{server}§7] §e{sender}: §f{message}" + crossServerGlobalChatFormat: '§7[§6{server}§7] §e{sender}: §f{message}' ``` ## General Settings @@ -147,9 +147,9 @@ Specifies the language for LunaticChat's player-facing messages. - Type: `boolean` - Default: `true` -Enables the quick reply feature via the [`/reply`](../../reference/commands/reply.md) command in LunaticChat. +Enables the quick reply feature via the [`/reply`](../player-guide/commands/reply.md) command in LunaticChat. -When disabled, the [`/reply`](../../reference/commands/reply.md) command will not be registered with Paper and cannot be used. +When disabled, the [`/reply`](../player-guide/commands/reply.md) command will not be registered with Paper and cannot be used. ### `features.japaneseConversion.enabled` @@ -309,7 +309,7 @@ Available placeholders: - Type: `string` - 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). +Specifies the format for messages sent via direct message ([`/tell`](../player-guide/commands/tell.md) or [`/reply`](../player-guide/commands/reply.md) commands). ### `messageFormat.channelMessageFormat` diff --git a/docs/src/en/guide/getting-started.md b/docs/src/en/admin-guide/getting-started.md index e7aaf2d..c7654a0 100644 --- a/docs/src/en/guide/getting-started.md +++ b/docs/src/en/admin-guide/getting-started.md @@ -17,7 +17,7 @@ When LunaticChat starts, the following files will be created: - `plugins/LunaticChat/player-settings.yaml`: User-specific settings file - `plugins/LunaticChat/conversion_cache.json`: Romanization conversion cache file -Open the configuration file `config.yml` and modify the settings as needed. For details on configuration options, refer to the [Configuration Guide](admin/configuration.md). +Open the configuration file `config.yml` and modify the settings as needed. For details on configuration options, refer to the [Configuration Guide](./configuration.md). ## Permissions @@ -25,8 +25,8 @@ Set LunaticChat's permissions using a permission management plugin like LuckPerm Basic permissions can be configured using Paper or Velocity's default permission system (`OP` / `non OP`), but LuckPerms is recommended for more detailed control. -- For details on permission nodes, refer to the [Permissions Guide](../reference/permissions.md). -- For permission nodes corresponding to each command feature, refer to the [Command Reference](../reference/index.md). +- For details on permission nodes, refer to the [Permissions Guide](./permissions.md). +- For permission nodes corresponding to each command feature, refer to the [Command Reference](../player-guide/index.md). ## Restart the server @@ -36,7 +36,7 @@ This completes the basic setup of LunaticChat. ## What's next? -- [Cache System](./admin/cache.md): Explains LunaticChat's cache system. -- [Channel Chat](./admin/channel-chat/introduction.md): Overview of the channel chat feature. -- [Command List](../reference/index.md): View the list of LunaticChat commands. -- [Permissions List](../reference/permissions.md): View LunaticChat's permission nodes. +- [Cache System](./cache.md): Explains LunaticChat's cache system. +- [Channel Chat](./channel-chat/introduction.md): Overview of the channel chat feature. +- [Command List](../player-guide/index.md): View the list of LunaticChat commands. +- [Permissions List](./permissions.md): View LunaticChat's permission nodes. diff --git a/docs/src/en/guide/admin/management-data.md b/docs/src/en/admin-guide/management-data.md index ffed59d..3f09506 100644 --- a/docs/src/en/guide/admin/management-data.md +++ b/docs/src/en/admin-guide/management-data.md @@ -27,30 +27,28 @@ The `channels.json` file stores information about channels managed by LunaticCha ```json { - "channels": { - "general-channel": { - "id": "general-channel", - "name": "General Channel", - "ownerId": "a01e3843-e521-3998-958a-f459800e4d11", - "createdAt": 1769507213150, - "bannedPlayers": [ - "ceaea267-39dd-3bac-931c-761ada671ebe" - ] - } - }, - "members": { - "general-channel": [ - { - "channelId": "test2", - "playerId": "a01e3843-e521-3998-958a-f459800e4d11", - "role": "OWNER", - "joinedAt": 1769507213150 - } - ] - }, - "activeChannels": { - "a01e3843-e521-3998-958a-f459800e4d11": "test2" + "channels": { + "general-channel": { + "id": "general-channel", + "name": "General Channel", + "ownerId": "a01e3843-e521-3998-958a-f459800e4d11", + "createdAt": 1769507213150, + "bannedPlayers": ["ceaea267-39dd-3bac-931c-761ada671ebe"] } + }, + "members": { + "general-channel": [ + { + "channelId": "test2", + "playerId": "a01e3843-e521-3998-958a-f459800e4d11", + "role": "OWNER", + "joinedAt": 1769507213150 + } + ] + }, + "activeChannels": { + "a01e3843-e521-3998-958a-f459800e4d11": "test2" + } } ``` @@ -75,9 +73,8 @@ The `conversion_cache.json` file stores cache for channel conversion. This file For more information about the cache system, see [here](./cache.md). - ```json -{"version":"1","entries":{"hi":"日"}} +{ "version": "1", "entries": { "hi": "日" } } ``` ### `player-settings.yaml` @@ -87,13 +84,13 @@ The `player-settings.yaml` file stores player-specific settings. This file conta ```yaml version: 1 japaneseConversion: - "aed5efd4-551b-3965-bc28-ae21aa072a66": false - "ceaea267-39dd-3bac-931c-761ada671ebe": false + 'aed5efd4-551b-3965-bc28-ae21aa072a66': false + 'ceaea267-39dd-3bac-931c-761ada671ebe': false directMessageNotification: - "aed5efd4-551b-3965-bc28-ae21aa072a66": true - "ceaea267-39dd-3bac-931c-761ada671ebe": true + 'aed5efd4-551b-3965-bc28-ae21aa072a66': true + 'ceaea267-39dd-3bac-931c-761ada671ebe': true channelMessageNotification: - "ceaea267-39dd-3bac-931c-761ada671ebe": true + 'ceaea267-39dd-3bac-931c-761ada671ebe': true ``` ## Cache Version @@ -103,5 +100,5 @@ Files used for disk caching include a `version` field to accommodate changes in If the version does not match, LunaticChat recognizes the cache file as **old format cache**, ignores the contents, and recreates it in the new format. ```json -{"version":"1","entries":{}} +{ "version": "1", "entries": {} } ``` diff --git a/docs/src/en/admin-guide/permissions.md b/docs/src/en/admin-guide/permissions.md new file mode 100644 index 0000000..6bb8172 --- /dev/null +++ b/docs/src/en/admin-guide/permissions.md @@ -0,0 +1,179 @@ +# 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`](../player-guide/commands/tell.md) / [`/reply`](../player-guide/commands/reply.md) commands. + +Players with this permission will have messages from other players' [`/tell`](../player-guide/commands/tell.md) / [`/reply`](../player-guide/commands/reply.md) commands broadcast to them. + +### `lunaticchat.noticeUpdate` + +- Default: `OP` + +Receives LunaticChat update notifications. + +[You must have `checkForUpdates` enabled](./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`](../player-guide/commands/tell.md) command. + +### `lunaticchat.command.reply` + +- Default: `non OP` + +Toggles the use of the [`/reply`](../player-guide/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`](../player-guide/commands/lc/settings.md) command. + +### `lunaticchat.command.lc.status` + +- Default: `non OP` + +Toggles the use of the [`/lc status`](../player-guide/commands/lc/status.md) command. + +### `lunaticchat.command.lc.channel` + +- Default: `non OP` + +Toggles the use of the [`/lc channel`](../player-guide/commands/lc/channel.md) command. + +### `lunaticchat.command.lc.channel.create` + +- Default: `non OP` + +Toggles the use of the [`/lc channel create`](../player-guide/commands/lc/channel.md) command. + +### `lunaticchat.command.lc.channel.list` + +- Default: `non OP` + +Toggles the use of the [`/lc channel list`](../player-guide/commands/lc/channel.md) command. + +### `lunaticchat.command.lc.channel.join` + +- Default: `non OP` + +Toggles the use of the [`/lc channel join`](../player-guide/commands/lc/channel.md) command. + +### `lunaticchat.command.lc.channel.leave` + +- Default: `non OP` + +Toggles the use of the [`/lc channel leave`](../player-guide/commands/lc/channel.md) command. + +### `lunaticchat.command.lc.channel.switch` + +- Default: `non OP` + +Toggles the use of the [`/lc channel switch`](../player-guide/commands/lc/channel.md) command. + +### `lunaticchat.command.lc.channel.status` + +- Default: `non OP` + +Toggles the use of the [`/lc channel status`](../player-guide/commands/lc/channel.md) command. + +### `lunaticchat.command.lc.channel.info` + +- Default: `non OP` + +Toggles the use of the [`/lc channel info`](../player-guide/commands/lc/channel.md) command. + +### `lunaticchat.command.lc.channel.delete` + +- Default: `non OP` + +Toggles the use of the [`/lc channel delete`](../player-guide/commands/lc/channel.md) command. + +### `lunaticchat.command.lc.channel.invite` + +- Default: `non OP` + +Toggles the use of the [`/lc channel invite`](../player-guide/commands/lc/channel.md) command. + +### `lunaticchat.command.lc.channel.kick` + +- Default: `non OP` + +Toggles the use of the [`/lc channel kick`](../player-guide/commands/lc/channel.md) command. + +### `lunaticchat.command.lc.channel.ban` + +- Default: `non OP` + +Toggles the use of the [`/lc channel ban`](../player-guide/commands/lc/channel.md) command. + +### `lunaticchat.command.lc.channel.unban` + +- Default: `non OP` + +Toggles the use of the [`/lc channel unban`](../player-guide/commands/lc/channel.md) command. + +### `lunaticchat.command.lc.channel.mod` + +- Default: `non OP` + +Toggles the use of the [`/lc channel mod`](../player-guide/commands/lc/channel.md) command. + +### `lunaticchat.command.lc.channel.ownership` + +- Default: `non OP` + +Toggles the use of the [`/lc channel ownership`](../player-guide/commands/lc/channel.md) command. + +### `lunaticchat.command.lc.chatmode` + +- Default: `non OP` + +Toggles the use of the [`/lc chatmode`](../player-guide/commands/lc/chatmode.md) command. + +### `lunaticchat.command.lc.chatmode.toggle` + +- Default: `non OP` + +Toggles the use of the [`/lc chatmode toggle`](../player-guide/commands/lc/chatmode.md) command. + +### `lunaticchat.command.lcv.status` + +- Default: `OP` + +Toggles the use of the [`/lcv status`](../player-guide/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`](../player-guide/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`](../player-guide/commands/notice.md) command. diff --git a/docs/src/en/guide/admin/velocity.md b/docs/src/en/admin-guide/velocity.md index e1f9aa0..97f2a7f 100644 --- a/docs/src/en/guide/admin/velocity.md +++ b/docs/src/en/admin-guide/velocity.md @@ -71,8 +71,8 @@ When Velocity integration is enabled, chat messages are shared across all server The main features available during Velocity integration are as follows: -| | Compatibility | Behavior | Notes | -|------------| --- | --- | --- | -| Direct Messages | × | `/tell` and `/reply` commands operate only within the server | Direct messages do not support Velocity integration. | -| Channel Chat | × | Channel chat operates only within the server | Channel chat does not support Velocity integration. | -| Kana/Romanization | ◯ | Kana/Romanization works across all servers | | +| | Compatibility | Behavior | Notes | +| ----------------- | ------------- | ------------------------------------------------------------ | ---------------------------------------------------- | +| Direct Messages | × | `/tell` and `/reply` commands operate only within the server | Direct messages do not support Velocity integration. | +| Channel Chat | × | Channel chat operates only within the server | Channel chat does not support Velocity integration. | +| Kana/Romanization | ◯ | Kana/Romanization works across all servers | | diff --git a/docs/src/en/guide/player/channel-chat.md b/docs/src/en/guide/player/channel-chat.md deleted file mode 100644 index f1dcbf0..0000000 --- a/docs/src/en/guide/player/channel-chat.md +++ /dev/null @@ -1,13 +0,0 @@ -# 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). - -::: diff --git a/docs/src/en/index.md b/docs/src/en/index.md index 266c4a6..63441df 100644 --- a/docs/src/en/index.md +++ b/docs/src/en/index.md @@ -3,18 +3,15 @@ layout: home hero: - name: "LunaticChat" - tagline: Next-generation chat plugin for Paper/Velocity. + name: 'LunaticChat' + tagline: A next-generation chat plugin for Paper, Folia and Velocity. actions: - theme: brand - text: Getting Started - link: /en/guide/getting-started + text: Player Guide + link: /en/player-guide/channel-chat/about - theme: brand - text: About LunaticChat - link: /en/guide/about - - theme: brand - text: Reference - link: /en/reference + text: Admin Guide + link: /en/admin-guide/getting-started - theme: alt text: GitHub link: https://github.com/m1sk9/LunaticChat @@ -36,7 +33,7 @@ features: details: Create and manage chat channels, send private messages between specific players icon: ☎️ - title: Multi-Platform Support - details: Support for multi-platform Paper and Velocity, enabling cross-server chat + details: Support for multi-platform Paper, Folia and Velocity, enabling cross-server chat icon: 🚀 - title: High-Speed Performance with Caching details: Uses caching for romaji-to-Japanese conversion, operating faster than traditional LunaChat @@ -45,4 +42,3 @@ features: details: Reduces dependencies on other plugins, always supporting the latest Minecraft versions icon: ⛏️️ --- - diff --git a/docs/src/en/guide/about.md b/docs/src/en/player-guide/about.md index 388df7b..ef64e3b 100644 --- a/docs/src/en/guide/about.md +++ b/docs/src/en/player-guide/about.md @@ -18,16 +18,16 @@ LunaChat is no longer being developed and does not support the latest Minecraft ## Comparison -| | LunaticChat | LunaChat | -| ----- |-------------|----------------------------------------| -| Development Status | Actively Developed | Development Ended | -| Supported Platforms | Paper / Velocity | Bukkit / Spigot / BungeeCord | -| Supported Versions | 1.21.x ~ | Up to 1.16.x | -| Language | Kotlin | Java | -| Plugin Dependencies | None | EssentialsX, etc. | -| Caching | Yes | No | -| Documentation | Yes | No | -| License | GNU General Public License v3.0 | GNU Lesser General Public License v3.0 | +| | LunaticChat | LunaChat | +| ------------------- | ------------------------------- | -------------------------------------- | +| Development Status | Actively Developed | Development Ended | +| Supported Platforms | Paper / Velocity | Bukkit / Spigot / BungeeCord | +| Supported Versions | 1.21.x ~ | Up to 1.16.x | +| Language | Kotlin | Java | +| Plugin Dependencies | None | EssentialsX, etc. | +| Caching | Yes | No | +| Documentation | Yes | No | +| License | GNU General Public License v3.0 | GNU Lesser General Public License v3.0 | ## FAQ diff --git a/docs/src/en/guide/player/channel-chat/about.md b/docs/src/en/player-guide/channel-chat/about.md index 3b9b088..2e7ab58 100644 --- a/docs/src/en/guide/player/channel-chat/about.md +++ b/docs/src/en/player-guide/channel-chat/about.md @@ -24,7 +24,7 @@ Please contact your server administrator. 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. +Use the [`/lc channnel create`](../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] @@ -43,7 +43,7 @@ Use the [`/lc channnel create`](../../../reference/commands/lc/channel.md#lc-cha Channel IDs must follow these requirements: - Must be between 3 and 30 characters long -- Can only contain alphanumeric characters, underscores (_), and hyphens (-) +- Can only contain alphanumeric characters, underscores (\_), and hyphens (-) ::: @@ -63,7 +63,7 @@ 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. +To join a created channel, use the [`/lc channel join`](../commands/lc/channel.md#lc-channel-join-channel-id) command. ``` /lc channel join <channel-id> @@ -73,7 +73,7 @@ When you join a channel, your chat mode will switch from global chat to channel ## 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. +To view the list of channels you can join, use the [`/lc channel list`](../commands/lc/channel.md#lc-channel-list) command. ``` /lc channel list @@ -99,13 +99,13 @@ In LunaticChat, a player's active channel and membership status are managed sepa - 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. +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`](../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. +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`](../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/player-guide/channel-chat/chatmode.md index 02d6a18..02d6a18 100644 --- a/docs/src/en/guide/player/channel-chat/chatmode.md +++ b/docs/src/en/player-guide/channel-chat/chatmode.md diff --git a/docs/src/en/guide/player/channel-chat/moderation.md b/docs/src/en/player-guide/channel-chat/moderation.md index 3bf8609..14e2c8b 100644 --- a/docs/src/en/guide/player/channel-chat/moderation.md +++ b/docs/src/en/player-guide/channel-chat/moderation.md @@ -36,7 +36,7 @@ Server administrators uniformly have the same permissions as owner permissions i ## Temporarily Expel a Member (Kick) -To temporarily expel a member from a channel, use the [`/lc channel kick`](../../../reference/commands/lc/channel.md#lc-channel-kick-player-id) command. +To temporarily expel a member from a channel, use the [`/lc channel kick`](../commands/lc/channel.md#lc-channel-kick-player-id) command. ``` /lc channel kick <player ID> @@ -48,7 +48,7 @@ However, the expelled player can rejoin. ## Permanently Ban a Member (Ban) -To permanently ban a member from a channel, use the [`/lc channel ban`](../../../reference/commands/lc/channel.md#lc-channel-ban-player-id) command. +To permanently ban a member from a channel, use the [`/lc channel ban`](../commands/lc/channel.md#lc-channel-ban-player-id) command. ``` /lc channel ban <player ID> @@ -58,7 +58,7 @@ Executing this command will immediately expel the specified player from the chan ## Unban a Permanently Banned Member -To unban a permanently banned member, use the [`/lc channel unban`](../../../reference/commands/lc/channel.md#lc-channel-unban-player-id) command. +To unban a permanently banned member, use the [`/lc channel unban`](../commands/lc/channel.md#lc-channel-unban-player-id) command. ``` /lc channel unban <player ID> @@ -66,7 +66,7 @@ To unban a permanently banned member, use the [`/lc channel unban`](../../../ref ## Appoint/Dismiss Moderators -To appoint/dismiss a channel member as a moderator, use the [`/lc channel mod`](../../../reference/commands/lc/channel.md#lc-channel-mod-player-id) command. +To appoint/dismiss a channel member as a moderator, use the [`/lc channel mod`](../commands/lc/channel.md#lc-channel-mod-player-id) command. ``` /lc channel mod <player ID> @@ -76,7 +76,7 @@ Executing this command will appoint the specified player as a moderator. Executi ## Transfer Owner Permissions -To transfer channel owner permissions to another member, use the [`/lc channel ownership`](../../../reference/commands/lc/channel.md#lc-channel-ownership-player-id) command. +To transfer channel owner permissions to another member, use the [`/lc channel ownership`](../commands/lc/channel.md#lc-channel-ownership-player-id) command. ``` /lc channel ownership <player ID> @@ -87,8 +87,8 @@ Executing this command will transfer all owner permissions to the specified play ::: danger Important Notes on Execution - Owner permission transfer is an irreversible operation. - - Once transferred, the original owner cannot regain owner permissions unless the player with owner permissions transfers them again. - - This applies even to server administrators. + - Once transferred, the original owner cannot regain owner permissions unless the player with owner permissions transfers them again. + - This applies even to server administrators. - The recipient of owner permissions must be a member of the channel. - Owner permissions can use all moderation features and delete the channel, which is a powerful privilege. Choose carefully to whom you transfer permissions. diff --git a/docs/src/en/guide/player/channel-chat/private-channel.md b/docs/src/en/player-guide/channel-chat/private-channel.md index 3b33559..414f783 100644 --- a/docs/src/en/guide/player/channel-chat/private-channel.md +++ b/docs/src/en/player-guide/channel-chat/private-channel.md @@ -4,7 +4,7 @@ Private channels are chat channels that only specific users can join. ## Creating a Private Channel -To create a private channel, use the [`/lc channel create`](../../../reference/commands/lc/channel.md) command and specify `true` for the private setting argument. +To create a private channel, use the [`/lc channel create`](../commands/lc/channel.md) command and specify `true` for the private setting argument. ``` /lc channel create <channel ID> <channel name> [channel description] [private setting] @@ -16,7 +16,7 @@ Private channels are not listed in the `/lc channel list` command and cannot be To join, you need to receive an invitation from the owner or moderator. -To invite someone, use the [`/lc channel invite`](../../../reference/commands/lc/channel.md#lc-channel-invite-player-id) command. +To invite someone, use the [`/lc channel invite`](../commands/lc/channel.md#lc-channel-invite-player-id) command. ``` /lc channel invite <player ID> diff --git a/docs/src/en/reference/commands/jp.md b/docs/src/en/player-guide/commands/jp.md index 839e6e1..3ed57aa 100644 --- a/docs/src/en/reference/commands/jp.md +++ b/docs/src/en/player-guide/commands/jp.md @@ -8,8 +8,8 @@ This command was deprecated in v0.5.0. Please use the [`/lc settings`](lc/settin ::: -| Permission | -|--------------------------| +| Permission | +| ------------------------ | | `lunaticchat.command.jp` | Toggles the romanization conversion setting. diff --git a/docs/src/en/reference/commands/lc/channel.md b/docs/src/en/player-guide/commands/lc/channel.md index 31941ca..edb33c2 100644 --- a/docs/src/en/reference/commands/lc/channel.md +++ b/docs/src/en/player-guide/commands/lc/channel.md @@ -2,8 +2,8 @@ ### `/lc channel create <channel-id> <channel-name> [channel-description] [private-setting]` -| Permission | -|------------------------------| +| Permission | +| --------------------------------------- | | `lunaticchat.command.lc.channel.create` | Creates a channel. @@ -11,10 +11,10 @@ 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. + - 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. + - 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 @@ -30,48 +30,48 @@ Example: ### `/lc channel list` -| Permission | -|---------------------------------------| +| Permission | +| ------------------------------------- | | `lunaticchat.command.lc.channel.list` | Displays the list of channels. ### `/lc channel join <channel-id>` -| Permission | -|---------------------------------------| +| Permission | +| ------------------------------------- | | `lunaticchat.command.lc.channel.join` | Joins the specified channel. ### `/lc channel leave` -| Permission | -|----------------------------------------| +| Permission | +| -------------------------------------- | | `lunaticchat.command.lc.channel.leave` | Leaves the currently active channel. ### `/lc channel switch <channel-id>` -| Permission | -|-----------------------------------------| +| 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 | -|-----------------------------------------| +| Permission | +| --------------------------------------- | | `lunaticchat.command.lc.channel.status` | Displays information about the currently joined and active channels. ### `/lc channel delete <channel-id>` -| Permission | -|-----------------------------------------| +| 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/player-guide/commands/lc/chatmode.md index e3f335f..97472be 100644 --- a/docs/src/en/reference/commands/lc/chatmode.md +++ b/docs/src/en/player-guide/commands/lc/chatmode.md @@ -2,16 +2,16 @@ ### `/lc chatmode` -| Permission | -|-----------------------------------| +| Permission | +| --------------------------------- | | `lunaticchat.command.lc.chatmode` | Displays the current chat mode. ### `/lc chatmode toggle` -| Permission | -|------------------------------------| +| Permission | +| ---------------------------------------- | | `lunaticchat.command.lc.chatmode.toggle` | Toggles the chat mode. diff --git a/docs/src/en/player-guide/commands/lc/settings.md b/docs/src/en/player-guide/commands/lc/settings.md new file mode 100644 index 0000000..a2bf4cf --- /dev/null +++ b/docs/src/en/player-guide/commands/lc/settings.md @@ -0,0 +1,19 @@ +# /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/player-guide/commands/lc/status.md index 1fa6a39..fe9a680 100644 --- a/docs/src/en/reference/commands/lc/status.md +++ b/docs/src/en/player-guide/commands/lc/status.md @@ -2,8 +2,8 @@ ### `/lc status` -| Permission | -|---------------------------------| +| 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/player-guide/commands/lcv/status.md index 2b85283..f54fd14 100644 --- a/docs/src/en/reference/commands/lcv/status.md +++ b/docs/src/en/player-guide/commands/lcv/status.md @@ -2,8 +2,8 @@ ### `/lcv status` -| Permission | -|------------------------------| +| 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/player-guide/commands/notice.md index 4e7f41f..fc74014 100644 --- a/docs/src/en/reference/commands/notice.md +++ b/docs/src/en/player-guide/commands/notice.md @@ -8,8 +8,8 @@ This command was deprecated in v0.5.0. Please use the [`/lc settings`](lc/settin ::: -| Permission | Aliases | -|-----------------------------|-------------| +| Permission | Aliases | +| ---------------------------- | ----------- | | `lunaticchat.command.notice` | `/dmnotice` | Toggles notifications for direct messages sent via [`/tell`](tell.md) or [`/reply`](reply.md) commands on or off. diff --git a/docs/src/en/reference/commands/reply.md b/docs/src/en/player-guide/commands/reply.md index 1b26be2..1cca973 100644 --- a/docs/src/en/reference/commands/reply.md +++ b/docs/src/en/player-guide/commands/reply.md @@ -2,9 +2,9 @@ ### `/reply <message>` -| Permission | Aliases | -|-----------------------------|-------| -| `lunaticchat.command.reply` | `/r` | +| Permission | Aliases | +| --------------------------- | ------- | +| `lunaticchat.command.reply` | `/r` | Replies to the player with whom you most recently communicated using [`/tell`](tell.md). diff --git a/docs/src/en/reference/commands/tell.md b/docs/src/en/player-guide/commands/tell.md index fb2b8e1..cde71d6 100644 --- a/docs/src/en/reference/commands/tell.md +++ b/docs/src/en/player-guide/commands/tell.md @@ -2,8 +2,8 @@ ### `/tell <player ID> <message>` -| Permission | Aliases | -| ---- | ---- | +| Permission | Aliases | +| -------------------------- | ------------------------------------ | | `lunaticchat.command.tell` | `/t`, `/msg`, `/m`, `/w`, `/whisper` | Sends a message to the specified player. diff --git a/docs/src/en/guide/player/direct-message.md b/docs/src/en/player-guide/direct-message.md index 64c99b8..54f7404 100644 --- a/docs/src/en/guide/player/direct-message.md +++ b/docs/src/en/player-guide/direct-message.md @@ -4,7 +4,7 @@ The direct message feature allows you to send messages to specific players only. ## Sending Messages -To send a message, use the [`/tell`](../../reference/commands/tell.md) command. +To send a message, use the [`/tell`](./commands/tell.md) command. You can only send messages to online players. Messages cannot be sent to offline players. @@ -32,7 +32,7 @@ Since LunaticChat is designed based on the Minecraft Java Edition/Paper chat sys LunaticChat provides a quick reply feature that allows you to quickly respond to the most recent player who sent you a direct message. -To use quick reply, use the [`/reply`](../../reference/commands/reply.md) command. +To use quick reply, use the [`/reply`](./commands/reply.md) command. ``` /reply <message> @@ -52,7 +52,7 @@ As of v0.4.0, you can change the notification settings for direct messages. A notification sound will play when you receive or send a direct message. -To change notification settings, use the [`/lc settings`](../../reference/commands/lc/settings.md) command. +To change notification settings, use the [`/lc settings`](./commands/lc/settings.md) command. ::: tip Client Volume Settings @@ -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. - + ::: diff --git a/docs/src/en/player-guide/getting-started.md b/docs/src/en/player-guide/getting-started.md new file mode 100644 index 0000000..19f7c83 --- /dev/null +++ b/docs/src/en/player-guide/getting-started.md @@ -0,0 +1,77 @@ +# Player Guide: Getting Started + +This guide is for players who have joined a server with LunaticChat installed. + +::: info For Server Administrators + +For plugin installation and configuration, refer to the [Admin Guide: Getting Started](../admin-guide/getting-started.md). + +::: + +## What You Can Do with LunaticChat + +LunaticChat is a plugin that extends the chat features of your Minecraft server. The following features are available: + +- **Direct Messages**: Send one-on-one messages to specific players +- **Quick Reply**: Quickly reply to the last player who messaged you with a single command +- **Channel Chat**: Create and join channels with other players to chat only among specific members +- **Romanization Conversion**: Automatically converts messages typed in romaji to hiragana + +::: tip + +Available features may vary depending on server configuration. Contact your server administrator for details. + +::: + +## Sending Direct Messages + +Use the [`/tell`](./commands/tell.md) command to send a message to a specific player. + +``` +/tell <player> <message> +``` + +After receiving a message, you can quickly reply using the [`/reply`](./commands/reply.md) command. + +``` +/reply <message> +``` + +For more details, see [Direct Messages](./direct-message.md). + +## Joining Channel Chat + +Channel chat lets you create and join channels where only specific members can converse. + +You can see available channels with [`/lc channel list`](./commands/lc/channel.md). + +``` +/lc channel list +``` + +To join a channel, use [`/lc channel join`](./commands/lc/channel.md). + +``` +/lc channel join <channel-id> +``` + +For more details, see [Channel Chat](./channel-chat/about.md). + +## Using Romanization Conversion + +LunaticChat can automatically convert messages typed in romaji to hiragana. + +You can toggle romanization conversion on or off with the [`/lc settings`](./commands/lc/settings.md) command. + +``` +/lc settings romanization <on|off> +``` + +For more details, see [Romanization Conversion](./japanese-romanization.md). + +## What's Next? + +- [Channel Chat](./channel-chat/about.md): Learn how to use channel chat +- [Direct Messages](./direct-message.md): Learn how to use direct messages +- [Romanization Conversion](./japanese-romanization.md): Details on the romanization conversion feature +- [Command List](./index.md): View all commands available in LunaticChat diff --git a/docs/src/en/reference/index.md b/docs/src/en/player-guide/index.md index 338694e..545d0f6 100644 --- a/docs/src/en/reference/index.md +++ b/docs/src/en/player-guide/index.md @@ -2,7 +2,7 @@ This page is a reference for players using LunaticChat. -For plugin installation and configuration, refer to the [Guide](../guide/getting-started.md). +For plugin installation and configuration, refer to the [Guide](../admin-guide/getting-started.md). ## Legend diff --git a/docs/src/en/guide/player/japanese-romanization.md b/docs/src/en/player-guide/japanese-romanization.md index e851bb9..104d6d0 100644 --- a/docs/src/en/guide/player/japanese-romanization.md +++ b/docs/src/en/player-guide/japanese-romanization.md @@ -6,7 +6,7 @@ LunaticChat provides a feature to convert Japanese text from romaji. The romanization conversion feature is enabled by default. -You can toggle the romanization conversion setting using the [`/lc settings`](../../reference/commands/lc/settings.md) command. +You can toggle the romanization conversion setting using the [`/lc settings`](./commands/lc/settings.md) command. ## Conversion Process @@ -53,7 +53,7 @@ To avoid adding load, the contents of the memory cache are automatically saved t ::: -For information on cache files, see [here](../admin/cache.md). +For information on cache files, see [here](../admin-guide/cache.md). ## Improved Cache Strategy <Badge type="tip" text="v0.5.0" /> 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/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. diff --git a/docs/src/index.md b/docs/src/index.md index abdf453..90fa431 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -3,18 +3,15 @@ layout: home hero: - name: "LunaticChat" - tagline: Next-generation chat plugin for Paper/Velocity. + name: 'LunaticChat' + tagline: A next-generation chat plugin for Paper, Folia and Velocity. actions: - theme: brand - text: はじめる - link: /guide/getting-started + text: プレイヤーガイド + link: /player-guide/channel-chat/about - theme: brand - text: LunaticChat について - link: /guide/about - - theme: brand - text: リファレンス - link: /reference + text: 管理者ガイド + link: /admin-guide/getting-started - theme: alt text: GitHub link: https://github.com/m1sk9/LunaticChat @@ -36,7 +33,7 @@ features: details: チャットチャンネルを作成・管理し,特定のプレイヤー間でのプライベートメッセージを送信可能 icon: ☎️ - title: マルチプラットフォーム対応 - details: Paper と Velocity のマルチプラットフォームに対応し,サーバ間チャットを実現します + details: Paper, Folia と Velocity のマルチプラットフォームに対応し,サーバ間チャットを実現します icon: 🚀 - title: キャッシュによる高速動作 details: ローマ字から日本語の変換はキャッシュを使用し,従来の LunaChat よりも高速に動作します @@ -45,4 +42,3 @@ features: details: 他プラグインとの依存を減らし,常に最新の Minecraft バージョンに対応します icon: ⛏️️ --- - diff --git a/docs/src/guide/about.md b/docs/src/player-guide/about.md index 933426f..bcc3b86 100644 --- a/docs/src/guide/about.md +++ b/docs/src/player-guide/about.md @@ -19,16 +19,16 @@ LunaticChat は Minecraft サーバソフトウェアである Paper / Velocity ## 比較 -| | LunaticChat | LunaChat | -| ----- |-------------|----------------------------------------| -| 開発状況 | 継続的に開発中 | 開発終了 | -| 対応プラットフォーム | Paper / Velocity | Bukkit / Spigot / BungeeCord | -| サポートバージョン | 1.21.x ~ | 1.16.x まで | -| 使用言語 | Kotlin | Java | -| 依存プラグイン | なし | EssentialsX など | -| キャッシュ | あり | なし | -| ドキュメント | あり | なし | -| ライセンス | GNU General Public License v3.0 | GNU Lesser General Public License v3.0 | +| | LunaticChat | LunaChat | +| -------------------- | ------------------------------- | -------------------------------------- | +| 開発状況 | 継続的に開発中 | 開発終了 | +| 対応プラットフォーム | Paper / Velocity | Bukkit / Spigot / BungeeCord | +| サポートバージョン | 1.21.x ~ | 1.16.x まで | +| 使用言語 | Kotlin | Java | +| 依存プラグイン | なし | EssentialsX など | +| キャッシュ | あり | なし | +| ドキュメント | あり | なし | +| ライセンス | GNU General Public License v3.0 | GNU Lesser General Public License v3.0 | ## FAQ diff --git a/docs/src/guide/player/channel-chat/about.md b/docs/src/player-guide/channel-chat/about.md index 9d1ae33..5c5f73a 100644 --- a/docs/src/guide/player/channel-chat/about.md +++ b/docs/src/player-guide/channel-chat/about.md @@ -20,7 +20,7 @@ チャンネルチャットを利用するには,まずチャットチャンネルを作成する必要があります. -[`/lc channnel create`](../../../reference/commands/lc/channel.md#lc-channel-create-チャンネルid-チャンネル名-チャンネルの説明-プライベート設定) コマンドを使用して,チャットチャンネルを作成します. +[`/lc channnel create`](../commands/lc/channel.md#lc-channel-create-チャンネルid-チャンネル名-チャンネルの説明-プライベート設定) コマンドを使用して,チャットチャンネルを作成します. ``` /lc channel create <チャンネルID> <チャンネル名> [チャンネルの説明] [プライベート設定] @@ -39,7 +39,7 @@ チャンネルIDは次の要件に従う必要があります: - 3文字以上,30文字以下であること -- 英数字,アンダースコア(_),ハイフン(-)のみを含むこと +- 英数字,アンダースコア(\_),ハイフン(-)のみを含むこと ::: @@ -59,7 +59,7 @@ ## チャンネルに参加する -作成されたチャンネルに参加するには,[`/lc channel join`](../../../reference/commands/lc/channel.md#lc-channel-join-チャンネルid) コマンドを使用します. +作成されたチャンネルに参加するには,[`/lc channel join`](../commands/lc/channel.md#lc-channel-join-チャンネルid) コマンドを使用します. チャンネルに参加すると,チャットモードが全体チャットからチャンネルチャットに切り替わります. @@ -69,7 +69,7 @@ ## チャンネル一覧を表示する -参加可能なチャンネル一覧を表示するには,[`/lc channel list`](../../../reference/commands/lc/channel.md#lc-channel-list) コマンドを使用します. +参加可能なチャンネル一覧を表示するには,[`/lc channel list`](../commands/lc/channel.md#lc-channel-list) コマンドを使用します. チャット欄に参加可能なチャンネルの一覧が表示されます.クリックするか [`/lc channel join`](#チャンネルに参加する) コマンドを使用して,チャンネルに参加できます. @@ -95,13 +95,13 @@ LunaticChat では,プレイヤーのアクティブチャンネルとメンム- アクティブチャンネル: チャンネルチャットモードで使用されるチャンネル - メンバーシップ状態: プレイヤーが参加しているチャンネルの一覧 -アクティブチャンネルは一度に一つのチャンネルのみを指定できます.メンバーシップ状態のチャンネルにアクティブチャンネルを切り替える場合は [`/lc channel switch`](../../../reference/commands/lc/channel.md#lc-channel-switch-チャンネルid) コマンドを使用します. +アクティブチャンネルは一度に一つのチャンネルのみを指定できます.メンバーシップ状態のチャンネルにアクティブチャンネルを切り替える場合は [`/lc channel switch`](../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`](../commands/lc/channel.md#lc-channel-leave) コマンドを使用します. ``` /lc channel leave diff --git a/docs/src/guide/player/channel-chat/chatmode.md b/docs/src/player-guide/channel-chat/chatmode.md index 9e2712d..9e2712d 100644 --- a/docs/src/guide/player/channel-chat/chatmode.md +++ b/docs/src/player-guide/channel-chat/chatmode.md diff --git a/docs/src/guide/player/channel-chat/moderation.md b/docs/src/player-guide/channel-chat/moderation.md index 821c635..99d4ebe 100644 --- a/docs/src/guide/player/channel-chat/moderation.md +++ b/docs/src/player-guide/channel-chat/moderation.md @@ -36,7 +36,7 @@ ## メンバーを一時的に追放する (Kick) -メンバーを一時的にチャンネルから追放するには,[`/lc channel kick`](../../../reference/commands/lc/channel.md#lc-channel-kick-プレイヤーid) コマンドを使用します. +メンバーを一時的にチャンネルから追放するには,[`/lc channel kick`](../commands/lc/channel.md#lc-channel-kick-プレイヤーid) コマンドを使用します. ``` /lc channel kick <プレイヤーID> @@ -47,8 +47,8 @@ ただし,追放されたプレイヤーは再参加が可能です. ## メンバーを永久に追放する (Ban) - -メンバーを永久にチャンネルから追放するには,[`/lc channel ban`](../../../reference/commands/lc/channel.md#lc-channel-ban-プレイヤーid) コマンドを使用します. + +メンバーを永久にチャンネルから追放するには,[`/lc channel ban`](../commands/lc/channel.md#lc-channel-ban-プレイヤーid) コマンドを使用します. ``` /lc channel ban <プレイヤーID> @@ -58,7 +58,7 @@ ## 永久追放を解除する -永久追放されたメンバーの追放を解除するには,[`/lc channel unban`](../../../reference/commands/lc/channel.md#lc-channel-unban-プレイヤーid) コマンドを使用します. +永久追放されたメンバーの追放を解除するには,[`/lc channel unban`](../commands/lc/channel.md#lc-channel-unban-プレイヤーid) コマンドを使用します. ``` /lc channel unban <プレイヤーID> @@ -66,7 +66,7 @@ ## モデレーターを任命・解任する -チャンネルのメンバーをモデレーターに任命/解任するには,[`/lc channel mod`](../../../reference/commands/lc/channel.md#lc-channel-mod-プレイヤーid) コマンドを使用します. +チャンネルのメンバーをモデレーターに任命/解任するには,[`/lc channel mod`](../commands/lc/channel.md#lc-channel-mod-プレイヤーid) コマンドを使用します. ``` /lc channel mod <プレイヤーID> @@ -76,7 +76,7 @@ ## オーナー権限を譲渡する -チャンネルのオーナー権限を他のメンバーに譲渡するには,[`/lc channel ownership`](../../../reference/commands/lc/channel.md#lc-channel-ownership-プレイヤーid) コマンドを使用します. +チャンネルのオーナー権限を他のメンバーに譲渡するには,[`/lc channel ownership`](../commands/lc/channel.md#lc-channel-ownership-プレイヤーid) コマンドを使用します. ``` /lc channel ownership <プレイヤーID> @@ -87,8 +87,8 @@ ::: danger 実行時の注意点 - オーナー権限の譲渡は不可逆的な操作です. - - つまり,一度譲渡してしまうとオーナー権限を持つプレイヤーが再度譲渡しない限り,元のオーナーがオーナー権限を取り戻すことはできません. - - これはサーバー管理者であってもです. + - つまり,一度譲渡してしまうとオーナー権限を持つプレイヤーが再度譲渡しない限り,元のオーナーがオーナー権限を取り戻すことはできません. + - これはサーバー管理者であってもです. - オーナー権限を譲渡する相手は,必ずチャンネルのメンバーである必要があります. - オーナー権限は全てのモデレート機能を使用でき,かつチャンネルを削除できる強力な権限です.譲渡する相手を慎重に選んでください. diff --git a/docs/src/guide/player/channel-chat/private-channel.md b/docs/src/player-guide/channel-chat/private-channel.md index 6123310..eb321de 100644 --- a/docs/src/guide/player/channel-chat/private-channel.md +++ b/docs/src/player-guide/channel-chat/private-channel.md @@ -4,7 +4,7 @@ ## プライベートチャンネルの作成 -プライベートを作成する場合は [`/lc channel create`](../../../reference/commands/lc/channel.md) コマンドで,プライベート設定引数に `true` を指定します. +プライベートを作成する場合は [`/lc channel create`](../commands/lc/channel.md) コマンドで,プライベート設定引数に `true` を指定します. ``` /lc channel create <チャンネルID> <チャンネル名> [チャンネルの説明] [プライベート設定] @@ -16,7 +16,7 @@ 参加するにはオーナーもしくはモデレーターから招待を受ける必要があります. -招待するには,[`/lc channel invite`](../../../reference/commands/lc/channel.md#lc-channel-invite-プレイヤーid) コマンドを使用します. +招待するには,[`/lc channel invite`](../commands/lc/channel.md#lc-channel-invite-プレイヤーid) コマンドを使用します. ``` /lc channel invite <プレイヤーID> diff --git a/docs/src/reference/commands/lc/channel.md b/docs/src/player-guide/commands/lc/channel.md index 07381a6..a0c77dc 100644 --- a/docs/src/reference/commands/lc/channel.md +++ b/docs/src/player-guide/commands/lc/channel.md @@ -1,9 +1,9 @@ -# /lc channel <Badge type="tip" text="v0.6.0" /> <Badge type="tip" text="Paper" /> +# /lc channel <Badge type="tip" text="v0.6.0" /> <Badge type="tip" text="Paper/Folia" /> ### `/lc channel create <チャンネルID> <チャンネル名> [チャンネルの説明] [プライベート設定]` -| パーミッション | -|------------------------------| +| パーミッション | +| --------------------------------------- | | `lunaticchat.command.lc.channel.create` | チャンネルを作成します. @@ -11,10 +11,10 @@ - `<チャンネルID>` はチャンネルのIDを指定します. - `<チャンネル名>` はチャンネルの名前を指定します. - `[チャンネルの説明]` はチャンネルの説明を指定します (省略可能). - - `/lc channel list` コマンドでチャンネル一覧を表示した際に,説明が表示されます. + - `/lc channel list` コマンドでチャンネル一覧を表示した際に,説明が表示されます. - `[プライベート設定]` はチャンネルの公開設定を指定します. - - `true` を指定するとプライベートチャンネルとして作成され,招待されたプレイヤーのみが参加できます. - - `false` を指定するか,省略した場合はパブリックチャンネルとして作成され,誰でも参加できます. + - `true` を指定するとプライベートチャンネルとして作成され,招待されたプレイヤーのみが参加できます. + - `false` を指定するか,省略した場合はパブリックチャンネルとして作成され,誰でも参加できます. ::: warning チャンネル名・チャンネルの説明を入力する際の注意点 @@ -30,56 +30,56 @@ ### `/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` | 指定したチャンネルを削除します.チャンネルの作成者(オーナー) である必要があります. ### `/lc channel info [<チャンネルID>]` -| パーミッション | -|---------------------------------------| +| パーミッション | +| ------------------------------------- | | `lunaticchat.command.lc.channel.info` | 指定したチャンネルの情報を表示します. @@ -88,16 +88,16 @@ ### `/lc channel invite <プレイヤーID>` -| パーミッション | -|-----------------------------------------| +| パーミッション | +| --------------------------------------- | | `lunaticchat.command.lc.channel.invite` | 指定したプレイヤーを現在アクティブ状態のチャンネルに招待します. ### `/lc channel kick <プレイヤーID>` -| パーミッション | -|---------------------------------------| +| パーミッション | +| ------------------------------------- | | `lunaticchat.command.lc.channel.kick` | 指定したプレイヤーを現在アクティブ状態のチャンネルから一時的に追放します. @@ -106,8 +106,8 @@ ### `/lc channel ban <プレイヤーID>` -| パーミッション | -|-----------------------------------------| +| パーミッション | +| ------------------------------------ | | `lunaticchat.command.lc.channel.ban` | 指定したプレイヤーを現在アクティブ状態のチャンネルから永久追放します. @@ -116,24 +116,24 @@ ### `/lc channel unban <プレイヤーID>` -| パーミッション | -|----------------------------------------| +| パーミッション | +| -------------------------------------- | | `lunaticchat.command.lc.channel.unban` | 指定したプレイヤーの永久追放の解除を行います. ### `/lc channel mod <プレイヤーID>` -| パーミッション | -|--------------------------------------| +| パーミッション | +| ------------------------------------ | | `lunaticchat.command.lc.channel.mod` | 指定したプレイヤーを現在アクティブ状態のチャンネルのモデレーターに昇格/降格させます. ### `/lc channel ownership <プレイヤーID>` -| パーミッション | -|--------------------------------------------| +| パーミッション | +| ------------------------------------------ | | `lunaticchat.command.lc.channel.ownership` | 指定したプレイヤーに現在アクティブ状態のチャンネルのオーナー権を譲渡します. diff --git a/docs/src/reference/commands/lc/chatmode.md b/docs/src/player-guide/commands/lc/chatmode.md index 659aca5..2b38be8 100644 --- a/docs/src/reference/commands/lc/chatmode.md +++ b/docs/src/player-guide/commands/lc/chatmode.md @@ -1,17 +1,17 @@ -# /lc chatmode <Badge type="tip" text="v0.6.0" /> <Badge type="tip" text="Paper" /> +# /lc chatmode <Badge type="tip" text="v0.6.0" /> <Badge type="tip" text="Paper/Folia" /> ### `/lc chatmode` -| パーミッション | -|-----------------------------------| +| パーミッション | +| --------------------------------- | | `lunaticchat.command.lc.chatmode` | 現在のチャットモードを表示します. ### `/lc chatmode toggle` -| パーミッション | -|------------------------------------| +| パーミッション | +| ---------------------------------------- | | `lunaticchat.command.lc.chatmode.toggle` | チャットモードを切り替えます. diff --git a/docs/src/reference/commands/lc/settings.md b/docs/src/player-guide/commands/lc/settings.md index 209879d..b7ba77f 100644 --- a/docs/src/reference/commands/lc/settings.md +++ b/docs/src/player-guide/commands/lc/settings.md @@ -1,9 +1,9 @@ -# /lc settings <Badge type="tip" text="v0.5.0" /> <Badge type="tip" text="Paper" /> +# /lc settings <Badge type="tip" text="v0.5.0" /> <Badge type="tip" text="Paper/Folia" /> ### `/lc settings <key> [value]` -| パーミッション | -|-----------------------------------| +| パーミッション | +| --------------------------------- | | `lunaticchat.command.lc.settings` | LunaticChat のプレイヤー設定を管理します.値を指定しなかった場合は設定値が表示されます. @@ -12,8 +12,8 @@ LunaticChat のプレイヤー設定を管理します.値を指定しなかã� #### 利用可能なキー -| キー | 説明 | デフォルト値 | -|------------|----------------------------------------------------------|--------| -| `japanese` | ローマ字変換の有効化・無効化を切り替えます. | `true` | -| `notice` | `/tell` や `/reply` でダイレクトメッセージを受信した際に通知を受け取るかどうかを切り替えます. | `true` | -| `chNotice` | チャンネルチャットを受信した際に通知を受け取るかどうかを切り替えます. | `true` | +| キー | 説明 | デフォルト値 | +| ---------- | ---------------------------------------------------------------------------------------------- | ------------ | +| `japanese` | ローマ字変換の有効化・無効化を切り替えます. | `true` | +| `notice` | `/tell` や `/reply` でダイレクトメッセージを受信した際に通知を受け取るかどうかを切り替えます. | `true` | +| `chNotice` | チャンネルチャットを受信した際に通知を受け取るかどうかを切り替えます. | `true` | diff --git a/docs/src/reference/commands/lc/status.md b/docs/src/player-guide/commands/lc/status.md index 997d0ac..90b1469 100644 --- a/docs/src/reference/commands/lc/status.md +++ b/docs/src/player-guide/commands/lc/status.md @@ -1,9 +1,9 @@ -# /lc status <Badge type="tip" text="v0.5.0" /> <Badge type="tip" text="Paper" /> +# /lc status <Badge type="tip" text="v0.5.0" /> <Badge type="tip" text="Paper/Folia" /> ### `/lc status` -| パーミッション | -|---------------------------------| +| パーミッション | +| ------------------------------- | | `lunaticchat.command.lc.status` | LunaticChat のステータスを表示します. diff --git a/docs/src/reference/commands/lcv/status.md b/docs/src/player-guide/commands/lcv/status.md index 320e6fa..49e5352 100644 --- a/docs/src/reference/commands/lcv/status.md +++ b/docs/src/player-guide/commands/lcv/status.md @@ -2,8 +2,8 @@ ### `/lcv status` -| パーミッション | -|------------------------------| +| パーミッション | +| -------------------------------- | | `lunaticchat.command.lcv.status` | 現在の LunaticChat の Velocity 連携ステータスを表示します. diff --git a/docs/src/reference/commands/reply.md b/docs/src/player-guide/commands/reply.md index 51070e1..908fa96 100644 --- a/docs/src/reference/commands/reply.md +++ b/docs/src/player-guide/commands/reply.md @@ -1,14 +1,14 @@ -# /reply <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper/Velocity" /> +# /reply <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper/Folia" /> ### `/reply <メッセージ>` -| パーミッション | エイリアス | -|-----------------------------|-------| -| `lunaticchat.command.reply` | `/r` | +| パーミッション | エイリアス | +| --------------------------- | ---------- | +| `lunaticchat.command.reply` | `/r` | 直近で [`/tell`](tell.md) を使用し,やりとりをしたプレイヤーに対して返信します. -::: info このコマンドが使用できない場合 +::: info このコマンドが使用できない場合 このコマンドが無効化されている可能性があります (この機能は設定で ON/OFF できるため) diff --git a/docs/src/reference/commands/tell.md b/docs/src/player-guide/commands/tell.md index 69c2d90..8d54533 100644 --- a/docs/src/reference/commands/tell.md +++ b/docs/src/player-guide/commands/tell.md @@ -1,9 +1,9 @@ -# /tell <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper/Velocity" /> +# /tell <Badge type="tip" text="v0.1.0" /> <Badge type="tip" text="Paper/Folia" /> ### `/tell <プレイヤーID> <メッセージ>` -| パーミッション | エイリアス | -| ---- | ---- | +| パーミッション | エイリアス | +| -------------------------- | ------------------------------------ | | `lunaticchat.command.tell` | `/t`, `/msg`, `/m`, `/w`, `/whisper` | 指定したプレイヤーに対してメッセージを送信します. diff --git a/docs/src/guide/player/direct-message.md b/docs/src/player-guide/direct-message.md index 8edd16e..64fbb95 100644 --- a/docs/src/guide/player/direct-message.md +++ b/docs/src/player-guide/direct-message.md @@ -4,7 +4,7 @@ ## メッセージを送信する -メッセージを送信するには [`/tell`](../../reference/commands/tell.md) コマンドを使用します. +メッセージを送信するには [`/tell`](./commands/tell.md) コマンドを使用します. オンラインプレイヤーに対してのみメッセージを送信できます.オフラインプレイヤーには送信できません. @@ -32,7 +32,7 @@ LunaticChat は Minecraft Java Edition / Paper のチャットシステムを前 LunaticChat では,直前にダイレクトメッセージを送信した相手に対して素早く返信できるクイックリプライ機能が提供されています. -クイックリプライを使用するには [`/reply`](../../reference/commands/reply.md) コマンドを使用します. +クイックリプライを使用するには [`/reply`](./commands/reply.md) コマンドを使用します. ``` /reply <message> @@ -52,7 +52,7 @@ v0.4.0 以降,ダイレクトメッセージの通知設定を変更できるã ダイレクトメッセージを受信・送信時に通知音がなるようになります. -通知設定を変更するには [`/lc settings`](../../reference/commands/lc/settings.md) コマンドを使用します. +通知設定を変更するには [`/lc settings`](./commands/lc/settings.md) コマンドを使用します. ::: tip クライアントでの音量設定 @@ -60,6 +60,6 @@ v0.4.0 以降,ダイレクトメッセージの通知設定を変更できるã LunaticChat の通知音が聞こえない場合は,クライアントの音量設定を確認してください. - + ::: diff --git a/docs/src/player-guide/getting-started.md b/docs/src/player-guide/getting-started.md new file mode 100644 index 0000000..440e287 --- /dev/null +++ b/docs/src/player-guide/getting-started.md @@ -0,0 +1,77 @@ +# プレイヤーガイド: はじめる + +LunaticChat が導入されたサーバーに参加したプレイヤー向けのガイドです. + +::: info サーバー管理者の方へ + +プラグインの導入・設定方法については [管理者ガイド: はじめる](../admin-guide/getting-started.md) を参照してください. + +::: + +## LunaticChat でできること + +LunaticChat は,Minecraft サーバーのチャット機能を拡張するプラグインです.以下の機能が利用できます: + +- **ダイレクトメッセージ**: 特定のプレイヤーへ 1 対 1 でメッセージを送信できます +- **クイック返信**: 直前にメッセージを送ってきた相手に,コマンド一つで素早く返信できます +- **チャンネルチャット**: プレイヤー同士でチャンネルを作成・参加し,特定のメンバー間でのみチャットができます +- **ローマ字変換**: ローマ字で入力したメッセージを,自動的にひらがなに変換します + +::: tip + +利用できる機能はサーバーの設定によって異なる場合があります.詳しくはサーバー管理者にお問い合わせください. + +::: + +## ダイレクトメッセージを送る + +[`/tell`](./commands/tell.md) コマンドを使用して,特定のプレイヤーにメッセージを送信できます. + +``` +/tell <プレイヤー名> <メッセージ> +``` + +メッセージを受け取った後,[`/reply`](./commands/reply.md) コマンドで素早く返信できます. + +``` +/reply <メッセージ> +``` + +詳しくは [ダイレクトメッセージ](./direct-message.md) を参照してください. + +## チャンネルチャットに参加する + +チャンネルチャットでは,特定のメンバー間だけで会話できるチャンネルを作成・参加できます. + +参加可能なチャンネルは [`/lc channel list`](./commands/lc/channel.md) で確認できます. + +``` +/lc channel list +``` + +チャンネルに参加するには [`/lc channel join`](./commands/lc/channel.md) を使用します. + +``` +/lc channel join <チャンネルID> +``` + +詳しくは [チャンネルチャット](./channel-chat/about.md) を参照してください. + +## ローマ字変換を使う + +LunaticChat はローマ字で入力したメッセージを自動的にひらがなに変換できます. + +ローマ字変換のオン / オフは [`/lc settings`](./commands/lc/settings.md) コマンドで切り替えられます. + +``` +/lc settings romanization <on|off> +``` + +詳しくは [ローマ字変換](./japanese-romanization.md) を参照してください. + +## 次は? + +- [チャンネルチャット](./channel-chat/about.md): チャンネルチャットの使い方を確認します +- [ダイレクトメッセージ](./direct-message.md): ダイレクトメッセージの使い方を確認します +- [ローマ字変換](./japanese-romanization.md): ローマ字変換機能の詳細を確認します +- [コマンド一覧](./index.md): LunaticChat で使用できるコマンド一覧を確認します diff --git a/docs/src/reference/index.md b/docs/src/player-guide/index.md index 0563bca..4b09530 100644 --- a/docs/src/reference/index.md +++ b/docs/src/player-guide/index.md @@ -2,7 +2,7 @@ このページは LunaticChat を使用するプレイヤー向けのリファレンスです。 -プラグインの導入方法や設定方法については [ガイド](../guide/getting-started.md) を参照してください。 +プラグインの導入方法や設定方法については [ガイド](../admin-guide/getting-started.md) を参照してください。 ## 凡例 @@ -21,4 +21,3 @@ - <Badge type="tip" text="Paper" /> : この機能が Paper 環境で利用可能であることを示します. - <Badge type="tip" text="Velocity" /> : この機能が Velocity 環境で利用可能であることを示します. - <Badge type="tip" text="Paper / Velocity" /> : この機能が Paper / Velocity 環境で利用可能であることを示します. - diff --git a/docs/src/guide/player/japanese-romanization.md b/docs/src/player-guide/japanese-romanization.md index 3b62e51..cc982f0 100644 --- a/docs/src/guide/player/japanese-romanization.md +++ b/docs/src/player-guide/japanese-romanization.md @@ -6,7 +6,7 @@ LunaticChat では、日本語のテキストをローマ字に変換する機èƒ ローマ字変換機能はデフォルトで有効化されています. -[`/lc settings`](../../reference/commands/lc/settings.md) コマンドを使用して,ローマ字変換の設定を切り替えることができます. +[`/lc settings`](./commands/lc/settings.md) コマンドを使用して,ローマ字変換の設定を切り替えることができます. ## 変換の仕組み @@ -53,7 +53,7 @@ LunaticChat はプレイヤーからのテキストを以下の手順で変換ã‚ ::: -キャッシュファイルに関する情報は [こちら](../admin/cache.md) をご覧ください. +キャッシュファイルに関する情報は [こちら](../admin-guide/cache.md) をご覧ください. ## 改善されたキャッシュ戦略 <Badge type="tip" text="v0.5.0" /> diff --git a/docs/src/reference/commands/jp.md b/docs/src/reference/commands/jp.md deleted file mode 100644 index e850400..0000000 --- a/docs/src/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="非推奨: v1.0.0 で削除予定" /> - -::: danger 非推奨 - -このコマンドは v0.5.0 で非推奨となりました.代わりに [`/lc settings`](lc/settings.md) コマンドを使用してください. - -::: - -| パーミッション | -|--------------------------| -| `lunaticchat.command.jp` | - -ローマ字変換の設定を切り替えます. - -この設定は UUID で保存されるため, MCID を切り替えても設定が消えることはありません. diff --git a/docs/src/reference/commands/notice.md b/docs/src/reference/commands/notice.md deleted file mode 100644 index 5c08671..0000000 --- a/docs/src/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="非推奨: v1.0.0 で削除予定" /> - -::: danger 非推奨 - -このコマンドは v0.5.0 で非推奨となりました.代わりに [`/lc settings`](lc/settings.md) コマンドを使用してください. - -::: - -| パーミッション | エイリアス | -|-----------------------------|-------------| -| `lunaticchat.command.notice` | `/dmnotice` | - -[`/tell`](tell.md) や [`/reply`](reply.md) コマンドで送信されるダイレクトメッセージの通知をオンまたはオフに切り替えます. - -この設定は UUID で保存されるため, MCID を切り替えても設定が消えることはありません. diff --git a/docs/src/reference/permissions.md b/docs/src/reference/permissions.md deleted file mode 100644 index 5704a50..0000000 --- a/docs/src/reference/permissions.md +++ /dev/null @@ -1,179 +0,0 @@ -# パーミッション - -LuckPerms を使用した設定方法に関する詳細は [LuckPerms Wiki](https://luckperms.net/wiki/Home) を参照してください. - -## `lunaticchat.*` - -### `lunaticchat.spy` - -- Default: `OP` - -各種プレイヤー間のやり取りを可視化します. - -この権限を持つプレイヤーは他プレイヤーの [`/tell`](commands/tell.md) / [`/reply`](commands/reply.md) でのメッセージ・全チャンネルチャットがブロードキャストされます. - -### `lunaticchat.noticeUpdate` - -- Default: `OP` - -LunaticChat のアップデート通知を受け取ります. - -[受け取るには `checkForUpdates` を有効にしておく](../guide/admin/configuration.md#checkforupdates) 必要があります. - -### `lunaticchat.channelbypass` - -- Default: `OP` - -各チャンネルのモデレート機能やプライベートチャンネルに対する制限を無視します. - -## `lunaticchat.command.*` - -### `lunaticchat.command.tell` - -- Default: `non OP` - -[`/tell`](commands/tell.md) コマンドの使用を切り替えます. - -### `lunaticchat.command.reply` - -- Default: `non OP` - -[`/reply`](commands/reply.md) コマンドの使用を切り替えます. - -### `lunaticchat.command.lc` - -- Default: `non OP` - -`/lc` コマンドの使用を切り替えます. - -### `lunaticchat.command.lc.settings` - -- Default: `non OP` - -[`/lc settings`](commands/lc/settings.md) コマンドの使用を切り替えます. - -### `lunaticchat.command.lc.status` - -- Default: `non OP` - -[`/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.info` - -- Default: `non OP` - -[`/lc channel info`](commands/lc/channel.md) コマンドの使用を切り替えます. - -### `lunaticchat.command.lc.channel.delete` - -- Default: `non OP` - -[`/lc channel delete`](commands/lc/channel.md) コマンドの使用を切り替えます. - -### `lunaticchat.command.lc.channel.invite` - -- Default: `non OP` - -[`/lc channel invite`](commands/lc/channel.md) コマンドの使用を切り替えます. - -### `lunaticchat.command.lc.channel.kick` - -- Default: `non OP` - -[`/lc channel kick`](commands/lc/channel.md) コマンドの使用を切り替えます. - -### `lunaticchat.command.lc.channel.ban` - -- Default: `non OP` - -[`/lc channel ban`](commands/lc/channel.md) コマンドの使用を切り替えます. - -### `lunaticchat.command.lc.channel.unban` - -- Default: `non OP` - -[`/lc channel unban`](commands/lc/channel.md) コマンドの使用を切り替えます. - -### `lunaticchat.command.lc.channel.mod` - -- Default: `non OP` - -[`/lc channel mod`](commands/lc/channel.md) コマンドの使用を切り替えます. - -### `lunaticchat.command.lc.channel.ownership` - -- Default: `non OP` - -[`/lc channel ownership`](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.lcv.status` - -- Default: `OP` - -[`/lcv status`](commands/lcv/status.md) コマンドの使用を切り替えます. - -### `lunaticchat.command.jp` <Badge type="danger" text="非推奨: v1.0.0 で削除予定" /> - -- Default: `non OP` - -[`/jp`](commands/jp.md) コマンドの使用を切り替えます. - -### `lunaticchat.command.notice` <Badge type="danger" text="非推奨: v1.0.0 で削除予定" /> - -- Default: `non OP` - -[`/notice`](commands/notice.md) コマンドの使用を切り替えます. |
