真寻Bot插件元数据升级指南：从旧版__zx_plugin_name__迁移到PluginMetadata

在真寻Bot的版本迭代过程中，0.2.2版本移除了对旧版插件名称定义方式__zx_plugin_name__的支持。这一变更影响了插件在帮助菜单和WEB后台的显示功能。本文将详细介绍如何进行平滑迁移，确保插件在新版本中正常工作。

旧版与新版的差异

旧版真寻Bot使用简单的__zx_plugin_name__变量来定义插件名称，这种方式虽然简单直接，但功能有限。新版采用了NoneBot框架提供的PluginMetadata类，这是一个更加规范和强大的元数据定义方式。

迁移步骤

1. 导入必要模块：首先需要在插件的__init__.py文件中导入PluginMetadata类。

2. 定义插件元数据：使用PluginMetadata类创建__plugin_meta__变量，这个变量将替代旧版的__zx_plugin_name__。

3. 填写基本信息：至少需要提供插件名称(name)、简介(description)和使用说明(usage)三个基本信息。

完整示例代码

from nonebot.plugin import PluginMetadata

__plugin_meta__ = PluginMetadata(
    name="示例插件",
    description="这是一个演示如何迁移到新元数据系统的插件",
    usage="""
    指令1 - 功能说明
    指令2 - 功能说明
    """.strip(),
)

高级配置选项

除了基本的三项信息外，PluginMetadata还支持更多配置选项：

• extra：用于存储额外的插件数据
• config：插件配置项
• type：插件类型
• homepage：插件主页
• supported_adapters：支持的适配器列表

迁移注意事项

1. 确保所有插件文件都已更新为新格式
2. 检查所有依赖该插件的其他组件是否兼容
3. 测试插件在帮助系统和后台管理界面中的显示效果
4. 更新相关文档中的说明

通过以上步骤，开发者可以顺利完成从旧版插件名称定义方式到新版PluginMetadata系统的迁移，确保插件在新版本真寻Bot中正常运作。