Plugin API

Your First Plugin

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

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.
The official version has not been released yet, download link for the beta version:

Create Plugin

  1. 1.
    Click the "Plugin" button on the toolbar.
  2. 2.
    In the pop-up menu, choose "Developer Options".
  3. 3.
    Click "Create Plugin".
  4. 4.
    In the new window, select the type of plugin you want to create (Window, Background Service, Format Extension). Here we choose the "Window" type.
  5. 5.
    Choose the location where you want to save the plugin, and then complete the creation.
If you want to learn more about the differences between different plugin types, you can refer to this article. This information will help you determine which type of plugin is suitable for your needs.

Running the Example Plugin

  1. 1.
    Click the "Plugin" button on the toolbar.
  2. 2.
    In the pop-up menu, find the plugin you just created and click on it.
  3. 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.