From aaad6a3e41ae8615d3dd7dc8913bf6e80657c3e0 Mon Sep 17 00:00:00 2001 From: m1sk9 Date: Sat, 23 Sep 2023 02:43:04 +0900 Subject: [PATCH] docs: fix FEATURE env --- .github/CONTRIBUTING.md | 2 +- packages/bot/README.md | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d80872dd..64d61d4f 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -320,7 +320,7 @@ it('use case of hukueki', async () => { 環境変数 `FEATURE` で有効にする機能を指定できます。 -複数の機能を起動するにはコンマで区切ります。指定しない場合は全ての機能が有効になります。 +以下の文字列をコンマで区切りで与えると、それら複数の機能を有効にして起動します。指定しない場合はスラッシュコマンドを除く全ての機能が有効になります。 - `"MEESAGE_CREATE"` - メッセージ作成関連の機能 - `"MESSAGE_UPDATE"` - メッセージ更新関連の機能 diff --git a/packages/bot/README.md b/packages/bot/README.md index 18fc3cae..2eb5f935 100644 --- a/packages/bot/README.md +++ b/packages/bot/README.md @@ -17,14 +17,14 @@ Discord Bot 本体を提供するパッケージ。 起動時にデフォルト値が存在する変数の値が指定されていない場合は、そのデフォルト値が使われます。 -| 変数名 | 説明 | 必須 | -| ----------------- |----------------------------------------------------------------------------------------------------------------------------------------------------------------| ----- | -| `DISCORD_TOKEN` | BOT のトークン | True | -| `MAIN_CHANNEL_ID` | VoiceDiff(VC 入退室ログ)を送信する **テキスト** チャンネルの ID | True | -| `APPLICATION_ID` | BOT のアプリケーション ID | True | -| `GUILD_ID` | 限界開発鯖の ID | True | -| `PREFIX` | コマンドの接頭辞、デフォルト値は `"!"` | False | -| `FEATURE` | 有効にする機能のカンマ区切り文字列、デフォルト値は全ての機能。`"MESSAGE_CREATE"`, `"MESSAGE_UPDATE"`, `"COMMAND"`, `"VOICE_ROOM"`, `"ROLE"`, `"EMOJI"`, `"SLASH_COMMAND"`, `"MEMBER"` を組み合わせ可能。 | False | +| 変数名 | 説明 | 必須 | +| ----------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ----- | +| `DISCORD_TOKEN` | BOT のトークン | True | +| `MAIN_CHANNEL_ID` | VoiceDiff(VC 入退室ログ)を送信する **テキスト** チャンネルの ID | True | +| `APPLICATION_ID` | BOT のアプリケーション ID | True | +| `GUILD_ID` | 限界開発鯖の ID | True | +| `PREFIX` | コマンドの接頭辞、デフォルト値は `"!"` | False | +| `FEATURE` | 有効にする機能のカンマ区切り文字列、デフォルト値はスラッシュコマンドを除く全ての機能。`"MESSAGE_CREATE"`, `"MESSAGE_UPDATE"`, `"COMMAND"`, `"VOICE_ROOM"`, `"ROLE"`, `"EMOJI"`, `"SLASH_COMMAND"`, `"MEMBER"` を組み合わせ可能。 | False | ## インストール