Getting Started

A typical plugin is structured like this:

.
├── assets/      # Assets like images and other resources
├── core/        # Scripts and scenes for your plugin
├── LICENSE      # License
├── Makefile     # Makefile
├── plugin.gd    # Entrypoint script to your plugin
├── plugin.json  # Metadata file
└── README.md    # Project README

The easiest way to get this structure and get started is to refer to the OpenGamepadUI Plugin Template repository and clicking on Use this template. This will fork the plugin template and let you clone your repository to get started.

Once you have your repository cloned locally, clone the OpenGamepadUI repository next to your plugin folder. It should look something like this:

$ ls
OpenGamepadUI
OpenGamepadUI-plugin-template

Lastly, ensure that you have installed all of the build requirements from the Developer Guide to ensure you can build your new plugin.

Metadata

The plugin.json file is used by OpenGamepadUI and the plugin store to determine how the plugin is loaded and shows up in the store. It is required for any plugin.

It looks like this:

{
  "plugin.id": "template",              # Unique ID of the plugin, lowercase
  "plugin.name": "Template Plugin",     # Display name of the plugin
  "plugin.version": "1.0.0",            # Plugin version
  "plugin.min-api-version": "1.0.0",    # Minimum OpenGamepadUI API version
  "plugin.link": "",                    # Link to your plugin's website
  "plugin.source": "",                  # Link to the plugin source code
  "plugin.description": "",             # Short description of your plugin
  "store.tags": [],                     # List of tags that describe your plugin
  "store.images": [],                   # Optional list of images that show your plugin
  "author.name": "First Last",          # Author of the plugin
  "author.email": "person@example.com", # Email address of the plugin author
  "entrypoint": "plugin.gd",            # Script to run when your plugin is loaded
}

Editing your plugin

Once you have filled out the details of your plugin, you can use the Makefile from the plugin template to build and link your plugin to OpenGamepadUI. For help using the Makefile, run this from your plugin directory:

make help

You can link and build your plugin by running:

make build

This will create a symlink to your plugin inside the OpenGamepadUI/plugins project directory, allowing you to work on your plugin with the Godot editor.

Note

Ensure you only have one plugin linked at a time, or multiple plugins you're working on might get bundled together!

Once the symlink to your plugin is created, open the OpenGamepadUI project directory and run make edit to start working on your plugin!

Depending on your plugin, you may want to consider looking at the number of Global Systems or plugin tutorials