Plugin API
简体中文
简体中文
  • 入門
    • 简介
    • 你的第一个插件
    • 文件结构概述
    • 插件类型
      • 窗口
      • 背景服務
      • 格式扩展
      • 检查器
    • 调试插件
    • 开发交流群
  • 部署
    • 准备插件
    • 打包插件
    • 发布插件
    • 更新插件
    • 开发者政策
    • 插件图标模板
  • 开发指南
    • manifest.json 完整配置
    • 取得数据
    • 修改数据
    • 存取本地文件
    • 发出网路请求
    • 使用 Node.js 原生 API
    • 使用第三方模快
    • 多国语言(i18n)
    • 无边框窗口
  • API 参考
    • event(事件)
    • item(项目)
    • folder(文件夾)
    • tag(标签)
    • tagGroup(标签群组)
    • library(资源库)
    • window(窗口)
    • app(应用)
    • os(操作系统)
    • screen(屏幕)
    • notification(通知)
    • contextMenu(右鍵菜單)
    • dialog(对话框)
    • clipboard(剪贴板)
    • drag(拖拽文件)
    • shell(壳)
    • log(日志)
  • 额外组件
    • FFmpeg
由 GitBook 提供支持
在本页
  • manifest.json
  • logo.png
  • index.html
  1. 入門

文件结构概述

这篇文章将快速介绍,插件项目中可能出现的文件

上一页你的第一个插件下一页插件类型

最后更新于2年前

插件是指一个包含多个文件的安装包,可直接分发给用户。

Plugin
├─ manifest.json
├─ logo.png
├─ index.html
└─ js
   └─ plugin.js

manifest.json

这是每个插件必须拥有的文件。它包含了有关插件的基本信息,如插件的名称、版本、执行代码入口等。不同插件类型有不同的配置方式,以下是「窗口插件」的基本配置:

{
    "id": "LB5UL2P0Q9FFF",
    "version": "1.0.0",
    "name": "Hello World",
    "logo": "/logo.png",
    "keywords": ["keywrod1", "keywrod2"],
    "main":
    {
        "devTools": true,
        "url": "index.html",
        "width": 640,
        "height": 480
    }
}
  • id - 插件 ID

  • version - 插件版本

  • name - 插件名

  • logo - 插件代表图标

  • keywords - 插件关键字,除了插件名外用户还可以使用这些关键字快速搜索到这个插件

  • main - 插件窗口程序入口设置

    • url - 入口页面

    • width - 窗口宽度

    • height - 窗口高度

完整示例代码:

logo.png

对应 manifest.json中 logo字段。代表插件的图标,它将在插件列表及插件中心使用。请提供分辨率为 128 x 128 的 图像,图标一般应该是PNG格式,因为 PNG 对透明度的支持最好。


index.html

对应 manifest.json 中 main字段。这是插件程序的入口文件,插件执行时 index.html将被独立载入在独立的浏览器窗口中运行。

注:你可以查看这篇文章,。

了解 manifest.json的所有配置方式
https://github.com/eagle-app/eagle-plugin-examples/tree/main/Window