Skip to main content

Message Blocker

Project description

NoneBotPluginLogo

NoneBotPluginText

nonebot-plugin-blocker

✨ NoneBot Plugin Blocker ✨

license pypi python pypi download

📖 介绍

这是一个 nonebot2 插件项目,用于分群配置机器人的开启关闭

插件提供了一个简单的WebUI来让你配置Bot的开关指令以及对指令做出的回复。

💿 安装

使用包管理器安装 在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
pip
pip install nonebot-plugin-blocker

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

plugins = ["nonebot_plugin_blocker"]

⚙️ 配置

请注意,使用<0.3.1版本的更新之后请重新在WebUI里进行配置

>0.3.1,<0.3.3的请更新到0.3.3来自动更新配置项或者更新之后手动重新在WebUI里配置

常规配置项,位于.env文件里

#WebUI的登录凭证,不设置即不进行验证
BLOCKER_WEBUI_USERNAME=""
BLOCKER_WEBUI_PASSWORD=""

其他配置项

插件的回复配置文件位于 data/blocker/config.json 里,不建议手动更改

data/blocker/blocklist.json 里是已经设置关闭Bot的群号,可以在关闭nonebot之后手动编辑

💬 指令

指令只有管理员,群主以及Bot的SUPERUSER能够使用

.bot on在该群开启bot

.bot off在该群关闭bot

在上述指令后at特定bot将关闭使用了本插件的特定Bot,不会影响使用本插件的其他Bot

如果你在WebUI设置了指令|回复那么指令|回复将会是你设置的文本

TODO && 碎碎念

  • 非常感谢各位写过nonebot2插件的前辈(
  • 因为有些代码懒得自己手写拿来改改用了(((
  • 准备接着改改配置项(现在就这样吧,如果nonebot有更新Pydantic的打算的话再进一步做)
  • 什么时候用上PydanticV2啊我要用RootModel啊(
  • 明明准备把代码改漂亮点的结果越写越丑,乐了

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nonebot_plugin_blocker-0.3.4.tar.gz (10.4 kB view hashes)

Uploaded Source

Built Distribution

nonebot_plugin_blocker-0.3.4-py3-none-any.whl (11.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page