• 欢迎来到小可 · Wiki,人人可编辑的,多平台聊天机器人“小可”的官方文档资源。
  • 小可很可爱,请给我们打钱
  • 原 MkDocs 已迁入本站。若发现 404 属正常现象,请点击左上角搜索您想要的模块。

配置文件

来自小可 · Wiki,人人可编辑的,QQ机器人“小可”的官方文档资源

机器人的配置文件(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 相同则留空。
Cookie帮助我们提供我们的服务。通过使用我们的服务,您同意我们使用cookie。