Skip to content

Configuration Preference

Ljzd-PRO edited this page Jan 23, 2024 · 12 revisions

⚙️ 插件偏好设置 class Preference

在 nonebot 目录下 data/nonebot-plugin-mystool/configV2.json 中的 preference 更改

Note

>=v1.0.0, <v2.0.0 插件配置包含于 plugin_data.json
< v1.0.0 插件配置文件为 pluginConfig.json


encoding

说明

文件读写编码。

一般不需要更改。

默认值

"utf-8"


max_user

说明

最多支持的 QQ 用户数量。防止用户过多,导致风控。

0 为不限制

默认值

0


add_friend_accept

说明

是否自动同意好友申请。

默认值

true


add_friend_welcome

说明

用户添加机器人为好友以后,是否自动发送使用指引信息。

默认值

true


command_start

说明

插件内部命令头(若为 "" 空字符串则不启用)。

如果你有安装其他插件,并且存在冲突的命令,例如其他插件和本插件都有 /登录 命令
那么你需要设置该选项,例如你可以设置为 "mt ",然后本插件所有的命令都需要有/mt 的开头

例如 /mt 登录/mt 商品 ...

此处使用了 NoneBot2 默认命令开头符号 /

默认值

""


plugin_name

说明

插件名(为模块名字,或于 plugins 目录手动加载时的目录名)。

如果你是使用 📃 脚手架或者 PyPI 安装 的,则不需要更改。

默认值

"nonebot_plugin_mystool"


⬇️ 以下是 日志相关 设置 ⬇️


log_head

说明

日志开头字符串(若为 "" 空字符串则不启用)。

未来可能会弃用。

只有把插件放进 plugins 目录手动加载时才需要设置
因为插件于 plugins 目录加载时,输出的日志不会有插件名称的标记,容易与其他插件的日志混淆

似乎从 nonebot2 哪个版本开始已经修复了,如果你用的是最新版 nonebot2,则不需要更改此设置

如果要使用本项设置的话,一个样例是 "mysTool: "

默认值

""


enable_log_output

说明

是否输出日志到文件。

若插件于 plugins 目录加载时,需要设置 📃log_head 才能筛选出本插件的日志并保存

开启可以方便以后出错了排查问题
关闭也问题不大

默认值

true


log_path

说明

日志保存路径,默认在机器人根目录下的 data/nonebot-plugin-mystool 里。

默认值

PATH / "mystool.log

PATH 定义:

from pathlib import Path

ROOT_PATH = Path(__name__).parent.absolute()
'''NoneBot2 机器人根目录'''
PATH = ROOT_PATH / "data" / "nonebot-plugin-mystool"

log_rotation

说明

单个日志文件的记录时长(需要按照格式设置)。
超出时间后将会自动创建新的日志文件。

与上一项配置有关。

  • 格式要求(数据类型):
import datetime
from typing import Union

log_rotation: Union[str, int, datetime.time, datetime.timedelta]

如果你不了解以上格式信息,可以直接效仿默认值来写。

默认值

"1 week"


⬆️ 以上是 日志相关 设置 ⬆️


ntp_server

说明

已弃用


max_retry_times

说明

网络请求失败后最多重试次数。

需要注意,如果你配置了人机验证打码平台,该项设置的值必须大于等于 2

一般不需要更改。

默认值

5


⬇️ 以下是 冷却、超时时间 设置 ⬇️


sleep_time

说明

任务操作冷却时间(如米游币任务)。

  • 单位: 秒

如果你担心米游社风控,可以设置为较长的时间

默认值

2


retry_interval

说明

网络请求出错的重试冷却时间。

  • 单位: 秒

一般不需要更改。

默认值

3


timeout

说明

网络请求超时时间(若为 null 则不启用)

  • 单位: 秒

一般不需要更改。

默认值

null


⬆️ 以上是 冷却、超时时间 设置 ⬆️


github_proxy

说明

GitHub 代理加速服务器(若为 "" 空字符串则不启用)。

用于在缺少字体的时候从 GitHub 下载开源字体
Source Han Sans 思源黑体
https://github.com/adobe-fonts/source-han-sans

一般不需要更改。

默认值

"https://ghproxy.com/"


plan_time

说明

每日自动签到和米游社任务的定时任务执行时间,格式为 HH:MM (时:分)

建议改一个时间,降低风控概率

默认值

"00:30"


resin_interval

说明

每次检查原神便笺间隔

  • 单位: 分钟

默认值

60


exchange_thread_count

说明

米游币商品兑换线程数。

为了应对网络问题,采用了异步多线程。

一般不需要更改。

默认值

2


exchange_latency

说明

同一线程下,每个兑换请求之间的间隔时间。

一般不需要更改。

默认值

(0, 0.5)


exchange_duration

说明

兑换持续时间随机范围(单位:秒;类型:float

一般不需要更改。

默认值

5


timezone

说明

兑换时间文本显示时区,默认使用上海时区。

如切换到 UTC 时区,则显示的时间会比上海时间早8小时,而实际兑换计划的执行时间不受影响。

一般不需要更改。

默认值

Asia/Shanghai


geetest_url

说明

  • 类型为 string

极验 Geetest 人机验证打码平台接口URL地址,用于绕过游戏签到可能遇到的人机验证。

接口应当符合以下规范:

  • 请求方式:POST
  • 请求数据类型:JSON
  • 请求数据格式:参考 📃geetest_json
  • 返回数据类型:JSON
  • 返回数据格式:
    {
        "data": {
            "result": "fail/...",
            "validate": "[极验验证返回的 validate 数据]"
        }
    }

默认值

无,为可选项。


geetest_params

说明

  • 类型为 object

极验 Geetest 人机验证打码平台接口URL参数,可根据你使用的平台API文档,在此处配置API密钥等。

例如:

{
  "user_id": "myUserIDXXX",
  "token": "myUserTokenXXX"
}

实际发出的人机验证请求URL: https://example.com/api/geetest?user_id=myUserIDXXX&token=myUserTokenXXX

默认值

无,为可选项。


geetest_json

说明

可选。极验 Geetest 人机验证打码平台接口请求发出的 JSON 模板,与 📃geetest_url 相对应。

JSON 模板中的 {gt}{challenge} 为占位符,在发出网络请求时将会被替换为极验人机验证任务的 gt 和 challenge 数据。

默认值

{
  "gt": "{gt}",
  "challenge": "{challenge}"
}

override_device_and_salt

说明

可选。是否读取插件数据文件中的 device_config 设备配置 和 salt_config 配置而不是默认配置

一般情况不建议开启

具体使用方法请参考 📃DeviceConfig📃SaltConfig

默认值

false


enable_blacklist

说明

是否启用用户黑名单,启用后将禁止 📃blacklist_path 内的用户进行登录操作。

默认值

false


blacklist_path

说明

用户黑名单路径,文件格式为TXT文本格式。
每行填写一个用户ID(可以是QQ号也可以是QQ频道用户ID)
可随时进行修改,不需要重启NoneBot机器人即可生效
默认不会创建该文本文件,需要手动进行创建。

默认值

data/nonebot-plugin-mystool/blacklist.txt


enable_whitelist

说明

是否启用用户白名单,启用后只有 📃whitelist_path 内的用户可进行登录操作。

默认值

false


whitelist_path

说明

用户白名单路径,文件格式为TXT文本格式。
每行填写一个用户ID(可以是QQ号也可以是QQ频道用户ID)
可随时进行修改,不需要重启NoneBot机器人即可生效
默认不会创建该文本文件,需要手动进行创建。

默认值

data/nonebot-plugin-mystool/whitelist.txt


enable_admin_list

说明

是否启用管理员名单,启用后 📃admin_list_path 内的用户可为指定用户或全部用户执行米游社任务 / 游戏签到。

具体命令用法可参考 📃米游币任务📃游戏签到

默认值

false


admin_list_path

说明

管理员名单路径,文件格式为TXT文本格式。
每行填写一个用户ID(可以是QQ号也可以是QQ频道用户ID)
可随时进行修改,不需要重启NoneBot机器人即可生效
默认不会创建该文本文件,需要手动进行创建。

默认值

data/nonebot-plugin-mystool/admin_list.txt

Clone this wiki locally