Skip to content

Commit

Permalink
READMEの追記
Browse files Browse the repository at this point in the history
  • Loading branch information
Gakuto1112 committed Dec 12, 2023
1 parent a89ae1b commit 5d31b56
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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[] |
Expand Down
1 change: 1 addition & 0 deletions .github/README_jp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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[] |
Expand Down

0 comments on commit 5d31b56

Please sign in to comment.