Skip to content

快速制作一个 Here 插件

Here App Dev edited this page Jul 25, 2020 · 4 revisions

开始制作

Here App 使用 JavaScript 作为插件的开发语言。

插件开发分为 3 个步骤:

  1. 前往 Here 插件目录。 可从 菜单 > [Debug] > [Reveal Plugins in Finder] 打开
  2. 新建文件夹,重命名项目名。 (如:Plugin-Example).
  3. 在此文件夹内创建一下文件即可。

你也可以使用脚手架工具 Here Plugin Generator 来生成自己的插件。

插件目录:

一个 Here 插件目录下含有如下文件结构:

├── Plugin-Example	// 插件文件夹名
    ├── config.json	// 插件配置
    ├── index.js	// Main Script
    ├── appcast.xml	// 用于检测插件更新装填
    ├── icon.png	// 插件图标
    ├── menuBarIcon.png	// Menu bar 图标
    ├── LICENSE.md	// 授权协议(如:MIT 开源授权)
    └── README.md		// 插件说明文档 (如:插件介绍,使用说明等)

./config.json

{
   "name": "Plugin Example",
   "identifier": "author.pluginexample",
   "version": "1.0.0",
   "description": "This is an example plugin for Here.",
   "icon": "icon.png",
   "createdBy": "author",
   "website": "https://example.com",
   "appcast": "https://plugins.herecdn.com/source/Plugin-Example/appcast.xml",
   "script": "index.js",
   "defaultCategory": "favs",
   "displayOn": [
      "mini"
   ]
}

./index.js

here.onLoad(() => {
    here.setMiniWindow({ title: "Hello World!" })
})

./appcast.xml

XML 文件中 sparkle:version="1.0.0" 的版本号应该与 config.json 里的 "version": "1.0.0" 一致保持一致,当版本号改变时,客户端就会检测到插件更新并提醒用户升级。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<rss xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle" 
    xmlns:dc="http://purl.org/dc/elements/1.1/" version="2.0">
    <channel>
        <item>
            <enclosure url="https://plugins.herecdn.com/downloads/Plugin-Example.hereplugin" sparkle:version="1.0.0"/>
        </item>
    </channel>
</rss>

./icon.png

插件 Icon 建议使用 200x200 的正方形图片,支持透明 PNG 格式

范图片:

icon.png icon.png

./menuBarIcon.png

Menu bar Icon 必须使用 60x54 的纯黑色图片,支持透明 PNG 格式

范图片:

icon.png icon.png

./LICENSE.md

所有插件基于 MIT License 开源

./README.md

介绍文档支持使用 Markdown: Syntax 语法

# 插件名称

> 这是我的第一个 Here 插件。

## 使用说明

1. 首先,
2. 然后,
3. 最后,

Now, everything is here!