基础功能

Aug_Sakura

899字约3分钟

2024-08-19

语言设置

注

设置文件地址名称：config.yml
语言文件地址名称：lang/zh_CN.yml

本插件几乎所有的提示都可以进行自定义设置
所有配置均支持 HEX 颜色，格式为 &#RRGGBB ，例如

config.yml

# 当前配置版本
version: 1.0

# 插件配置
general:
  # 语言配置
  language: 'zh_CN'

zh_CN.yml

# 当前语言版本 请勿修改
version: 1.0

# 通用
general:
  # 插件前缀
  prefix: "&7[ &#777777机器人 &7] >>> &f"

# 指令
command:
  # 你没有权限
  no-permission: "&c你没有权限执行此操作"
  # 插件重载成功
  reload-config-success: "&a插件重载成功"
  # 插件重载失败
  reload-config-fail: "&c插件重载失败"

# 系统
# 以下信息仅会在控制台打印
system:
  # 插件加载失败
  load-config-fail: "插件配置加载失败"
  # 初始化工厂失败
  load-factory-fail: "初始化工厂失败"

# socket连接
# 以下信息仅会在控制台打印
socket:
  # 连接成功
  connect-success: "连接成功"
  # 连接异常
  connect-exception: "连接异常"
  # 断开连接
  disconnect: "断开连接"
  # 重连
  reconnect: "正在尝试重新连接..."
  # 重连失败
  reconnect-fail: "重连失败, 超过最大重连次数"
  # socket 发送信息后响应异常
  send-exception: "发送信息后响应异常"

调试模式

插件支持开启调试模式，调试模式下，本插件的所有操作均会打印在控制台中，包括但不限于接收到的群消息、发送的群消息、socket连接信息、socket重连信息等
如果插件无法正常运行，请尝试开启调试模式查看原因

config.yml

# 当前配置版本
version: 1.0

# 插件配置
general:
  # 调试模式
  debug: true

Socket重连设置

当机器人设置开启重连后，每当插件socket连接断开时，都会尝试重新进行连接

config.yml

# 当前配置版本
version: 1.0

# 重连配置
# 当socket掉线时重连配置
reconnect:
  # 最大重连次数
  max-reconnect-times: 5
  # 重连间隔 单位秒
  reconnect-interval: 10

请求设置

当插件调用机器人接口，例如获取群列表等信息时，接收返回信息的配置

config.yml

# 当前配置版本
version: 1.0

# 请求配置
request:
  # 处理信息响应超时时间 单位秒
  timeout: 10

机器人设置

插件支持多机器人和多机器人类型接入，并可对单个机器人进行配置
自动连接：当插件启动时自动连接机器人
断开重连：当机器人 socket 断开时自动根据设置的重连配置尝试重新连接
对接机器人方式请查看常见问题

config.yml

# 当前配置版本
version: 1.0

# 机器人配置 多机器人配置
# 当前类型仅支持 oneBot
bot:
  # 机器人1配置
  - id: bot1
    # 是否启用当前机器人
    enable: true
    # 是否在启动插件时自动连接
    auto-connect: true
    # 是否启用断开重连
    auto-reconnect: true
    # 机器人类型
    type: "oneBot"
    # 连接的socket地址
    url: "ws://127.0.0.1:13001"
    # 机器人token
    # 默认为空
    access-token: ""
  # 机器人2配置
  - id: bot2
    # 是否启用当前机器人
    enable: false
    # 是否在启动插件时自动连接
    auto-connect: true
    # 是否启用断开重连
    auto-reconnect: true
    # 机器人类型
    type: "oneBot"
    # 连接的socket地址
    url: "ws://127.0.0.1:6700"
    # 机器人token
    # 默认为空
    access-token: ""