ボットの設定について
本ボットの設定ファイルは、.envとconfig.jsonの2ファイルです。これらに各種設定を記述します。
各サンプルファイルを参考にして各自で作成してください。
.envファイル
こちらには主にトークンなどの認証情報を記述します。
.env.sampleがサンプルファイルとなっていますので、コピー&リネームしてお使いください。
なお、.envファイルを使わず、環境変数でも代用することができます。都合の良い方をお使いください。
replitなど、環境変数の設定方法が特殊な場合もあるため、replitのようなホスティングサービスを使用する際は、利用するサービスのヘルプページをご覧ください。
TOKEN
ボットのトークンです。Discord Developer Portalから取得してください。
CSE_KEY
歌詞検索に使用するGoogle Custom Searchのkeyです。(任意指定)
GAS_URL
「キューやループの有効無効等のデータのバックアップ」に使用するデータベースサーバーのURLです。(任意指定)
サーバーの仕様等についてはバックアップを参照してください。
GAS_TOKEN
「キューやループの有効無効等のデータのバックアップ」に使用するデータベースサーバーのトークンです。(任意指定)
サーバーの仕様等についてはバックアップを参照してください。
config.jsonファイル
こちらにはボットの設定情報などを記述します。
任意指定の設定に関しては、値をnullにしてください("null"ではなくnull)
例:
{
"proxy": null
}
config.json.sampleがサンプルファイルとなっていますので、コピー&リネームしてお使いください。
(カッコ内は設定値の、TypeScript表記の"型"です。)
adminId (string|string[]|null)
管理人のユーザーのIDを指定します。複数の管理人がいる場合は、配列で指定してください。設定しない場合はnull
debug (boolean)
デバッグ用の構成で起動するかを指定します。通常であればfalseに設定してください。
デバッグ用構成を有効にすると、ボットの動作が以下のように変更されます。
- 出力されるログの量が増えます。
- 権限がある場合、ログが
logsフォルダーにファイルとして出力されます。 - 想定されていないエラーが発生した場合、ボットはクラッシュし、プログラムが終了します。
このオプションは、Node.jsの--inspectオプションとはまったく別であるため、このオプションを使用しても、デバッガーを接続することはできません。
maintenance (boolean)
メンテナンス用の構成で起動するか。メンテナンス用構成では、adminIdで指定した管理者以外からのコマンドをすべて無視するようになります。
errorChannel (string|null)
エラーレポートを送信するテキストチャンネルのID。設定しない場合はnull
proxy (string|null)
プロキシを使用する場合はそのURL。設定しない場合はnull
prefix (string|null|undefined)
指定する場合は一文字でデフォルトプレフィックスを指定してください。(任意指定)
こちらは互換性のため、プロパティ自体が省略されていても動作するようになっています。
webserver (boolean|undefined)
ウェブサーバーを起動するか(任意指定)
こちらは互換性のため、プロパティ自体が省略されていても動作するようになっています。
bgm (object|undefined)
このプロパティを設定することで、自動的にBGMを再生するように構成できます。(任意指定)
詳細は、BGM機能を参照してください。
こちらは互換性のため、プロパティ自体が省略されていても動作するようになっています。
noMessageContent (boolean|undefined)
Message Content IntentがDiscord Developers Portalで無効になっている場合は、trueに設定してください。(任意指定)
デフォルトはfalseです。
こちらは互換性のため、プロパティ自体が省略されていても動作するようになっています。
twentyFourSeven (string[]|undefined)
参加しているユーザーがボイスチャンネルから退出しても、再生を一時停止しないボイスチャンネルのIDを配列で指定します。(任意指定)
詳細は、24/7再生機能を参照してください。
こちらは互換性のため、プロパティ自体が省略されていても動作するようになっています。
alwaysTwentyFourSeven (boolean|undefined)
参加しているユーザーがボイスチャンネルから退出しても、再生を一時停止しない場合にはtrueに設定します。(任意指定)
このオプションがtrueの場合、上のtwentyFourSevenは常に無視されます。
詳細は、24/7再生機能を参照してください。
こちらは互換性のため、プロパティ自体が省略されていても動作するようになっています。
設定はこれで以上となります。