summaryrefslogtreecommitdiff
path: root/docs/src/en/guide/admin
diff options
context:
space:
mode:
authorSho Sakuma <me@m1sk9.dev>2026-01-27 22:40:50 +0900
committerSho Sakuma <me@m1sk9.dev>2026-01-27 22:40:50 +0900
commit15fc0758b688549278069b7a9cf3ecaf6e7b4471 (patch)
tree2fa844b83b79f96488f5dc06be49cbfdce684346 /docs/src/en/guide/admin
parent5171dc41dc633e51470ea2e9f92b3434547a465c (diff)
downloadLunaticChat-15fc0758b688549278069b7a9cf3ecaf6e7b4471.tar.gz
LunaticChat-15fc0758b688549278069b7a9cf3ecaf6e7b4471.tar.bz2
LunaticChat-15fc0758b688549278069b7a9cf3ecaf6e7b4471.zip
docs: Add i18n docs
Diffstat (limited to 'docs/src/en/guide/admin')
-rw-r--r--docs/src/en/guide/admin/data-and-logs.md119
-rw-r--r--docs/src/en/guide/admin/introduction-channel-chat.md56
2 files changed, 175 insertions, 0 deletions
diff --git a/docs/src/en/guide/admin/data-and-logs.md b/docs/src/en/guide/admin/data-and-logs.md
new file mode 100644
index 0000000..e869552
--- /dev/null
+++ b/docs/src/en/guide/admin/data-and-logs.md
@@ -0,0 +1,119 @@
+# Data and Logs
+
+::: danger Do Not Edit
+
+These data files are essential to the operation of LunaticChat. Direct editing may cause data corruption or unexpected behavior. Do not directly edit these files unless you are backing up data.
+
+:::
+
+## Data Storage Location
+
+LunaticChat saves channel data and configuration information to local disk.
+
+- `channels.json`: Stores channel information.
+- `chatmodes.json`: Stores player chat mode settings.
+- `conversion_cache.json`: Stores cache for channel conversion.
+- `player-settings.yaml`: Stores player-specific settings.
+
+::: tip Regular Backups
+
+To ensure the safety of your LunaticChat data, we recommend creating regular backups.
+
+:::
+
+### `channels.json`
+
+The `channels.json` file stores information about channels managed by LunaticChat. This file contains information such as channel names, participant lists, and chat modes.
+
+```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"
+ }
+}
+```
+
+### `chatmodes.json`
+
+The `chatmodes.json` file stores player chat mode settings. This file contains chat mode information for each player.
+
+```json
+{
+ "modes": {
+ "aed5efd4-551b-3965-bc28-ae21aa072a66": "CHANNEL",
+ "ceaea267-39dd-3bac-931c-761ada671ebe": "CHANNEL",
+ "a01e3843-e521-3998-958a-f459800e4d11": "CHANNEL",
+ "681f539b-8bb8-3f85-85e5-a2945f6c6539": "GLOBAL"
+ }
+}
+```
+
+### `conversion_cache.json`
+
+The `conversion_cache.json` file stores cache for channel conversion. This file contains channel conversion information for each player.
+
+For more information about the cache system, see [here](./cache.md).
+
+
+```json
+{"version":"1","entries":{"hi":"日"}}
+```
+
+### `player-settings.yaml`
+
+The `player-settings.yaml` file stores player-specific settings. This file contains individual player settings.
+
+```yaml
+version: 1
+japaneseConversion:
+ "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
+channelMessageNotification:
+ "ceaea267-39dd-3bac-931c-761ada671ebe": true
+```
+
+## Cache Version
+
+Files used for disk caching include a `version` field to accommodate changes in cache format as LunaticChat is upgraded.
+
+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":{}}
+```
+
+## About CoreProtect
+
+Various chat logs in LunaticChat can also be recorded in CoreProtect without requiring an API.
+
+Logs for each feature can be checked with the following actions. When using the `/co lookup` command, specify the following actions:
+
+- Direct messages: `command`
+- Global chat and channel chat: `chat`
+ - Japanese and romanization conversion is saved according to the player's settings.
+
+
diff --git a/docs/src/en/guide/admin/introduction-channel-chat.md b/docs/src/en/guide/admin/introduction-channel-chat.md
new file mode 100644
index 0000000..2a81d63
--- /dev/null
+++ b/docs/src/en/guide/admin/introduction-channel-chat.md
@@ -0,0 +1,56 @@
+# Channel Chat Deployment Guide
+
+This guide explains how to deploy channel chat.
+
+## What is 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).
+
+## Preparing to Deploy Channel Chat
+
+To deploy channel chat, you need to enable the channel chat feature in the LunaticChat configuration file `config.yml`.
+
+1. Stop the server.
+2. Open `plugins/LunaticChat/config.yml`.
+3. Set `features.channelChat.enabled` to `true`.
+4. Restart the server.
+
+This will enable the channel chat feature and allow players to use channel chat.
+
+## Channel Chat Configuration
+
+The configuration items related to channel chat are as follows:
+
+- `features.channelChat.maxChannelsPerPlayer`: Specifies the maximum number of channels a single player can create.
+- `features.channelChat.maxMembersPerChannel`: Specifies the maximum number of members that can join a single channel.
+- `features.channelChat.maxMembershipPerPlayer`: Specifies the maximum number of channels a single player can join.
+
+The default is set to `0`, which means there is no limit.
+
+::: tip Recommended Settings
+
+If you want to actively use the channel chat feature, we recommend setting these values higher.
+
+However, as this may impact server performance, please set them appropriately according to your server's resource situation.
+
+Recommended settings are as follows:
+
+- `features.channelChat.maxChannelsPerPlayer`: `3` to `5`
+- `features.channelChat.maxMembersPerChannel`: `20` to `50`
+- `features.channelChat.maxMembershipPerPlayer`: `5` to `10`
+
+:::
+
+## Channel Management
+
+Basically, [players manage channels themselves](../player/channel-chat/moderation.md).
+
+However, as a server administrator, please note the following:
+
+- Server administrators have owner permissions for all channels. If operations are required, please respond appropriately.
+- To maintain server performance, set limits on the number of channels and members as needed.
+- If inappropriate channels or member behavior occurs, take appropriate action.
+
+If you want to avoid troubles related to channel management, consider restricting moderate commands such as `/lc channel ban`.