diff options
| author | Sho Sakuma <me@m1sk9.dev> | 2026-02-23 18:46:56 +0900 |
|---|---|---|
| committer | Sho Sakuma <me@m1sk9.dev> | 2026-02-23 18:46:56 +0900 |
| commit | f4b57c95a1622cb009eec25e64da79b139e3dcf1 (patch) | |
| tree | c2ef4407725bb0bd35f63b92a2875d4a2d153525 /docs | |
| parent | 02574e0f606d0af3535d58b794fc5304de3ba37c (diff) | |
| download | LunaticChat-f4b57c95a1622cb009eec25e64da79b139e3dcf1.tar.gz LunaticChat-f4b57c95a1622cb009eec25e64da79b139e3dcf1.tar.bz2 LunaticChat-f4b57c95a1622cb009eec25e64da79b139e3dcf1.zip | |
docs: Update guide
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/.vitepress/config/en.ts | 136 | ||||
| -rw-r--r-- | docs/.vitepress/config/ja.ts | 140 | ||||
| -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) | 0 | ||||
| -rw-r--r-- | docs/src/admin-guide/configuration.md (renamed from docs/src/guide/admin/configuration.md) | 6 | ||||
| -rw-r--r-- | docs/src/admin-guide/getting-started.md (renamed from docs/src/guide/getting-started.md) | 14 | ||||
| -rw-r--r-- | docs/src/admin-guide/management-data.md (renamed from docs/src/guide/admin/management-data.md) | 0 | ||||
| -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) | 0 | ||||
| -rw-r--r-- | docs/src/en/admin-guide/cache.md (renamed from docs/src/en/guide/admin/cache.md) | 2 | ||||
| -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) | 0 | ||||
| -rw-r--r-- | docs/src/en/admin-guide/configuration.md (renamed from docs/src/en/guide/admin/configuration.md) | 6 | ||||
| -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) | 0 | ||||
| -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) | 0 | ||||
| -rw-r--r-- | docs/src/en/guide/player/channel-chat.md | 13 | ||||
| -rw-r--r-- | docs/src/en/index.md | 15 | ||||
| -rw-r--r-- | docs/src/en/player-guide/about.md (renamed from docs/src/en/guide/about.md) | 0 | ||||
| -rw-r--r-- | docs/src/en/player-guide/channel-chat/about.md (renamed from docs/src/en/guide/player/channel-chat/about.md) | 10 | ||||
| -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) | 10 | ||||
| -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) | 0 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/lc/channel.md (renamed from docs/src/en/reference/commands/lc/channel.md) | 0 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/lc/chatmode.md (renamed from docs/src/en/reference/commands/lc/chatmode.md) | 0 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/lc/settings.md (renamed from docs/src/en/reference/commands/lc/settings.md) | 0 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/lc/status.md (renamed from docs/src/en/reference/commands/lc/status.md) | 0 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/lcv/status.md (renamed from docs/src/en/reference/commands/lcv/status.md) | 0 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/notice.md (renamed from docs/src/en/reference/commands/notice.md) | 0 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/reply.md (renamed from docs/src/en/reference/commands/reply.md) | 0 | ||||
| -rw-r--r-- | docs/src/en/player-guide/commands/tell.md (renamed from docs/src/en/reference/commands/tell.md) | 0 | ||||
| -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/permissions.md | 179 | ||||
| -rw-r--r-- | docs/src/index.md | 13 | ||||
| -rw-r--r-- | docs/src/player-guide/about.md (renamed from docs/src/guide/about.md) | 0 | ||||
| -rw-r--r-- | docs/src/player-guide/channel-chat/about.md (renamed from docs/src/guide/player/channel-chat/about.md) | 10 | ||||
| -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) | 10 | ||||
| -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) | 0 | ||||
| -rw-r--r-- | docs/src/player-guide/commands/lc/chatmode.md (renamed from docs/src/reference/commands/lc/chatmode.md) | 0 | ||||
| -rw-r--r-- | docs/src/player-guide/commands/lc/settings.md (renamed from docs/src/reference/commands/lc/settings.md) | 0 | ||||
| -rw-r--r-- | docs/src/player-guide/commands/lc/status.md (renamed from docs/src/reference/commands/lc/status.md) | 0 | ||||
| -rw-r--r-- | docs/src/player-guide/commands/lcv/status.md (renamed from docs/src/reference/commands/lcv/status.md) | 0 | ||||
| -rw-r--r-- | docs/src/player-guide/commands/reply.md (renamed from docs/src/reference/commands/reply.md) | 0 | ||||
| -rw-r--r-- | docs/src/player-guide/commands/tell.md (renamed from docs/src/reference/commands/tell.md) | 0 | ||||
| -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) | 2 | ||||
| -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/permissions.md | 179 |
57 files changed, 715 insertions, 600 deletions
diff --git a/docs/.vitepress/config/en.ts b/docs/.vitepress/config/en.ts index 1669fbb..7554933 100644 --- a/docs/.vitepress/config/en.ts +++ b/docs/.vitepress/config/en.ts @@ -2,127 +2,82 @@ import type { DefaultTheme } from 'vitepress'; export const en: DefaultTheme.Config = { nav: [ - { text: 'Guide', link: '/en/guide/getting-started' }, - { text: 'Reference', link: '/en/reference' }, + { text: 'Player Guide', link: '/en/player-guide/getting-started' }, + { text: 'Admin Guide', link: '/en/admin-guide/getting-started' }, ], sidebar: { - '/en/guide/': [ + '/en/player-guide/': [ { text: 'Getting Started', - link: '/en/guide/getting-started', + link: '/en/player-guide/getting-started', }, { text: 'About LunaticChat', - link: '/en/guide/about', + link: '/en/player-guide/about', }, { - text: 'For Server Administrators', + text: 'Channel Chat', + link: '/en/player-guide/channel-chat/about', items: [ { - text: 'Channel Chat', - items: [ - { - text: 'Deployment Guide', - link: '/en/guide/admin/channel-chat/introduction', - }, - { - text: 'Logs', - link: '/en/guide/admin/channel-chat/logs', - }, - ], + text: 'Chat Mode', + link: '/en/player-guide/channel-chat/chatmode', }, { - text: 'Cache System', - link: '/en/guide/admin/cache', + text: 'Private Channel', + link: '/en/player-guide/channel-chat/private-channel', }, { - text: 'Configuration', - link: '/en/guide/admin/configuration', - }, - { - text: 'Velocity Integration', - link: '/en/guide/admin/velocity', - }, - { - text: 'Data Management', - link: '/en/guide/admin/management-data', + text: 'Moderation', + link: '/en/player-guide/channel-chat/moderation', }, ], }, { - text: 'For Players', - items: [ - { - text: 'Channel Chat', - link: '/en/guide/player/channel-chat/about', - items: [ - { - text: 'Chat Mode', - link: '/en/guide/player/channel-chat/chatmode', - }, - { - text: 'Private Channel', - link: '/en/guide/player/channel-chat/private-channel', - }, - { - text: 'Moderation', - link: '/en/guide/player/channel-chat/moderation', - }, - ], - }, - { - text: 'Direct Messages', - link: '/en/guide/player/direct-message', - }, - { - text: 'Romanization Conversion', - link: '/en/guide/player/japanese-romanization', - }, - ], + text: 'Direct Messages', + link: '/en/player-guide/direct-message', }, - ], - '/en/reference/': [ { - text: 'Permissions', - link: '/en/reference/permissions', + text: 'Romanization Conversion', + link: '/en/player-guide/japanese-romanization', }, { text: 'Commands', items: [ { text: '/tell', - link: '/en/reference/commands/tell', + link: '/en/player-guide/commands/tell', }, { text: '/reply', - link: '/en/reference/commands/reply', + link: '/en/player-guide/commands/reply', }, { text: '/jp', - link: '/en/reference/commands/jp', + link: '/en/player-guide/commands/jp', }, { text: '/notice', - link: '/en/reference/commands/notice', + link: '/en/player-guide/commands/notice', }, { text: '/lc', items: [ { text: '/lc settings', - link: '/en/reference/commands/lc/settings', + link: '/en/player-guide/commands/lc/settings', }, { text: '/lc status', - link: '/en/reference/commands/lc/status', + link: '/en/player-guide/commands/lc/status', }, { text: '/lc channel', - link: '/en/reference/commands/lc/channel', + link: '/en/player-guide/commands/lc/channel', }, { text: '/lc chatmode', - link: '/en/reference/commands/lc/chatmode', + link: '/en/player-guide/commands/lc/chatmode', }, ], }, @@ -131,13 +86,52 @@ export const en: DefaultTheme.Config = { items: [ { text: '/lcv status', - link: '/en/reference/commands/lcv/status', + link: '/en/player-guide/commands/lcv/status', }, ], }, ], }, ], + '/en/admin-guide/': [ + { + text: 'Getting Started', + link: '/en/admin-guide/getting-started', + }, + { + text: 'Configuration', + link: '/en/admin-guide/configuration', + }, + { + text: 'Permissions', + link: '/en/admin-guide/permissions', + }, + { + text: 'Channel Chat', + items: [ + { + text: 'Deployment Guide', + link: '/en/admin-guide/channel-chat/introduction', + }, + { + text: 'Logs', + link: '/en/admin-guide/channel-chat/logs', + }, + ], + }, + { + text: 'Velocity Integration', + link: '/en/admin-guide/velocity', + }, + { + text: 'Cache System', + link: '/en/admin-guide/cache', + }, + { + text: 'Data Management', + link: '/en/admin-guide/management-data', + }, + ], }, editLink: { pattern: 'https://github.com/m1sk9/LunaticChat/edit/main/docs/src/:path', diff --git a/docs/.vitepress/config/ja.ts b/docs/.vitepress/config/ja.ts index 0e3e467..39e0518 100644 --- a/docs/.vitepress/config/ja.ts +++ b/docs/.vitepress/config/ja.ts @@ -2,127 +2,74 @@ import type { DefaultTheme } from 'vitepress'; export const ja: DefaultTheme.Config = { nav: [ - { text: 'ガイド', link: '/guide/getting-started' }, - { text: 'リファレンス', link: '/reference' }, + { text: 'プレイヤーガイド', link: '/player-guide/getting-started' }, + { text: '管理者ガイド', link: '/admin-guide/getting-started' }, ], sidebar: { - '/guide/': [ + '/player-guide/': [ { text: 'はじめる', - link: '/guide/getting-started', + link: '/player-guide/getting-started', }, { text: 'LunaticChat について', - link: '/guide/about', + link: '/player-guide/about', }, { - text: 'サーバー管理者向け', + text: 'チャンネルチャット', + link: '/player-guide/channel-chat/about', items: [ { - text: 'チャンネルチャット', - items: [ - { - text: '展開ガイド', - link: '/guide/admin/channel-chat/introduction', - }, - { - text: 'ログ', - link: '/guide/admin/channel-chat/logs', - }, - ], - }, - { - text: 'キャッシュシステム', - link: '/guide/admin/cache', - }, - { - text: '設定', - link: '/guide/admin/configuration', + text: 'チャットモード', + link: '/player-guide/channel-chat/chatmode', }, { - text: 'Velocity 連携', - link: '/guide/admin/velocity', + text: 'プライベートチャンネル', + link: '/player-guide/channel-chat/private-channel', }, { - text: 'データの管理', - link: '/guide/admin/management-data', + text: 'モデレーション', + link: '/player-guide/channel-chat/moderation', }, ], }, { - text: 'プレイヤー向け', - items: [ - { - text: 'チャンネルチャット', - link: '/guide/player/channel-chat/about', - items: [ - { - text: 'チャットモード', - link: '/guide/player/channel-chat/chatmode', - }, - { - text: 'プライベートチャンネル', - link: '/guide/player/channel-chat/private-channel', - }, - { - text: 'モデレーション', - link: '/guide/player/channel-chat/moderation', - }, - ], - }, - { - text: 'ダイレクトメッセージ', - link: '/guide/player/direct-message', - }, - { - text: 'ローマ字変換', - link: '/guide/player/japanese-romanization', - }, - ], + text: 'ダイレクトメッセージ', + link: '/player-guide/direct-message', }, - ], - '/reference/': [ { - text: 'パーミッション', - link: '/reference/permissions', + text: 'ローマ字変換', + link: '/player-guide/japanese-romanization', }, { text: 'コマンド', items: [ { text: '/tell', - link: '/reference/commands/tell', + link: '/player-guide/commands/tell', }, { text: '/reply', - link: '/reference/commands/reply', - }, - { - text: '/jp', - link: '/reference/commands/jp', - }, - { - text: '/notice', - link: '/reference/commands/notice', + link: '/player-guide/commands/reply', }, { text: '/lc', items: [ { text: '/lc settings', - link: '/reference/commands/lc/settings', + link: '/player-guide/commands/lc/settings', }, { text: '/lc status', - link: '/reference/commands/lc/status', + link: '/player-guide/commands/lc/status', }, { text: '/lc channel', - link: '/reference/commands/lc/channel', + link: '/player-guide/commands/lc/channel', }, { text: '/lc chatmode', - link: '/reference/commands/lc/chatmode', + link: '/player-guide/commands/lc/chatmode', }, ], }, @@ -131,13 +78,52 @@ export const ja: DefaultTheme.Config = { items: [ { text: '/lcv status', - link: '/reference/commands/lcv/status', + link: '/player-guide/commands/lcv/status', }, ], }, ], }, ], + '/admin-guide/': [ + { + text: 'はじめる', + link: '/admin-guide/getting-started', + }, + { + text: '設定', + link: '/admin-guide/configuration', + }, + { + text: 'パーミッション', + link: '/admin-guide/permissions', + }, + { + text: 'チャンネルチャット', + items: [ + { + text: '展開ガイド', + link: '/admin-guide/channel-chat/introduction', + }, + { + text: 'ログ', + link: '/admin-guide/channel-chat/logs', + }, + ], + }, + { + text: 'Velocity 連携', + link: '/admin-guide/velocity', + }, + { + text: 'キャッシュシステム', + link: '/admin-guide/cache', + }, + { + text: 'データの管理', + link: '/admin-guide/management-data', + }, + ], }, editLink: { pattern: 'https://github.com/m1sk9/LunaticChat/edit/main/docs/src/:path', 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..9b88bdd 100644 --- a/docs/src/guide/admin/channel-chat/logs.md +++ b/docs/src/admin-guide/channel-chat/logs.md diff --git a/docs/src/guide/admin/configuration.md b/docs/src/admin-guide/configuration.md index b641549..0d62646 100644 --- a/docs/src/guide/admin/configuration.md +++ b/docs/src/admin-guide/configuration.md @@ -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 36bd4c4..9254f33 100644 --- a/docs/src/guide/getting-started.md +++ b/docs/src/admin-guide/getting-started.md @@ -29,7 +29,7 @@ LunaticChat をインストールします.LunaticChat は以下から入手 LunaticChat を起動すると設定ファイル `config.yml` が作成されます. -該当のファイルを開き,初期設定を変更してください.なお,全設定項目の詳細については,[設定ガイド](admin/configuration.md)を参照してください. +該当のファイルを開き,初期設定を変更してください.なお,全設定項目の詳細については,[設定ガイド](./configuration.md)を参照してください. ### 推奨する初期設定 @@ -55,8 +55,8 @@ LunaticChat のパーミッションを LuckPerms などのパーミッション 基本的なパーミッションは Paper, Folia や Velocity のデフォルトパーミッションシステム ( `OP` / `non OP` ) でも使用できるように開発されていますが,より詳細な制御を行う場合は LuckPerms の使用を推奨します. -- パーミッションノードの詳細については [パーミッションガイド](../reference/permissions.md)を参照してください. -- コマンドの各機能に対応するパーミッションノードは,[コマンドリファレンス](../reference/index.md)を参照してください. +- パーミッションノードの詳細については [パーミッションガイド](./permissions.md)を参照してください. +- コマンドの各機能に対応するパーミッションノードは,[コマンドリファレンス](../player-guide/index.md)を参照してください. ## サーバーの再起動 @@ -66,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..5527ffa 100644 --- a/docs/src/guide/admin/management-data.md +++ b/docs/src/admin-guide/management-data.md 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 862b529..862b529 100644 --- a/docs/src/guide/admin/velocity.md +++ b/docs/src/admin-guide/velocity.md diff --git a/docs/src/en/guide/admin/cache.md b/docs/src/en/admin-guide/cache.md index 2fa2802..1148973 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 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..b65750b 100644 --- a/docs/src/en/guide/admin/channel-chat/logs.md +++ b/docs/src/en/admin-guide/channel-chat/logs.md diff --git a/docs/src/en/guide/admin/configuration.md b/docs/src/en/admin-guide/configuration.md index 15c8f10..9d77d46 100644 --- a/docs/src/en/guide/admin/configuration.md +++ b/docs/src/en/admin-guide/configuration.md @@ -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..ffed59d 100644 --- a/docs/src/en/guide/admin/management-data.md +++ b/docs/src/en/admin-guide/management-data.md 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..e1f9aa0 100644 --- a/docs/src/en/guide/admin/velocity.md +++ b/docs/src/en/admin-guide/velocity.md 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..535fa0c 100644 --- a/docs/src/en/index.md +++ b/docs/src/en/index.md @@ -4,17 +4,14 @@ layout: home hero: name: "LunaticChat" - tagline: Next-generation chat plugin for Paper/Velocity. + 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 diff --git a/docs/src/en/guide/about.md b/docs/src/en/player-guide/about.md index 388df7b..388df7b 100644 --- a/docs/src/en/guide/about.md +++ b/docs/src/en/player-guide/about.md diff --git a/docs/src/en/guide/player/channel-chat/about.md b/docs/src/en/player-guide/channel-chat/about.md index 3b9b088..5130064 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] @@ -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..1867ec7 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> 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..839e6e1 100644 --- a/docs/src/en/reference/commands/jp.md +++ b/docs/src/en/player-guide/commands/jp.md diff --git a/docs/src/en/reference/commands/lc/channel.md b/docs/src/en/player-guide/commands/lc/channel.md index 31941ca..31941ca 100644 --- a/docs/src/en/reference/commands/lc/channel.md +++ b/docs/src/en/player-guide/commands/lc/channel.md diff --git a/docs/src/en/reference/commands/lc/chatmode.md b/docs/src/en/player-guide/commands/lc/chatmode.md index e3f335f..e3f335f 100644 --- a/docs/src/en/reference/commands/lc/chatmode.md +++ b/docs/src/en/player-guide/commands/lc/chatmode.md diff --git a/docs/src/en/reference/commands/lc/settings.md b/docs/src/en/player-guide/commands/lc/settings.md index 8b88066..8b88066 100644 --- a/docs/src/en/reference/commands/lc/settings.md +++ b/docs/src/en/player-guide/commands/lc/settings.md diff --git a/docs/src/en/reference/commands/lc/status.md b/docs/src/en/player-guide/commands/lc/status.md index 1fa6a39..1fa6a39 100644 --- a/docs/src/en/reference/commands/lc/status.md +++ b/docs/src/en/player-guide/commands/lc/status.md diff --git a/docs/src/en/reference/commands/lcv/status.md b/docs/src/en/player-guide/commands/lcv/status.md index 2b85283..2b85283 100644 --- a/docs/src/en/reference/commands/lcv/status.md +++ b/docs/src/en/player-guide/commands/lcv/status.md diff --git a/docs/src/en/reference/commands/notice.md b/docs/src/en/player-guide/commands/notice.md index 4e7f41f..4e7f41f 100644 --- a/docs/src/en/reference/commands/notice.md +++ b/docs/src/en/player-guide/commands/notice.md diff --git a/docs/src/en/reference/commands/reply.md b/docs/src/en/player-guide/commands/reply.md index 1b26be2..1b26be2 100644 --- a/docs/src/en/reference/commands/reply.md +++ b/docs/src/en/player-guide/commands/reply.md diff --git a/docs/src/en/reference/commands/tell.md b/docs/src/en/player-guide/commands/tell.md index fb2b8e1..fb2b8e1 100644 --- a/docs/src/en/reference/commands/tell.md +++ b/docs/src/en/player-guide/commands/tell.md 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/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 e070120..9982744 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -4,17 +4,14 @@ layout: home hero: name: "LunaticChat" - tagline: Next-generation chat plugin for Paper/Velocity. + 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 diff --git a/docs/src/guide/about.md b/docs/src/player-guide/about.md index 933426f..933426f 100644 --- a/docs/src/guide/about.md +++ b/docs/src/player-guide/about.md diff --git a/docs/src/guide/player/channel-chat/about.md b/docs/src/player-guide/channel-chat/about.md index 9d1ae33..f15fb17 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> <チャンネル名> [チャンネルの説明] [プライベート設定] @@ -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..8e0555d 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> @@ -48,7 +48,7 @@ ## メンバーを永久に追放する (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> 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 4b96559..4b96559 100644 --- a/docs/src/reference/commands/lc/channel.md +++ b/docs/src/player-guide/commands/lc/channel.md diff --git a/docs/src/reference/commands/lc/chatmode.md b/docs/src/player-guide/commands/lc/chatmode.md index eee6238..eee6238 100644 --- a/docs/src/reference/commands/lc/chatmode.md +++ b/docs/src/player-guide/commands/lc/chatmode.md diff --git a/docs/src/reference/commands/lc/settings.md b/docs/src/player-guide/commands/lc/settings.md index 343ffd5..343ffd5 100644 --- a/docs/src/reference/commands/lc/settings.md +++ b/docs/src/player-guide/commands/lc/settings.md diff --git a/docs/src/reference/commands/lc/status.md b/docs/src/player-guide/commands/lc/status.md index 02f75ce..02f75ce 100644 --- a/docs/src/reference/commands/lc/status.md +++ b/docs/src/player-guide/commands/lc/status.md diff --git a/docs/src/reference/commands/lcv/status.md b/docs/src/player-guide/commands/lcv/status.md index 320e6fa..320e6fa 100644 --- a/docs/src/reference/commands/lcv/status.md +++ b/docs/src/player-guide/commands/lcv/status.md diff --git a/docs/src/reference/commands/reply.md b/docs/src/player-guide/commands/reply.md index 5e0752f..5e0752f 100644 --- a/docs/src/reference/commands/reply.md +++ b/docs/src/player-guide/commands/reply.md diff --git a/docs/src/reference/commands/tell.md b/docs/src/player-guide/commands/tell.md index 35edca8..35edca8 100644 --- a/docs/src/reference/commands/tell.md +++ b/docs/src/player-guide/commands/tell.md 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..621a347 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) を参照してください。 ## 凡例 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/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) コマンドの使用を切り替えます. |
