檔案結構概述

這篇文章將快速介紹，插件項目中可能出現的檔案

插件是指一個包含多個檔案的安裝包，可直接分發給使用者。

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 - 視窗高度

注：你可以查看這篇文章，瞭解 manifest.json的所有設定方式。

完整範例程式碼：

https://github.com/eagle-app/eagle-plugin-examples/tree/main/Window

logo.png

對應 manifest.json中 logo欄位。代表插件的圖示，它將在插件列表及插件中心使用。請提供解析度為 128 x 128 的 圖片，圖示一般應該是PNG格式，因為 PNG 對透明度的支援最好。

---

index.html

對應 manifest.json 中 main欄位。這是插件程式的入口檔案，插件執行時 index.html將被獨立載入在獨立的瀏覽器視窗中執行。