PreMiD Activities元数据规范：创建符合标准的高质量状态插件

PreMiD Activities元数据规范：创建符合标准的高质量状态插件

【免费下载链接】Presences🛒 Storage for Activities located at our Activity Library.项目地址: https://gitcode.com/gh_mirrors/pr/Presences

PreMiD Activities元数据规范是开发高质量状态插件的核心指南，它确保插件在各种平台上的一致性和兼容性。本文将详细介绍如何遵循这些规范，帮助开发者创建符合标准的Presences插件。

为什么需要元数据规范？

元数据规范为PreMiD Activities提供了统一的结构和格式，确保所有插件都具备必要的信息，如作者信息、服务描述、版本控制等。这不仅便于用户理解和使用插件，也方便开发团队进行维护和更新。通过遵循规范，开发者可以确保他们的插件能够被正确识别和展示，提升用户体验。

元数据基本结构

PreMiD Activities元数据采用JSON格式，主要包含以下几个关键部分：

核心信息

• author：插件作者信息，包括姓名和Discord ID
• service：服务名称
• description：多语言描述，至少包含英文
• url：服务网址
• version：插件版本，遵循SemVer规范
• apiVersion：支持的Activity System版本

视觉元素

• logo：服务logo的URL
• thumbnail：服务缩略图的URL
• color：主题颜色，使用6位或3位十六进制代码

功能配置

• tags：插件标签
• category：插件分类，如"anime"、"games"、"music"等
• regExp：用于匹配URL的正则表达式
• settings：用户可配置的设置项

详细规范说明

作者信息

作者信息是元数据的重要组成部分，帮助用户了解插件的创建者。规范要求必须包含作者姓名和Discord ID，格式如下：

"author": { "name": "John Doe", "id": "123456789012345678" }

多语言描述

为了支持全球用户，描述信息需要提供多种语言版本。至少需要包含英文（"en"），其他语言可根据目标用户群体添加：

"description": { "en": "A description of the activity in English", "zh": "活动的中文描述" }

版本控制

版本号必须遵循SemVer规范（主版本.次版本.补丁版本），如"1.0.0"。apiVersion表示支持的Activity System版本，目前支持1和2：

"version": "1.0.0", "apiVersion": 2

正则表达式

regExp用于匹配服务的URL，确保插件在正确的页面上激活。例如，对于YouTube的匹配可以使用：

"regExp": "^(www\\.)?youtube\\.com"

分类和标签

插件必须指定一个分类和至少一个标签。分类包括"anime"、"games"、"music"、"socials"、"videos"和"other"。标签应能准确描述插件功能：

"category": "videos", "tags": ["streaming", "video", "entertainment"]

创建元数据的步骤

1. 确定基本信息

首先收集服务的基本信息，包括名称、网址、作者信息等。这些信息将构成元数据的核心部分。

2. 设计视觉元素

准备符合要求的logo和缩略图，确保它们的URL是有效的，并且图片格式为png、jpg、gif或webp。选择合适的主题颜色，使用十六进制代码表示。

3. 编写正则表达式

根据服务的URL结构，编写准确的正则表达式，确保插件能够在正确的页面上激活。可以使用在线工具测试正则表达式的有效性。

4. 配置用户设置

如果插件需要用户可配置的选项，在settings数组中定义这些设置。每个设置应包含id、标题、描述和默认值等信息。

5. 验证元数据

使用JSON Schema验证工具检查元数据是否符合规范。PreMiD提供了官方的元数据schema文件，位于schemas/metadata/1.17.json。

图：创建PreMiD Activity的流程演示

常见问题解决

元数据验证失败

如果元数据验证失败，首先检查是否遗漏了必填字段。根据错误提示，仔细检查相关字段的格式和内容。特别注意版本号、正则表达式和颜色代码的格式是否正确。

插件不激活

如果插件在预期页面上不激活，可能是正则表达式的问题。检查regExp是否准确匹配目标URL，确保没有遗漏重要的URL部分或包含了不必要的限制。

多语言支持问题

确保描述信息中包含"en"（英文）版本，其他语言版本应使用正确的语言代码。如果用户报告翻译问题，检查对应语言的描述是否准确。

图：开发PreMiD Activity的详细过程

最佳实践

保持元数据简洁

只包含必要的信息，避免添加冗余内容。清晰、简洁的元数据更容易维护和理解。

定期更新版本

当插件功能发生变化时，及时更新版本号。遵循SemVer规范，确保用户能够理解版本变化的影响。

测试兼容性

在不同的浏览器和设备上测试插件，确保元数据中的设置和正则表达式在各种环境下都能正常工作。

提供详细描述

详细的描述信息帮助用户了解插件的功能和用途。使用简洁明了的语言，避免技术术语，让所有用户都能理解。

通过遵循这些规范和最佳实践，开发者可以创建高质量的PreMiD Activities插件，为用户提供更好的体验。元数据规范不仅是开发的指南，也是确保整个生态系统健康发展的重要基础。

要开始创建自己的PreMiD Activity，可以克隆官方仓库：

git clone https://gitcode.com/gh_mirrors/pr/Presences

在仓库中，你可以找到各种示例和模板，帮助你快速上手开发。祝你创建成功！

【免费下载链接】Presences🛒 Storage for Activities located at our Activity Library.项目地址: https://gitcode.com/gh_mirrors/pr/Presences