https://github.com/shadowblip/opengamepadui-plugin-template
Plugin template for OpenGamepadUI
https://github.com/shadowblip/opengamepadui-plugin-template
Last synced: 3 months ago
JSON representation
Plugin template for OpenGamepadUI
- Host: GitHub
- URL: https://github.com/shadowblip/opengamepadui-plugin-template
- Owner: ShadowBlip
- License: gpl-3.0
- Created: 2023-01-28T01:20:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-03T16:48:14.000Z (over 2 years ago)
- Last Synced: 2025-02-28T23:23:18.948Z (over 1 year ago)
- Language: Makefile
- Size: 18.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenGamepadUI Plugin Template
This repository contains a reference template for creating a plugin for
[OpenGamepadUI](https://github.com/ShadowBlip/OpenGamepadUI).
## Requirements
You will need to install the dependencies for OpenGamepadUI listed
[here](https://github.com/ShadowBlip/OpenGamepadUI#requirements).
## Usage
This repository contains the basic files you need to write your own plugin.
It includes a [Makefile](Makefile) which you can use to build and package your
plugin. For help using the Makefile, run:
```bash
make help
```
Use the following steps to get started:
1. Fork this repository and clone your repository locally
2. Clone the [OpenGamepadUI](https://github.com/ShadowBlip/OpenGamepadUI) repository next to your plugin folder. It should look something like this:
```bash
$ ls
OpenGamepadUI
OpenGamepadUI-plugin-template
```
3. Edit `plugin.json` in your plugin repository and fill our your plugin details
4. Run `make build` from your plugin repository to symlink your plugin inside the OpenGamepadUI project directory
5. 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:
```bash
make install
```
For more in-depth documentation on how to write plugins, refer to the
[Plugin Development Guide](https://github.com/ShadowBlip/OpenGamepadUI/blob/main/docs/PLUGINS.md)
## Distribution
You can distribute your plugin by building a plugin package with:
```bash
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](https://github.com/ShadowBlip/OpenGamepadUI-plugins)
repository with an entry for your plugin to have your plugin listed in the
plugin store.