基础功能

Aug_Sakura

3344字约11分钟

2024-08-19

语言配置

注

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

本插件几乎所有的提示都可以进行自定义设置
想了解更多支持的变量，请前往变量支持页面查看
所有配置均支持 HEX 颜色，格式为 &#RRGGBB ，例如
消息共分三种类型：系统消息、游戏内消息 和 群内消息
系统消息：主要包括前缀和系统产生的消息
游戏内消息：主要是指令执行后，会发送到游戏或控制台内的消息
群内消息：主要是使用指令后，由机器人发送到群内的消息

系统消息

# 当前配置版本
version: 1.1

# 系统消息
# 支持hex颜色 格式为: &#RRGGBB
system:
  # 消息前缀
  prefix: "&7[ &#777777白名单 &7] >>> &f"

  # 你没有权限
  no-permission: "&c你没有足够的权限执行此命令"

  # 重载成功
  reload-success: "&a配置文件已经重新加载, 部分配置可能需要重新启动服务器才能生效"

  # 重载失败
  reload-failed: "&c重新配置文件时出现问题, 请查看控制台了解更多信息"

  # 踢出信息。在踢出没有绑定的玩家时显示的踢出消息
  # 默认提示消息使用的是 YAML 换行符，如果想使用单行消息可以设为 kick-message: "消息内容"
  # 可用变量：%player_name%
  kick-message: |-
    &f你不在小酒馆的名单中噢，可以加入QQ群进行申请
    &bQQ群 123456

游戏内消息

# 当前配置版本
version: 1.1

# 游戏内消息
# 游戏中的消息都在这里配置
game:
  # 未找到玩家绑定信息
  # 可用变量：%player_name%
  player-not-found: "&f未找到 QQ 或者该玩家没有白名单"

  # 玩家绑定的信息
  # 可用变量：%player_name% %player_qq%
  player-bind-info: "&f玩家 &a%player_name% &f绑定的QQ是 &a%player_qq%"

  # 绑定成功消息
  # 可用变量：%player_name% %player_qq%
  bind-success: "&a绑定成功 绑定ID: &f%player_name% &a绑定QQ:&f %player_qq%"

  # 绑定失败消息 长度问题
  bind-length-error: "&c指令格式不对哦, 正确的格式是/bwl bind ID QQ"

  # 绑定失败消息 ID问题
  # 可用变量：%player_name% %player_qq%
  id-bind-failed: "&c添加失败, 当前ID已经在白名单中啦, 绑定的QQ为 &f%player_qq%"

  # 绑定失败消息 QQ问题
  # 需要开启阻止已经绑定过 ID 的 QQ 重复绑定功能
  # 可用变量：%player_name% %player_qq%
  qq-bind-failed: "&c添加失败, 当前QQ已经在白名单中啦, 绑定的ID为 &f%player_name%"

  # 解绑成功消息
  # 多个ID将会用逗号分割
  # 可用变量：%player_name% %player_qq%
  unbind-success: "&a白名单已移除 移除ID &f%player_name% &a移除QQ &f%player_qq%"

  # 解绑失败消息 长度问题
  unbind-length-error: "&c指令格式不对哦, 正确的格式是/bwl unbind ID"

  # 解绑失败消息
  # 可用变量：%player_name% %player_qq%
  unbind-failed: "&c解绑失败, 当前ID可能没有在白名单中"

群内消息

# 当前配置版本
version: 1.1

# 群内消息
# 插件向群内发送的所有消息都在这里配置
group:
  # 未找到玩家绑定信息
  # 可用变量：%player_name%
  player-not-found: "未找到 QQ 或者该玩家没有白名单"

  # 绑定成功
  # 可用变量：%player_name% %player_qq%
  bind-success: |-
    白名单添加成功啦 ~
    绑定ID %player_name%
    绑定QQ %player_qq%

  # 管理员 绑定失败消息 长度问题
  # 需开启管理员模式
  admin-bind-length-error: "指令格式不对哦~ 正确的格式是：添加白名单 ID QQ"

  # 普通 绑定失败消息 长度问题
  # 需关闭管理员模式
  normal-bind-length-error: "指令格式不对哦~ 正确的格式是：申请白名单 ID"

  # 通用 绑定失败消息 ID问题
  # 可用变量：%player_name% %player_qq%
  id-bind-failed: |-
    添加失败, 当前ID已经在白名单中啦 ~
    绑定的QQ %player_qq%

  # 通用 绑定失败消息 QQ问题
  # 需要开启阻止已经绑定过 ID 的 QQ 重复绑定功能
  # 可用变量：%player_name% %player_qq%
  qq-bind-failed: |-
    添加失败, 当前QQ已经在白名单中啦 ~
    绑定的ID %player_name%

  # 解绑成功
  # 多个ID将会用逗号分割
  # 可用变量：%player_name% %player_qq%
  unbind-success: |-
    白名单已移除
    移除ID %player_name%
    移除QQ %player_qq%

  # 管理员 解绑失败消息 长度问题
  # 需开启管理员模式
  admin-unbind-length-error: "指令格式不对哦~ 正确的格式是：解除白名单 ID"

  # 普通 解绑失败消息 长度问题
  # 需关闭管理员模式
  normal-unbind-length-error: "指令格式不对哦~ 正确的格式是：解除白名单"

  # 解绑失败
  # 可用变量：%player_name% %player_qq%
  unbind-failed: |-
    解绑失败, 当前ID可能没有在白名单中
    解绑ID %player_name%
    解绑QQ %player_qq%

Geyser 支持

插件从 1.4 版本开始将支持 Geyser
只需要配置在 Geyser 中设置的前缀并开启支持即可
此功能将在使用 Geyser 时自动忽略设置的前缀

config.yml

# 当前配置版本
version: 1.5

# 插件配置
general:
  # Geyser 支持
  # 与 Geyser 中的设置对应
  # 如果不清楚的话请勿启用该功能
  geyser:
    # 是否启用 Geyser 支持
    enable: false
    # 设置的基岩版玩家名称前缀
    prefix: '.'

数据库配置

插件支持 MySQL 和 SQLite 两种数据库，数据库中存储了所有玩家的绑定信息，只有绑定过的玩家才可以进入服务器

config.yml

# 当前配置版本
version: 1.5

# 数据库配置 目前支持 sqlite 和 mysql
database:
  # 数据库类型
  type: sqlite
  # 数据库表前缀
  prefix: bwl_

  # mysql配置
  mysql:
    # 数据库地址
    url: 127.0.0.1
    # 数据库端口
    port: 3306
    # 数据库参数
    parameters: "?useSSL=false&serverTimezone=UTC&allowPublicKeyRetrieval=true"
    # 数据库用户名
    username: root
    # 数据库密码
    password: root
    # 数据库名称
    database: bistro

  # sqlite配置
  sqlite:
    # 数据库文件路径 插件目录：%plugin_folder%
    path: '%plugin_folder%/whitelist.db'

  # 数据库连接池设置 不清楚的话不要修改
  pool:
    # 连接池连接超时时间
    connection-timeout: 30000
    # 连接池最大生命周期
    max-lifetime: 1800000
    # 连接池空闲时间
    idle-timeout: 600000
    # 连接池空闲线程存活时间
    keep-alive-time: 0
    # 连接池最大连接数
    max-pool-size: 15
    # 连接池最小连接数
    min-pool-size: 5

查询绑定信息

查询绑定信息指令

/bwl query 玩家ID

此功能只能在游戏中使用，如果你想让玩家之间可以互相查看其绑定信息，请给予玩家对应权限

白名单功能

插件默认开启了白名单功能，只有绑定过 QQ 的玩家才可以进入服务器内

酒馆白名单-白名单

QQ群配置

机器人的所有功能基于 BistroBot 插件，如果服务器未安装该插件将自动关闭所有机器人相关功能，但依旧会保留基本的功能，例如查询绑定信息、白名单功能和所有指令操作
可以添加更多的 QQ 群并独立的对每个群进行配置

config.yml

# 当前配置版本
version: 1.5

# 群配置
# 不同 QQ 群可单独配置
group:
  # 群配置
  # 是否启用该群配置
  - enable: false
  
    # 群号
    group-id: 12345678
    
    # 对应的机器人 QQ 号
    bot-id: 1234567
    
    # 对应的管理员列表 可配置多个管理员
    # 请至少填写一个
    admins:
      - 123456
      
    # 阻止已经绑定过 ID 的 QQ 重复绑定
    # 例如：QQ123456 已经绑定了 ID1234567 那么 QQ123456 无法再次绑定其他 ID
    prevent-qq-rebind: true
    
    # 是否开启管理员独占模式
    # 如果开启，只有管理员才能执行绑定和解绑操作
    # 如果关闭，管理员和玩家都可以执行绑定和解绑操作，但需要区分管理员和玩家的绑定格式
    admin-only: true
    
    # 检测玩家绑定的 QQ 是否在群内，如果不在群内视为没有白名单
    # 注意，通过游戏指令添加的玩家将跳过检测
    # 如果单个玩家在多个群绑定过ID或拥有白名单 那么会对玩家所在的所有群进行检查 将会跳过没有开启群 开启检测的群中只要在其中一个群内就视为在群内
    check-qq-in-group: true

绑定模式

重要

注意，所有的绑定操作参数之间都默认使用空格分开

插件支持两种绑定模式：管理员模式 和 普通模式
管理员模式：管理员可对所有玩家进行白名单管理，管理员可以不是群聊的管理员
普通模式：所有在 QQ 群内的玩家均可以自行操作自己的绑定关系

config.yml

# 当前配置版本
version: 1.5

# 群配置
# 不同 QQ 群可单独配置
group:
  # 群配置
  # 是否启用该群配置
  - enable: false
  
    # 是否开启管理员独占模式
    # 如果开启，只有管理员才能执行绑定和解绑操作
    # 如果关闭，管理员和玩家都可以执行绑定和解绑操作，但需要区分管理员和玩家的绑定格式
    admin-only: true

自定义绑定解绑前缀

插件支持自定义绑定解绑前缀，与下方的绑定解绑账号功能对应

config.yml

# 当前配置版本
version: 1.5

# 插件配置
general:
  # 添加绑定消息前缀
  # 玩家需要发送“消息前缀 + 自己的ID”才会添加绑定
  # 例如：下方设置为“申请白名单”，玩家的ID是“123456”，则玩家需要在群内发送消息“申请白名单 123456”, 注意中间有一个空格
  # 如果是管理员，则管理员需要发送“消息前缀 + 玩家的ID + 玩家的QQ号”才会添加绑定
  # 例如：下方设置为“申请白名单”，玩家的ID是“123456”，玩家的QQ号是“123456789”，则管理员需要在群内发送消息“申请白名单 123456 123456789”, 注意中间有一个空格
  bind-command-prefix: "添加白名单"

  # 解除绑定消息前缀
  # 玩家需要发送“解除白名单”才会解除绑定, 注意:会删除所有该QQ绑定的ID
  # 如果是管理员，则管理员需要发送“消息前缀 + 玩家的ID”才会添加绑定
  # 例如：下方设置为“解除白名单”，玩家的ID是“123456”，则管理员需要在群内发送消息“解除白名单 123456”, 注意中间有一个空格
  unbind-command-prefix: "解除白名单"

绑定解绑账号/添加删除白名单

管理员模式下，将玩家 Aug_Sakura1 与其 QQ 进行绑定

添加白名单 Aug_Sakura1 12345678
这里的添加白名单为自行设置的自定义内容

管理员模式下，解除玩家 Aug_Sakura1 的绑定关系

解除白名单 Aug_Sakura1
这里的解除白名单为自行设置的自定义内容

普通模式下，将玩家 Aug_Sakura2 与其 QQ 进行绑定

添加白名单 Aug_Sakura2
这里的添加白名单为自行设置的自定义内容

普通模式下，解除玩家 Aug_Sakura2 的绑定关系

解除白名单
这里的解除白名单为自行设置的自定义内容

检测 QQ 是否在群内

除了基础的校验是否绑定功能以外，插件提供了检测绑定 QQ 是否在群内的设置，如绑定的 QQ 不在设置的群内，将会不允许进入服务器
如果你想让退群的玩家不能加入服务器，请开启此功能

config.yml

# 当前配置版本
version: 1.5

# 群配置
# 不同 QQ 群可单独配置
group:
  # 群配置
  # 是否启用该群配置
  - enable: false
  
    # 检测玩家绑定的 QQ 是否在群内，如果不在群内视为没有白名单
    # 注意，通过游戏指令添加的玩家将跳过检测
    # 如果单个玩家在多个群绑定过ID或拥有白名单 那么会对玩家所在的所有群进行检查 将会跳过没有开启群 开启检测的群中只要在其中一个群内就视为在群内
    check-qq-in-group: true

重复绑定

开启此功能后，在执行所有绑定操作时，将会对绑定的玩家 ID 进行校验，只有没有绑定过 QQ 的玩家才可以进行绑定
如果你想让玩家的 ID 与 QQ 号是一对一的，请开启此功能

config.yml

# 当前配置版本
version: 1.5

# 群配置
# 不同 QQ 群可单独配置
group:
  # 群配置
  # 是否启用该群配置
  - enable: false

    # 阻止已经绑定过 ID 的 QQ 重复绑定
    # 例如：QQ123456 已经绑定了 ID1234567 那么 QQ123456 无法再次绑定其他 ID
    prevent-qq-rebind: true