Plugin API
English
English
  • Getting Started
    • Introduction
    • Your First Plugin
    • File Structure Overview
    • Plugin Types
      • Window
      • Background Service
      • Format Extension
      • Inspector
    • Debug Plugin
  • Distribution
    • Prepare Plugin
    • Package Plugin
    • Publish Plugin
    • Update Plugin
    • Developer Policies
    • Plugin Icon Template
  • Developer Guide
    • manifest.json Configuration
    • Retrieve Data
    • Modify Data
    • Access Local Files
    • Issue Network Requests
    • Using Node.js Native API
    • Using Third-Party Modules
    • Multilingual (i18n)
    • Frameless Window
  • API Reference
    • event
    • item
    • folder
    • tag
    • tagGroup
    • library
    • window
    • app
    • os
    • screen
    • notification
    • contextMenu
    • dialog
    • clipboard
    • drag
    • shell
    • log
  • Extra Moudle
    • FFmpeg
Powered by GitBook
On this page
  • Getting the Eagle Desktop Application
  • Create Plugin
  • Running the Example Plugin
  • Open the plugin directory in the code editor
  1. Getting Started

Your First Plugin

This article will guide you on how to create a plugin for Eagle.

PreviousIntroductionNextFile Structure Overview

Last updated 10 months ago

Getting the Eagle Desktop Application

First, you need to install the Eagle desktop application. You can click here to download the installation program: . If you have already installed the Eagle desktop application, please make sure that you have updated to the latest version. We have added several features specifically to provide you with a better plugin development experience.

Create Plugin

  1. Click the "Plugin" button on the toolbar.

  2. In the pop-up menu, choose "Developer Options".

  3. Click "Create Plugin".

  4. In the new window, select the type of plugin you want to create, In this example We will choose "Window Plugin".

  5. Choose the location where you want to save the plugin, and then complete the creation.

Running the Example Plugin

  1. Click the "Plugin" button on the toolbar.

  2. In the pop-up menu, find the plugin you just created and click on it.

  3. You will see a window pop up, displaying the basic properties of the plugin.

Open the plugin directory in the code editor

The plugin project has been created successfully.

At this point, you can use Visual Studio Code or other code editors to open this folder. The plugin is composed of multiple files, and you need to edit these files simultaneously, so you need to open the entire folder, not just one of the files.

The next section will provide a detailed introduction to the file structure of the plugin.

If you want to learn more about the differences between different plugin types, you can refer to . This information will help you determine which type of plugin is suitable for your needs.

this article
https://eagle.cool/download