Plugin API
日本語
日本語
  • 入門
    • 概要
    • あなたの最初のプラグイン
    • ファイル構造概要
    • プラグインタイプ
      • ウィンドウ
      • バックグラウンドサービス
      • フォーマット拡張
      • インスペクター
    • プラグインのデバッグ
  • 配布
    • プラグインの準備
    • プラグインパッケージ
    • プラグインを公開する
    • プラグインを更新する
    • 開発者ポリシー
    • Plugin Icon Teamplate
  • 開発ガイド
    • 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