【官方】Ulanzi Studio插件开发指南---插件元数据、图像、布局介绍

Ulanzi

插件元数据、图像、布局介绍

一、元数据

该章节概述了在 Marketplace 上发布Ulanzi Studio插件的元数据时必须遵守的准则。这样，它就可以确保为Ulanzi Studio用户提供包容、一致和良好的用户体验。

1.1 名称（name）

您的插件名称是一个单词或短语，用于唯一标识您的插件及其提供的功能。

  要求：

✅请检查您的名称是否在Marketplace上可用。

✅请准确反映你的插件提供的功能。

❌禁止事项：侵犯版权或商标。

❌不要：使用贬损或冒犯性的词汇。

  建议：

  ✅推荐：描述性和简洁性。— 例如“Color Picker”等。

  ✅推荐：令人难忘且易于发音。

  ❌不推荐：避免在插件名称中包含您的组织名称;

1.2 作者（Author）

字段唯一标识您或您的组织作为插件的创建者，并在 Marketplace 和 Ulanzi Studio中可见。

  要求：

✅使用您的 Marketplace 组织名称。

✅建议事项：在适用时使用公司名称 — 例如“Ulanzi”。

✅如果您愿意，也可以使用您的真实姓名 — 例如“Wayne”。

❌禁止事项：侵犯版权或商标。

❌不要：使用贬损或冒犯性的词汇

1.3 UUID  

Ulanzi Studio和 Marketplace 使用通用唯一标识符 （UUID） 来识别您的插件

要求：

✅在插件UUID中包含组织名称、插件名称、ulanziPlugin - 我们约定长度是4，例如com.ulanzi.ulanzideck.插件名

❌不要：在发布插件后更改 UUID。

备注：在 Marketplace 上发布插件后，无法更改 UUID。

1.4 Action插件的类别和名称

必须准确表示其功能，并且具有足够的描述性但简洁（30个字符以内）。

二、插件图像和布局

该概述了在 Marketplace 上发布Ulanzi Studio插件的图标和图像时必须遵循的准则。

支持高 DPI，使用图像文件时，必须提供两种大小以支持高DPI显示器。高DPI图像文件必须用后缀命名，例如，图像必须具有名为的高DPI的图像文件。@2x image.png image@2x.png

考虑到设计变更的情况,UI尺寸以Ulanzi Studio·插件规范为准。

插件

插件的图标（在Ulanzi Studio偏好设置中可见）必须符合以下准则，在清单文件中用“CategoryIcon”字段表示。

要求：

✅建议：插件图标使用PNG格式，大小：256*256像素和512*512像素（高DPI）。

✅建议：准确描述您的插件作用。

❌不要：侵犯版权。

❌不要：使用冒犯性的图像。

Actions

Category和action的图标支持SVG和PNG的图像文件，建议使用SVG格式以提供最佳缩放。

要求

✅建议：使用 SVG 或 PNG 格式，Category图标大小20 × 20像素，action图标大小为20 × 20像素。

✅建议：使用单色配色方案，背景透明。

✅建议：使用白色笔画 #FFFFFF 作为Category图标颜色。#A6A6A6作为action图标颜色。

❌不要：使用颜色来设置列表图标的样式。

❌不要：在列表图标上使用纯色背景。

按键图标

按键图标可以是矢量化 （SVG） 或栅格化 （PNG） 图像，建议使用 SVG 格式来提供最佳缩放。

✅建议：使用SVG或PNG 、Gif格式，图标大小56 × 56像素(里面的大小为28x28)。

✅建议：有效使用状态 — 当状态与Action相关联，例如，关联的Light 被打开/关闭。

反馈

使您的插件能够在调用成功或失败时向用户提供反馈。

要求：

✅使用showAlert通知用户action何时不成功。

建议：

在没有视觉的情况下，使用showOk通知用户成功。

三、插件属性检测（UI）

Ulanzi Studio插件中的属性检查器在允许用户配置和自定义插件的作方面发挥着不可或缺的作用。检查员必须遵守以下准则。

要求：

✅用复选框进行布尔设置。

✅使用select或radio进行单选设置。

✅提供验证反馈。

✅执行：更改时自动保存设置。

✅建议事项：提供设置帮助 — 必要时提供指向支持页面的链接。

❌不要：列出版权 — 最好在Marketplace上的产品页面中使用描述或“其他链接”

建议：

❌不推荐：

• 复杂配置 — 避免使用“大量”组件。
• 大段落 — 空间有限，应保留用于配置。