up

Author: lgc2333

README.md

@@ -12,7 +12,7 @@
 
 # NoneBot-Plugin-PicMenu-Next
 
-_✨ NoneBot 插件简单描述 ✨_
+_✨ 新一代的图片帮助插件 ✨_
 
 <img src="https://img.shields.io/badge/python-3.9+-blue.svg" alt="python">
 <a href="https://pdm.fming.dev">
@@ -50,7 +50,56 @@ _✨ NoneBot 插件简单描述 ✨_
 
 ## 📖 介绍
 
-这里是插件的详细介绍部分
+- ✨ **美观的图片界面**：直观友好的图片界面
+- 🛠️ **PicMenu 兼容**：本插件使用 PicMenu 插件格式的三级菜单（功能详情），兼容 PicMenu 的 `<ft>` 富文本标签（但不太推荐使用）
+- 🔍 **支持模糊搜索**：支持通过序号或名称查找插件及功能，并提供插件名称的模糊匹配
+- 🔤 **拼音支持**：插件排序与模糊搜索时考虑拼音，提高中文环境下的使用体验
+- 📜 **Markdown 支持**：支持 Markdown 格式的帮助信息展示（需要插件开发者主动适配）
+- 🔒 **隐藏控制**：默认状态下类型为 `library` 的插件会对普通用户隐藏
+- 🎨 **自定义模板**：提供模板开发者注册模板的接口，提供插件开发者自定义某插件使用的详细信息模板的方式，提供配置供用户自定义想要使用的模板
+- 🔌 **插件扩展机制**：提供强大的 mixin 支持，允许插件通过中间件方式自定义帮助菜单展示和行为
+
+### 展示图
+
+<details>
+<summary>主页面</summary>
+
+![亮色主页](https://raw.githubusercontent.com/lgc-NB2Dev/readme/main/picmenu-next/light_main.jpg)  
+![暗色主页](https://raw.githubusercontent.com/lgc-NB2Dev/readme/main/picmenu-next/dark_main.jpg)
+
+</details>
+
+<details>
+<summary>插件详情</summary>
+
+![亮色插件详情](https://raw.githubusercontent.com/lgc-NB2Dev/readme/main/picmenu-next/light_detail.jpg)  
+![暗色插件详情](https://raw.githubusercontent.com/lgc-NB2Dev/readme/main/picmenu-next/dark_detail.jpg)
+
+</details>
+
+<details>
+<summary>插件详情（带功能详情三级菜单）</summary>
+
+![亮色带三级菜单插件详情](https://raw.githubusercontent.com/lgc-NB2Dev/readme/main/picmenu-next/light_with_func.jpg)  
+![暗色带三级菜单插件详情](https://raw.githubusercontent.com/lgc-NB2Dev/readme/main/picmenu-next/dark_with_func.jpg)
+
+</details>
+
+<details>
+<summary>功能详情</summary>
+
+![亮色功能详情](https://raw.githubusercontent.com/lgc-NB2Dev/readme/main/picmenu-next/light_func_detail.jpg)  
+![暗色功能详情](https://raw.githubusercontent.com/lgc-NB2Dev/readme/main/picmenu-next/dark_func_detail.jpg)
+
+</details>
+
+<details>
+<summary>Markdown 测试</summary>
+
+![亮色 Markdown 测试](https://raw.githubusercontent.com/lgc-NB2Dev/readme/main/picmenu-next/light_markdown.jpg)  
+![暗色 Markdown 测试](https://raw.githubusercontent.com/lgc-NB2Dev/readme/main/picmenu-next/dark_markdown.jpg)
+
+</details>
 
 ## 💿 安装
 
@@ -117,25 +166,22 @@ plugins = [
 
 ## ⚙️ 配置
 
-在 nonebot2 项目的 `.env` 文件中添加下表中的必填配置
+在 NoneBot2 项目的 `.env` 文件中添加下表中的配置
 
-|  配置项  | 必填 | 默认值 |   说明   |
-| :------: | :--: | :----: | :------: |
-| 配置项 1 |  是  |   无   | 配置说明 |
-| 配置项 2 |  否  |   无   | 配置说明 |
+|             配置项              | 必填 |  默认值   |              说明              |
+| :-----------------------------: | :--: | :-------: | :----------------------------: |
+|      `PMN_INDEX_TEMPLATE`       |  否  | `default` |       首页展示模板的名称       |
+|      `PMN_DETAIL_TEMPLATE`      |  否  | `default` |       插件详情模板的名称       |
+|   `PMN_FUNC_DETAIL_TEMPLATE`    |  否  | `default` |     插件功能详情模板的名称     |
+| `PMN_ONLY_SUPERUSER_SEE_HIDDEN` |  否  |  `False`  | 是否仅超级用户可以查看隐藏内容 |
 
 ## 🎉 使用
 
-### 指令表
-
-|  指令  | 权限 | 需要@ | 范围 |   说明   |
-| :----: | :--: | :---: | :--: | :------: |
-| 指令 1 | 主人 |  否   | 私聊 | 指令说明 |
-| 指令 2 | 群员 |  是   | 群聊 | 指令说明 |
+发送 `帮助` 指令试试吧！
 
-### 效果图
+## 🔧 开发
 
-如果有效果图的话
+文档待补充
 
 ## 📞 联系
 
@@ -146,7 +192,9 @@ Telegram：[@lgc2333](https://t.me/lgc2333)
 
 ## 💡 鸣谢
 
-如果有要鸣谢的人的话
+### [hamo-reid/nonebot_plugin_PicMenu](https://github.com/hamo-reid/nonebot_plugin_PicMenu)
+
+- 灵感来源（？）
 
 ## 💰 赞助
 

nonebot_plugin_picmenu_next/__init__.py

@@ -11,7 +11,7 @@
 from .data_source import refresh_infos
 from .templates import load_builtin_templates
 
-__version__ = "0.1.0.dev2"
+__version__ = "0.1.0"
 __plugin_meta__ = PluginMetadata(
     name="PicMenu Next",
     description="新一代的图片帮助插件",

nonebot_plugin_picmenu_next/__main__.py

@@ -154,7 +154,7 @@ async def _(
     show_hidden = q_show_hidden.result
     if (
         show_hidden
-        and config.only_superuser_show_hidden
+        and config.only_superuser_see_hidden
         and (not await SUPERUSER(bot, ev))
     ):
         await (

nonebot_plugin_picmenu_next/config.py

@@ -8,7 +8,7 @@ class ConfigModel(BaseModel):
     index_template: str = "default"
     detail_template: str = "default"
     func_detail_template: str = "default"
-    only_superuser_show_hidden: bool = False
+    only_superuser_see_hidden: bool = False
 
 
 config: ConfigModel = get_plugin_config(ConfigModel)

nonebot_plugin_picmenu_next/data_source/collect.py

@@ -12,6 +12,7 @@
 from nonebot.plugin import Plugin
 
 from ..utils import normalize_plugin_name
+from .mixin import chain_mixins, plugin_collect_mixins
 from .models import PMNData, PMNPluginExtra, PMNPluginInfo
 
 
@@ -77,7 +78,11 @@ async def get_info_from_plugin(plugin: Plugin) -> PMNPluginInfo:
     description = (
         meta.description
         if meta
-        else (dist.metadata.get("Summary") if (dist := get_dist()) else None)
+        else (
+            dist.metadata.get("Summary")
+            if (dist := get_dist(plugin.module_name))
+            else None
+        )
     )
 
     pmn = (extra.pmn if extra else None) or PMNData()
@@ -106,6 +111,13 @@ async def _get(p: Plugin):
         *(_get(plugin) for plugin in plugins),
     )
     infos = [x for x in infos if x]
+
+    async def final_mixin(infos: list[PMNPluginInfo]):
+        return infos
+
+    mixin_chain = chain_mixins(plugin_collect_mixins.data, final_mixin)
+    infos = await mixin_chain(infos)
+
     infos.sort(key=lambda x: x.name_pinyin)
     logger.success(f"Collected {len(infos)} plugin infos")
 

nonebot_plugin_picmenu_next/data_source/mixin.py

@@ -26,6 +26,15 @@
     T,
 ]
 
+PluginCollectMixinNext: TypeAlias = Callable[
+    [list[PMNPluginInfo]],
+    Co[list[PMNPluginInfo]],
+]
+PluginCollectMixin: TypeAlias = MixinFunc[
+    [list[PMNPluginInfo]],
+    Co[list[PMNPluginInfo]],
+]
+
 SelfMixinNext: TypeAlias = Callable[
     [PMNPluginInfo],
     Co[PMNPluginInfo],
@@ -102,6 +111,8 @@ def deco(f: T) -> T:
         return deco
 
 
+plugin_collect_mixins: MixinCollector[PluginCollectMixin] = MixinCollector()
+
 self_mixins: SelfMixinCollector[SelfMixin] = SelfMixinCollector()
 self_detail_mixins: SelfMixinCollector[PluginDetailMixin] = SelfMixinCollector()
 

nonebot_plugin_picmenu_next/templates/pw_utils.py

@@ -73,7 +73,7 @@ def layout(value: str, is_md: bool = False):
     if "<ft" in value and "</ft>" in value:
         with warning_suppress("Failed to parse PicMenu format rich text"):
             txt = transform_ft(value)
-            return Markup(br(space(txt)))  # noqa: S704
+            return Markup(space(br(txt)))  # noqa: S704
 
     return safe_layout(value)
 

pyproject.toml

@@ -6,7 +6,7 @@ authors = [{ name = "LgCookie", email = "[email protected]" }]
 dependencies = [
     "nonebot2>=2.4.1",
     "nonebot-plugin-alconna>=0.54.2",
-    "cookit[jinja,loguru,nonebot-alconna,nonebot-localstore,pw,pyd]>=0.11.5",
+    "cookit[jinja,loguru,nonebot-alconna,nonebot-localstore,pw,pyd]>=0.11.6",
     "pypinyin>=0.54.0",
     "jieba>=0.42.1",
     "thefuzz>=0.22.1",