配置文件

机器人的配置文件（config.toml）储存在 ./config/ 目录下。可使用 ~config 命令修改配置文件。

配置文件支持热更新，即在修改配置文件后立即生效，但部分配置项仍需重载模块或重启后生效。

如果你不需要某些属性，请将对应的键直接删除，请勿在文件中留空。

刚开始使用的机器人拥有以下默认配置：

[secret]
db_path = "mysql+pymysql://"
check_accessKeyId =
check_accessKeySecret =
web_render =
proxy =
dc_token =
tg_token =
kook_token =
matrix_device_id =
matrix_token =
matrix_megolm_backup_passphrase =
openai_api_key =
curseforge_api_key =
exchange_rate_api_key =
wolfram_alpha_appid =
jwt_secret =

[cfg]
api_port = 5000
base_superuser = ["QQ|2596322644",]
debug = false
cache_path = "./cache/"
command_prefix = ["~", "～",]
confirm_command = ["是", "对", "對", "yes", "Yes", "YES", "y", "Y",]
disabled_bots = ["",]
report_targets = ["",]
use_shamrock = false
locale = "zh_cn"
timezone_offset = "+8"
bug_report_url = "https://s.wd-ljt.com/botreportbug"
donate_url = "https://afdian.net/@teahouse"
help_url = "https://bot.teahouse.team"
issue_url = "https://github.com/Teahouse-Studios/bot/issues/new/choose"
locale_url = "https://www.crowdin.com/project/akari-bot"
wiki_whitelist_url = "https://s.wd-ljt.com/botwhitelist"
web_render_local =
qq_account = 2314163511
qq_host = "127.0.0.1:11451"
qq_disable_temp_session = false
qq_allow_approve_friend = true
qq_allow_approve_group_invite = true
qq_enable_listening_self_message = false
matrix_device_name = 
matrix_homeserver = 
matrix_user = "@akaribot:matrix.org"
allow_request_private_ip = false
allow_reload_base = false
no_confirm = false
slower_schedule = false
enable_dirty_check = true
enable_rickroll = true
rickroll_msg = "https://wdf.ink/6OUp"
??? =
shuffle_rate = 0.1
enable_urlmanager = true
enable_tos = false
tos_warning_counts = 5
tos_temp_ban_time = 300
enable_analytics = true
enable_eval = true
enable_petal = true
enable_get_petal = true
gained_petal_limit = 10
lost_petal_limit = 5
coin_limit = 10000
coin_faceup_rate = 4997
coin_facedown_rate = 4997
dice_limit = 100
dice_roll_limit = 10
dice_output_count = 50
dice_output_len = 200
dice_detail_count = 5
dice_count_limit = 10
wordle_disable_image = false

属性

secret

在 secret 类中填入的内容，当机器人发送的消息中存在时会被拦截。

属性	使用模块	类型	默认值	描述
db_path		str	"mysql+pymysql://"	数据库路径，用于存储用户数据。
check_accessKeyId		str		调用阿里云内容安全服务 API 时需要的 AccessKey ID。
check_accessKeySecret		str		调用阿里云内容安全服务 API 时需要的 AccessKey Secret。
web_render		str		Webrender 的地址（IP 或域名）及端口。
proxy		str		代理服务的地址（IP 或域名）及端口。
dc_token		str		Discord 机器人令牌。
kook_token		str		KOOK 机器人令牌。
tg_token		str		Telegram 机器人令牌。
matrix_device_id		str		Matrix 机器人设备 ID。
matrix_token		str		Matrix 机器人令牌。
matrix_megolm_backup_passphrase		str		Matrix 机器人的 Megolm 备份密码短语。
openai_api_key	ask summary	str		OpenAI API 密钥。
curseforge_api_key	mod_dl	str		Curseforge API 密钥。
exchange_rate_api_key	exchange_rate petal	str		ExchangeRate-API 密钥。
wolfram_alpha_appid	ask wolframalpha	str		WolframAlpha API 的 App ID。
jwt_secret		str

config

属性	使用模块	类型	默认值	描述
api_port		int	5000	机器人 API 端口。
base_superuser		list, str	["QQ|2596322644",]	机器人主超级用户，输入用户对应的 ID。可使用 ~whoami 命令查看自己的 ID。
debug		bool	false	设置是否启用 Logger 的除错模式。
cache_path		str	"./cache/"	图片等的缓存路径。
command_prefix		list	["~", "～",]	默认命令前缀列表。
confirm_command		list	["是", "对", "對", "yes", "Yes", "YES", "y", "Y",]	命令确认词列表。
disabled_bots		list	["",]	机器人禁用的平台列表，平台名称为 ./bots/ 目录下对应的文件名。
report_targets		list	["",]	机器人发送事件回报的对话列表。
use_shamrock		bool	false	设置是否使用了 OpenShamrock，以修改部分运行方式。
locale		str	"zh_cn"	机器人默认使用的语言。
timezone_offset		str	"+8"	机器人默认时区偏移量。
bug_report_url		str	"https://s.wd-ljt.com/botreportbug"	汇报错误的网址。
donate_url	help	str	"https://afdian.net/@teahouse"	赞助的网址。
help_url	help	str	"https://bot.teahouse.team"	帮助文档的网址。
issue_url		str	"https://github.com/Teahouse-Studios/bot/issues/new/choose"	提交问题（如封禁申诉等）的网址。
locale_url	locale	str	"https://www.crowdin.com/project/akari-bot"	提供多语言贡献的网址。
wiki_whitelist_url	wiki	str	"https://s.wd-ljt.com/botwhitelist"	申请 Wiki 白名单的网址。
web_render_local		str		本地 Webrender 的地址，若与 web_render 相同则留空。
qq_account		int, str	2314163511	机器人的 QQ 号。
qq_host		str	"127.0.0.1:11451"	用于 go-cqhttp 反向连接的 IP 地址及端口。
qq_disable_temp_session		bool	false	设置是否禁用机器人在 QQ 的临时会话。
qq_allow_approve_friend		bool	true	设置是否在 QQ 上自动同意普通用户加好友申请。
qq_allow_approve_group_invite		bool	true	设置是否在 QQ 上自动同意普通用户加群申请。
qq_enable_listening_self_message		bool	false	设置是否启用 QQ 的自我消息处理。
matrix_device_name		str		Matrix 机器人设备名称。
matrix_homeserver		str		Matrix 服务器 URL。
matrix_user		str	"@akaribot:matrix.org"	Matrix 机器人用户 ID（含@与:）。
allow_request_private_ip		bool	false	设置是否允许私有 IP 请求网站。
allow_reload_base	module	bool	false	设置是否允许重新加载基础模块。
no_confirm		bool	false	设置是否跳过确认消息直接执行命令。
slower_schedule		bool	false	设置是否让计划任务模块使用更长的时间间隔执行。
enable_dirty_check		bool	true	设置是否启用屏蔽词检查。
enable_rickroll		bool	true	设置请求被拦截时是否输出内容。
rickroll_msg		str	"https://wdf.ink/6OUp"	请求被拦截时输出的内容。
???		bool		设置是否启用内置愚人节玩笑。若留空则会在 4 月 1 日启用愚人节玩笑。
shuffle_rate		float, int	0.1	设置愚人节玩笑的文字打乱频率，输入为 0-1 之间。
enable_urlmanager	wiki wiki_audit	bool	true	设置是否启用 URL 管理，禁用后无法使用 wiki_audit 命令。
enable_tos		bool	false	设置是否启用内置的违反服务条款检查。
tos_waring_counts		int	5	设置用户违反服务条款的最高警告次数。
tos_temp_ban_time		int	300	设置用户违反服务条款后的临时限制时间。
enable_analytics	analytics	bool	true	设置是否启用 analytics 模块相关命令。
enable_eval	eval	bool	true	设置是否启用 eval 模块相关命令。
enable_petal	petal	bool	true	设置是否启用花瓣。
enable_get_petal	petal	bool	true	设置是否启用获取花瓣途径。
gained_petal_limit	petal	int	10	设置一天内获得的花瓣数量限制。
lost_petal_limit	petal	int	5	设置一天内失去的花瓣数量限制。
coin_limit	coin	int	10000	一次可投掷的硬币最大个数。
coin_faceup_rate	coin	int	4994	硬币正面朝上的概率，按一万分之几计算。
coin_facedown_rate	coin	int	4994	硬币反面朝上的概率，按一万分之几计算。
dice_limit	dice	int	100	一次可投掷的骰子最大个数。
dice_roll_limit	dice	int	10	投掷骰子的最大次数。
dice_output_count	dice	int	50	输出时的最大数据量，超过则无法正常显示。
dice_output_len	dice	int	200	输出时的最大长度，超过则无法正常显示。
dice_detail_count	dice	int	5	多次投掷骰子的总数，超过则不再显示详细信息。
dice_count_limit	dice	int	10	骰子表达式最大的项数。
wordle_disable_image	wordle	bool	false	设置是否禁用图片版本游戏板。