机器人的配置文件(config.toml
)储存在 ./config/
目录下。可使用 ~config
命令修改配置文件。
配置文件支持热更新,即在修改配置文件后立即生效,但部分配置项仍需重载模块或重启后生效。
如果你不需要某些属性,请将对应的键直接删除,请勿在文件中留空。
默认配置文件请查阅此处。
属性
secret
在表 secret
储存的内容为私有内容,当机器人发送的消息中存在这些内容时会被自动拦截。
属性 | 使用模块 | 默认值 | 描述 |
---|---|---|---|
db_path
|
"sqlite:///database/save.db" | 数据库连接串,用于存储用户数据。 | |
check_access_key_id
|
调用阿里云内容安全服务 API 时需要的 AccessKey ID。 | ||
check_access_key_secret
|
调用阿里云内容安全服务 API 时需要的 AccessKey Secret。 | ||
web_render
|
Webrender 的地址(IP 或域名)及端口。 | ||
proxy
|
代理服务的地址(IP 或域名)及端口。 | ||
qq_bot_appid
|
QQ 官方机器人 AppID。 | ||
qq_bot_secret
|
QQ 官方机器人 AppSecret。 | ||
discord_token
|
Discord 机器人令牌。 | ||
kook_token
|
KOOK 机器人令牌。 | ||
telegram_token
|
Telegram 机器人令牌。 | ||
matrix_device_id
|
Matrix 机器人设备 ID。 | ||
matrix_token
|
Matrix 机器人令牌。 | ||
matrix_megolm_backup_passphrase
|
Matrix 机器人的 Megolm 备份密码短语。 | ||
curseforge_api_key
|
mod_dl
|
Curseforge API 密钥。 | |
diving_fish_developer_token
|
maimai maimai_regex
|
Diving-Fish 查分器开发者令牌。 | |
exchange_rate_api_key
|
exchange_rate petal
|
ExchangeRate-API 密钥。 | |
openai_api_key
|
ask summary
|
OpenAI API 密钥。 | |
osu_api_key
|
osu
|
Osu! API 密钥。 | |
wolfram_alpha_appid
|
ask wolframalpha
|
WolframAlpha API 的 App ID。 | |
jwt_secret
|
config
属性 | 使用模块 | 默认值 | 描述 |
---|---|---|---|
api_port
|
5000 | 机器人 API 端口。 | |
base_superuser
|
["QQ|2596322644",] | 机器人主超级用户,输入用户对应的 ID。可使用 ~whoami 命令查看自己的 ID。
| |
debug
|
false | 设置是否启用 Logger 的 Debug 模式。 | |
cache_path
|
"./cache/" | 机器人缓存路径。 | |
command_prefix
|
["~", "~",] | 默认命令前缀列表。 | |
confirm_command
|
["是", "对", "對", "yes", "Yes", "YES", "y", "Y",] | 命令确认词列表。 | |
disabled_bots
|
["",] | 机器人禁用的端列表,端名称为 ./bots/ 目录下对应的文件名。
| |
report_targets
|
["",] | 机器人发送事件回报的对话列表。 | |
locale
|
"zh_cn" | 机器人默认使用的语言。 | |
timezone_offset
|
"+8" | 机器人默认时区偏移量。 | |
bug_report_url
|
"https://s.wd-ljt.com/botreportbug" | 汇报错误的网址。 | |
donate_url
|
help
|
"https://afdian.com/a/teahouse" | 赞助的网址。 |
help_url
|
help
|
"https://bot.teahouse.team" | 帮助文档的网址。 |
help_page_url
|
help
|
"https://bot.teahouse.team/wiki/${module}" | 具体模块的帮助文档网址,${module} 会被替换为模块名称。留空则将 help_url 之后加入模块名称。
|
issue_url
|
"https://github.com/Teahouse-Studios/akari-bot/issues/new/choose" | 提交问题(如封禁申诉等)的网址。 | |
locale_url
|
locale
|
"https://www.crowdin.com/project/akari-bot" | 提供多语言贡献的网址。 |
wiki_whitelist_url
|
wiki
|
"https://s.wd-ljt.com/botwhitelist" | 申请 Wiki 白名单的网址。 |
qq_account
|
2314163511 | 机器人的 QQ 号。 | |
qq_host
|
"127.0.0.1:11451" | 用于 go-cqhttp 反向连接的 IP 地址及端口。 | |
qq_frame_type
|
"go-cqhttp" | 告诉机器人目前正在使用的 QQ 框架。 | |
qq_disable_temp_session
|
false | 设置是否禁用机器人在 QQ 的临时会话。 | |
qq_allow_approve_friend
|
true | 设置是否在 QQ 上自动同意普通用户加好友申请。 | |
qq_allow_approve_group_invite
|
true | 设置是否在 QQ 上自动同意普通用户加群申请。 | |
qq_enable_listening_self_message
|
false | 设置是否启用 QQ 的自我消息处理。 | |
qq_limited_emoji
|
false | QQ 被限制发送消息时回应的表情 ID。 | |
qq_typing_emoji
|
false | QQ 正在发送消息时回应的表情 ID。 | |
qq_bot_enable_send_url
|
false | 设置是否允许 QQ 官方机器人端发送 URL。 | |
qq_bot_private
|
false | 设置 QQ 官方机器人是否为私域机器人。 | |
allow_request_private_ip
|
false | 设置是否允许私有 IP 请求网站。 | |
allow_reload_base
|
module
|
false | 设置是否允许重新加载基础模块。 |
no_confirm
|
false | 设置是否跳过确认消息直接执行命令。 | |
slower_schedule
|
false | 设置是否让计划任务模块使用更长的时间间隔执行。 | |
use_secrets_random
|
true | 设置机器人内置的随机类是否使用 secrets 库。
| |
enable_commit_url
|
true | 设置是否显示版本 Commit URL。 | |
enable_dirty_check
|
true | 设置是否启用屏蔽词检查。 | |
enable_rickroll
|
true | 设置请求被拦截时是否输出内容。 | |
rickroll_msg
|
"https://wdf.ink/6OUp" | 请求被拦截时输出的内容。 | |
enable_joke
|
设置是否启用内置愚人节玩笑。若留空则会在 4 月 1 日启用愚人节玩笑。 | ||
shuffle_rate
|
0.1 | 设置愚人节玩笑的文字打乱频率,输入为 0-1 之间。 | |
enable_urlmanager
|
wiki wiki_audit
|
true | 设置是否启用 URL 管理,禁用后无法使用 wiki_audit 命令。
|
enable_tos
|
false | 设置是否启用内置的违反服务条款检查。 | |
tos_waring_counts
|
5 | 设置用户违反服务条款的最高警告次数。 | |
tos_temp_ban_time
|
300 | 设置用户违反服务条款后的临时限制时间。 | |
enable_analytics
|
analytics
|
true | 设置是否启用 analytics 模块相关命令。
|
enable_eval
|
eval
|
true | 设置是否启用 eval 模块相关命令。
|
enable_petal
|
petal
|
true | 设置是否启用花瓣。 |
enable_get_petal
|
petal
|
true | 设置是否启用获取花瓣途径。 |
gained_petal_limit
|
petal
|
10 | 设置一天内获得的花瓣数量限制。 |
lost_petal_limit
|
petal
|
5 | 设置一天内失去的花瓣数量限制。 |
coin_limit
|
coin
|
10000 | 一次可投掷的硬币最大个数。 |
coin_faceup_rate
|
coin
|
4994 | 硬币正面朝上的概率,按一万分之几计算。 |
coin_facedown_rate
|
coin
|
4994 | 硬币反面朝上的概率,按一万分之几计算。 |
dice_limit
|
dice
|
100 | 一次可投掷的骰子最大个数。 |
dice_roll_limit
|
dice
|
10 | 投掷骰子的最大次数。 |
dice_output_count
|
dice
|
50 | 输出时的最大数据量,超过则无法正常显示。 |
dice_output_len
|
dice
|
200 | 输出时的最大长度,超过则无法正常显示。 |
dice_detail_count
|
dice
|
5 | 多次投掷骰子的总数,超过则不再显示详细信息。 |
dice_count_limit
|
dice
|
10 | 骰子表达式最大的项数。 |
ncmusic_enable_card
|
ncmusic
|
false | 设置是否使用 QQ 自带的音乐卡片输出内容。 |
wordle_disable_image
|
wordle
|
false | 设置是否禁用图片版本游戏板。 |
matrix_device_name
|
Matrix 机器人设备名称。 | ||
matrix_homeserver
|
Matrix 服务器 URL。 | ||
matrix_user
|
"@akaribot:matrix.org" | Matrix 机器人用户 ID(含@ 与: )。
| |
web_render_local
|
本地 Webrender 的地址,若与 web_render 相同则留空。
|
技术性 | ||
---|---|---|
部署 | ||
使用 | ||
开发 |