summaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorSho Sakuma <me@m1sk9.dev>2026-01-17 14:36:21 +0900
committerSho Sakuma <me@m1sk9.dev>2026-01-17 14:36:21 +0900
commit1191e2cd5cb562afb3a330d2fb2a21521638f66e (patch)
tree4e7c78fd67facf258b0c14610097c047c9ac072b /docs/src
parentbc3d4f45021b0221a009a051559d271a9e681f48 (diff)
downloadLunaticChat-1191e2cd5cb562afb3a330d2fb2a21521638f66e.tar.gz
LunaticChat-1191e2cd5cb562afb3a330d2fb2a21521638f66e.tar.bz2
LunaticChat-1191e2cd5cb562afb3a330d2fb2a21521638f66e.zip
docs: Update configuration and permission guide
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/guide/configuration.md19
-rw-r--r--docs/src/guide/permissions.md8
2 files changed, 25 insertions, 2 deletions
diff --git a/docs/src/guide/configuration.md b/docs/src/guide/configuration.md
index 14177b4..07458b3 100644
--- a/docs/src/guide/configuration.md
+++ b/docs/src/guide/configuration.md
@@ -16,11 +16,14 @@
# ----------------------------------------------
# If enabled, Activate LunaticChat's debug mode, which provides detailed logging for troubleshooting.
-debug: true
+debug: false
# Path to the YAML file storing player settings
userSettingsFilePath: "player-settings.yaml"
+# If enabled, LunaticChat will check for updates on startup.
+checkForUpdates: true
+
# ----------------------------------------------
# ----------- Features Settings ------------
# ----------------------------------------------
@@ -31,13 +34,18 @@ features:
enabled: true
japaneseConversion:
# If enabled, enables the conversion function from Roman letters to hiragana.
- enabled: true
+ enabled: false
cache:
+ # Specifies the maximum number of entries to store in the Romanization conversion cache.
maxEntries: 500
+ # 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"
api:
+ # Specify the timeout duration (in milliseconds) for API requests to the Romanization conversion service.
timeout: 3000
+ # Specify the number of retry attempts for failed API requests to the Romanization conversion service.
retryAttempts: 2
# ----------------------------------------------
@@ -73,6 +81,13 @@ LunaticChat をデバッグモードで起動します.
LunaticChat がプレイヤーの設定を保存する YAML ファイルのパスを指定します.
+### `checkForUpdates`
+
+- Type: `boolean`
+- Default: `true`
+
+LunaticChat の起動時・権限を持ったプレイヤーがサーバに参加した際に,LunaticChat のアップデートを促すかどうか設定します.
+
## Features Settings
### `features.quickReplies.enabled`
diff --git a/docs/src/guide/permissions.md b/docs/src/guide/permissions.md
index eb37344..f5c27b9 100644
--- a/docs/src/guide/permissions.md
+++ b/docs/src/guide/permissions.md
@@ -12,6 +12,14 @@ LuckPerms を使用した設定方法に関する詳細は [LuckPerms Wiki](http
この権限を持つプレイヤーは他プレイヤーの [`/tell`](../reference/commands/tell.md) / [`/reply`](../reference/commands/reply.md) でのメッセージがブロードキャストされます.
+### `lunaticchat.noticeUpdate`
+
+- Default: `OP`
+
+LunaticChat のアップデート通知を受け取ります.
+
+[受け取るには `checkForUpdates` を有効にしておく](../guide/configuration.md#checkforupdates) 必要があります.
+
## `lunaticchat.command.*`
### `lunaticchat.command.tell`