Skip to main content

提取于LittlePaimon的帮助插件

Project description

NoneBotPluginLogo

nonebot-plugin-pmhelp

✨提取于LittlePaimon的插件管理器✨

📖 介绍

提供帮助图自动生成和插件权限管理
功能:全自动生成帮助图和插件禁用,限流控制
虽然LittlePaimon不再维护了,但是 @CMHopeSunshine 的帮助插件真好用,所以把LittlePaimon帮助插件独立出来
因为直接照搬,有问题请pr

💿 安装

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

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

plugins = ["nonebot_plugin_pmhelp"]

📋 效果

帮助图(举例)
_
被禁用对应变黑
_
webui(举例)
_

⚙️ 配置

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

配置项 必填 默认值 说明
img_cache True 图片资源缓存开关
pm_version 11.45.14 帮助显示的版本号
pm_text 自定义文本 自定义文本
m_message True 被限流是否提醒
pm_plugin 1 管理插件文件的位置(1为统一目录,2为机器人目录,3为自定义目录)
pm_path pm_plugin为3时的目录(无需引号)
pm_enable_web True 后台管理开关
pm_username pmhelp 后台管理用户名
pm_password admin 后台管理密码
pm_secret_key ... 后台管理token密钥

nonebot2插件生成帮助图位于{帮助文件目录}/pm_config下
或者使用webui进行修改

webui默认地址ip:端口/pmhelp/login
举例(xxx.yml):
description: 根据加载的nonebot2...   #插件介绍
matchers:                           #帮助图展示的指令卡片(可能需要自行配置)
- {pm_description: 禁用|取消...,     #介绍
    pm_name: pm-ban|unban,          #此帮助名
    pm_priority: 1,                 #优先级
    pm_show: true,                  #是否展示
    pm_usage: pm ban|unba...,       #触发命令
  }
-{....}
module_name: nonebot_plugin_pmhelp  #插件包名
name: PM帮助                         #插件名字
priority: 1                          #优先级
show: true                           #是否展示在帮助图中
usage: help                          #默认读取插件命令
编写命令时实例
xxx = on_command(
    ....,
    state={
        "pm_name": #此帮助名,
        "pm_description": #介绍,
        "pm_usage": #触发命令,
        "pm_priority": #优先级,
    },
)

🎉 使用

指令表

指令 权限 需要@ 范围 说明
help 所有 全部 打开所有帮助
pm ban/unban <插件名> 管理 全部 禁用/取消禁用插件的群/用户使用权限或者限流
命令pm ban|unban <插件名> -g <群号> -u <用户号> -x t|f <时间/次数>
参数
    ban|unban禁用/启用使用或者禁用/启用限流
<插件名>可以是中/英文或者allall表示所有插件多个插件用空格分隔
<群号>
    默认值不填时为命令当前群 可以是群号或者allall表示所有群多个群号用空格分隔
    权限群主和群管只能管理本群超级用户可以管理所有群
<用户号>
    默认值不填时或者填all则为本群所有用户all私聊使用为所有好友多个用户用空格分隔
    权限群主和群管可以管理本群的用户超级用户可以管理所有用户
-x 限流:
    <时间/次数>默认值 10s
    t:多少秒后可以再次使用
    f:一分钟使用次数(未完成)
额外说明
    如果要全局禁用/启用某一个用户需要超级用户私聊Bot来使用命令

丨💸鸣谢

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_pmhelp-1.1.8.tar.gz (17.9 MB view details)

Uploaded Source

Built Distribution

nonebot_plugin_pmhelp-1.1.8-py3-none-any.whl (17.9 MB view details)

Uploaded Python 3

File details

Details for the file nonebot_plugin_pmhelp-1.1.8.tar.gz.

File metadata

  • Download URL: nonebot_plugin_pmhelp-1.1.8.tar.gz
  • Upload date:
  • Size: 17.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for nonebot_plugin_pmhelp-1.1.8.tar.gz
Algorithm Hash digest
SHA256 233bb32af791c020de8072f358dc4efbbc1681299261e0becb8496d7ded34c11
MD5 e626484a7d7e305bf0b1943038a125a4
BLAKE2b-256 267ada14a026bd4194dc76a15fbaef8a417e04193fb4fa2446156e114b19507e

See more details on using hashes here.

File details

Details for the file nonebot_plugin_pmhelp-1.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for nonebot_plugin_pmhelp-1.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 0ee1fefe09ec64c462bf9cc620e603a28ba27a8f743ea07903b540feac0baa2c
MD5 820e4b7b0450fedf5e000bb98be569af
BLAKE2b-256 b4d849e9d11f08943a0167e5d136825f866d5a6ad74e05c7223437c2fa3d4e70

See more details on using hashes here.

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