Skip to content

fR0Z863xF/nonebot-plugin-helper-plus

Repository files navigation

NoneBotPluginLogo

nonebot-plugin-helper-plus

✨ NoneBot 带有阻断(屏蔽)指定群聊 消息/指令 功能的helper。 ✨

license pypi python

📖 介绍

一个带有阻断(屏蔽)指定群聊消息/指令功能的helper。对启用阻断(屏蔽)的群聊,按照在/data/helper/群号.json中的规则进行黑/白名单控制。(到底叫阻断好还是叫屏蔽好呢🤔)

💿 安装

使用 nb-cli 安装 在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
nb plugin install nonebot-plugin-helper-plus
使用包管理器安装 在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
pip
pip install nonebot-plugin-helper-plus

打开 nonebot2 项目根目录下的 pyproject.toml 文件, 在 [tool.nonebot] 部分追加写入

plugins = ["nonebot-plugin-helper-plus"]

⚙️ 配置

在data/helper/目录下添加配置文件:

  • config.json 默认配置,仅存帮助信息。
  • 群号.json 受控制的群聊配置

配置文件说明:

  • mode :模式,黑白名单
  • whitelist/blacklist :具体规则。
  • regex :正则匹配
  • command :命令匹配
  • time_span :限定时间段匹配

示例:白名单黑名单

在 nonebot2 项目的.env文件中添加下表中的必填配置

配置项 必填 类型 默认值 说明
rule_group List[str] 空列表 启用规则的群聊(请先写好配置文件)

TODO

  • 完善正则匹配,考虑加入完全匹配和部分匹配两种规则。

About

带有屏蔽功能的helper插件

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages