外掛程式源資料

PluginManifest

每個外掛程式必須定義 PluginManifest,並掛載到 PLUGIN.manifest 上,用於描述外掛程式的靜態資訊。

Tip

推薦以外掛程式 identifier 作為檔案名稱,例如 sample.py 對應 identifier="sample"

from app.plugins import PluginManifest, PluginKind

manifest = PluginManifest(
    identifier="sample",
    name="範例外掛程式",
    version="0.1.0",
    description="示範如何整合 Little Tree Wallpaper Next 外掛程式 API",
    author="Your Name",
    homepage="https://example.com",
    permissions=("resource_data",),  # 可選,需要存取受保護資料時宣告
    dependencies=("core>=1.0.0",),  # 可選,支援簡單的版本比較運算子
    kind=PluginKind.FEATURE,  # 可選,可宣告為 PluginKind.LIBRARY
)

欄位說明:

欄位說明
identifier外掛程式唯一識別碼(用於儲存目錄、日誌等),建議使用小寫字母和底線
name外掛程式顯示名稱
version外掛程式版本號,採用語意化版本
description可選,外掛程式簡介
author可選,作者資訊
homepage可選,首頁或文件連結
permissions可選,列出外掛程式啟動前需要授予的權限識別碼
dependencies可選,列出依賴的其他外掛程式 identifier,可使用 core>=1.0.0helper==0.2 這樣的語法描述版本要求
kind可選,外掛程式類型,預設 PluginKind.FEATURE,當外掛程式僅提供 API/函式庫能力時可設為 PluginKind.LIBRARY

存取 manifest.short_label() 可獲得 name + version 的組合字串。