diff --git a/.github/README.md b/.github/README.md index f85fda8..cc538b9 100644 --- a/.github/README.md +++ b/.github/README.md @@ -160,6 +160,7 @@ The system config (`config.json`) will be generated after first launch. Please s | - | - | - | - | | pathToLog | Path to the log file of the game server | ../../logs/latest.log | string (ends with ".log") | | logCharCode | Character code of the log file | utf-8 | string([supported character codes](https://github.com/ashtuchkin/iconv-lite/wiki/Supported-Encodings))| +| logInterval | Time interval to check log updates (unit: ms). Lower values make the response for log updates more quickly, but also increases the load on the system. | 100 | number | | locale | The language of this system | en_us | string(same as language name in the game) | | token | Bot token | | string | | listenChannels | The list of the channel IDs where this system detects messages from Discord. | [] | string[] | diff --git a/.github/README_jp.md b/.github/README_jp.md index 194875b..156b1a3 100644 --- a/.github/README_jp.md +++ b/.github/README_jp.md @@ -163,6 +163,7 @@ ts-node MinecraftDiscordChatSync.ts <オプション1> <オプション2> ... | - | - | - | - | | pathToLog | ゲームサーバーのログファイルまでの相対パス | ../../logs/latest.log | string(「.log」で終了すること) | | logCharCode | ログファイルの文字コード。Windowsの日本語環境の場合は「shift-jis」に設定するとよい。 | utf-8 | string([サポートされている文字コード](https://github.com/ashtuchkin/iconv-lite/wiki/Supported-Encodings))| +| logInterval | ログの差分を確認する時間間隔(ミリ秒単位)。値を小さくするとログの変更への反応が機敏になるが、システムへの負荷が増大する。 | 100 | number | | locale | システムの使用言語 | en_us | string(ゲームの言語コードと同じ) | | token | ボットのトークン | | string | | listenChannels | システムがDiscordからのメッセージを検出するチャンネルのIDの一覧 | [] | string[] |