Skip to content

lgc-NB2Dev/nonebot-plugin-picmenu-next

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NoneBotPluginLogo

NoneBotPluginText

NoneBot-Plugin-PicMenu-Next

✨ 新一代的图片帮助插件 ✨

python pdm-managed wakatime
Pydantic Version 1 Or 2 license pypi pypi download
NoneBot Registry Supported Adapters

📖 介绍

  • 美观的图片界面:直观友好的图片界面
  • 🛠️ PicMenu 兼容:本插件使用 PicMenu 插件格式的三级菜单(功能详情),兼容 PicMenu 的 <ft> 富文本标签(但不太推荐使用)
  • 🔍 支持模糊搜索:支持通过序号或名称查找插件及功能,并提供插件名称的模糊匹配
  • 🔤 拼音支持:插件排序与模糊搜索时考虑拼音,提高中文环境下的使用体验
  • 📜 Markdown 支持:支持 Markdown 格式的帮助信息展示(需要插件开发者主动适配)
  • 🔒 隐藏控制:默认状态下类型为 library 的插件会对普通用户隐藏
  • 🎨 自定义模板:提供模板开发者注册模板的接口,提供插件开发者自定义某插件使用的详细信息模板的方式,提供配置供用户自定义想要使用的模板
  • 🔌 插件扩展机制:提供强大的 mixin 支持,允许插件通过中间件方式自定义帮助菜单展示和行为

展示图

主页面

亮色主页
暗色主页

插件详情

亮色插件详情
暗色插件详情

插件详情(带功能详情三级菜单)

亮色带三级菜单插件详情
暗色带三级菜单插件详情

功能详情

亮色功能详情
暗色功能详情

Markdown 测试

亮色 Markdown 测试
暗色 Markdown 测试

💿 安装

以下提到的方法 任选其一 即可

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

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

[tool.nonebot]
plugins = [
    # ...
    "nonebot_plugin_picmenu_next"
]

⚙️ 配置

在 NoneBot2 项目的 .env 文件中添加下表中的配置

配置项 必填 默认值 说明
PMN_INDEX_TEMPLATE default 首页展示模板的名称
PMN_DETAIL_TEMPLATE default 插件详情模板的名称
PMN_FUNC_DETAIL_TEMPLATE default 插件功能详情模板的名称
PMN_ONLY_SUPERUSER_SEE_HIDDEN False 是否仅超级用户可以查看隐藏内容

🎉 使用

发送 帮助 指令试试吧!

🔧 开发

文档待补充

📞 联系

QQ:3076823485
Telegram:@lgc2333
吹水群:168603371
邮箱:lgc2333@126.com

💡 鸣谢

  • 灵感来源(因为这个太久没更新了所以自己写了一个)

💰 赞助

赞助我

感谢大家的赞助!你们的赞助将是我继续创作的动力!

📝 更新日志

0.1.5

  • 修复上个版本中的 Bug

0.1.4

  • 支持加载外部菜单

0.1.3

  • 优化默认模板

0.1.2

  • 修复上个版本中的 Bug

0.1.1

  • 尝试兼容 Pydantic V1

About

新一代的图片帮助插件

Resources

License

Stars

Watchers

Forks

Sponsor this project