Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 1.84 KB

README.md

File metadata and controls

64 lines (42 loc) · 1.84 KB
Raw

OpenGamepadUI Plugin Template

This repository contains a reference template for creating a plugin for OpenGamepadUI.

Requirements

You will need to install the dependencies for OpenGamepadUI listed here.

Usage

This repository contains the basic files you need to write your own plugin. It includes a Makefile which you can use to build and package your plugin. For help using the Makefile, run:

make help

Use the following steps to get started:

  1. Fork this repository and clone your repository locally

  2. Clone the OpenGamepadUI repository next to your plugin folder. It should look something like this:

$ ls
OpenGamepadUI
OpenGamepadUI-plugin-template

  1. Edit plugin.json in your plugin repository and fill our your plugin details

  2. Run make build from your plugin repository to symlink your plugin inside the OpenGamepadUI project directory

  3. Open the OpenGamepadUI project in the Godot editor

Once you have completed these steps, you can use the Godot editor to write your plugin.

You can build and install this plugin with:

make install

For more in-depth documentation on how to write plugins, refer to the Plugin Development Guide

Distribution

You can distribute your plugin by building a plugin package with:

make dist

This will create a zip file under the dist directory.

To have your plugin be considered for inclusion in the OpenGamepadUI plugin store, create a pull request to the OpenGamepadUI-plugins repository with an entry for your plugin to have your plugin listed in the plugin store.