# 准备插件

{% hint style="info" %}
您必须先确保您开发的插件符合我们的[《Eagle 开发者政策》](https://developer.eagle.cool/plugin-api/zh-cn/distribution/developer-policies)。
{% endhint %}

## 插件命名

插件命名至少须符合以下规范：

* **明确的命名**\
  插件的名称应该能够清楚地揭示其主要功能或用途，让用户在浏览插件时能立即理解该插件的用途。例如，一个可以帮助用户组织书签的插件可以命名为「书签整理大师」，而不应该使用模糊不清的名称如「超级工具」。
* **字数限制**\
  为了确保插件名称的简洁性，我们建议插件名称不应超过12个中文本。过长的名称可能会使用户感到困惑，并影响插件在列表中的显示。
* **名词而非动词**\
  插件的名称应该以名词为主，而非动词。这可以帮助用户更好地理解插件的功能。例如，「图像编辑器」会比「编辑图像」更适合作为插件的名称。
* **英文命名规范**\
  如果您的插件名称使用英文，应该每个单词首字母大写，除非是特定用词。例如，应该写为「Image Editor」而非「image editor」。
* **插件名称应该遵循** [**Apple Style Guide**](https://help.apple.com/applestyleguide/#/apsgb744e4a3?sub=apdca93e113f1d64) **的规范**
  * ✅ 以下合适的插件名称
    * `Bulk Image Downloader` 此插件名称清楚地表明了其功能是大量下载图像。
    * `Duplicate Image Finder` 这个名称明确地指出了插件的功能是查找重复的图像。
    * `Image Metadata Editor V2` 此名称明确地说明了插件的功能是编辑图像的元数据，并且是版本2。
  * ❌ 以下不建议的插件名称
    * `Extension For Pics` 此名称过于笼统且无法提供插件的任何功能信息。
    * `Adobe Image Organizer` 除非你拥有Adobe的授权，否则不应该在名称中使用专有名称。
    * `Image#Sorter` 此名称使用了特殊字符#，可能会导致进程码错误或难以理解。

***

## 插件描述

插件描述需至少符合以下规范：

* **简洁明确的描述**\
  插件的描述应该在两句话内就能清楚地解释出其主要功能和用途。例如，一个用于压缩略图像文件的插件，适合的描述可能是「一键压缩各种主流格式图像，节省素材占用空间。」不适合的描述可能是「超强、超棒的工具，让你的设计工作变得更好。」
* **字数限制**\
  为了保持描述的简洁，我们建议插件的描述不应超过40个中文本。过长的描述可能会使用户感到冗长且难以理解。
* **适当的关键字使用**\
  您的插件描述应着重于功能和用途，不应在其中塞入与插件无关的其他关键字。举例来说，如果您的插件是用于管理笔记，那么描述中应避免出现像是「游戏」或「音乐」等与插件无关的词汇。

***

## 插件 Icon

{% hint style="info" %}
我们帮你设计了一个 Icon 产生器，你可以在 [这里](https://www.figma.com/community/file/1301114081447826240/eagle-plugins-icon-template) 找到他。
{% endhint %}

插件 Icon 至少符合以下规范：

* **使用模版设计**\
  为了保持插件中心的风格和色调的一致性，您应使用我们官方提供的模版来设计您的插件图标。这样可以确保您的插件与插件中心的整体美学风格保持一致。
* **图标留白**\
  您的插件图标周围应该有一定的留白，这样可以使图标在插件中心列表中更容易被识别出来。例如，如果您的图标是一个蓝色的圆形，那么您应该在圆形的边缘与图标边界之间留出一定的空白区域，而非让圆形填满整个图标。
* **高分辨率**\
  发布至插件中心的插件 Icon 分辨率至少 256 × 256 像素(px)，且为 `PNG` 格式。

{% hint style="info" %}
**寻求帮助**

如果您觉得设计 Icon 不是您擅长的，试着至 [社区](https://discord.gg/QUkvmAGRbX) 询问帮忙。
{% endhint %}

***

## 插件封面图

<figure><img src="https://3660253004-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHZrMIIw27Dg9HnexbzyY%2Fuploads%2FyqFuhirgychyLLe5ipBC%2Fimage.png?alt=media&#x26;token=9d73ba5f-4581-4aa3-996d-c47dd47bfdcf" alt=""><figcaption></figcaption></figure>

您的封面截图会显示在插件中心的列表以及详情页面中，用户可以点击并浏览它们，以在安装前更详细地了解您的插件提供的功能。您可以提供一张封面图，而在说明中可以提供更多细节。我们建议至少添加三张在详细说明中，以方便用户了解您的插件提供的功能及使您的插件详情屏起来更加美观。

***

## 提供给审阅开工作人员的必要讯息

如果您的插件需要额外的配置，像是 API Token，启动特定的系统配置，或是打开其他第三方应用进程，请提供一个 README 文件作为说明文件，并将其放置在您插件的根目录当中，供审阅的工作人员参考。