|
1 | | -# OpenGamepadUI Plugin Template |
| 1 | +# OpenGamepadUI Lutris |
2 | 2 |
|
3 | | -This repository contains a reference template for creating a plugin for |
4 | | -[OpenGamepadUI](https://github.com/ShadowBlip/OpenGamepadUI). |
| 3 | + |
5 | 4 |
|
6 | | -## Requirements |
7 | | - |
8 | | -You will need to install the dependencies for OpenGamepadUI listed |
9 | | -[here](https://github.com/ShadowBlip/OpenGamepadUI#requirements). |
| 5 | +Lutris plugin for OpenGamepadUI |
10 | 6 |
|
11 | 7 | ## Usage |
12 | 8 |
|
13 | | -This repository contains the basic files you need to write your own plugin. |
14 | | -It includes a [Makefile](Makefile) which you can use to build and package your |
15 | | -plugin. For help using the Makefile, run: |
16 | | - |
17 | | -```bash |
18 | | -make help |
19 | | -``` |
20 | | - |
21 | | -Use the following steps to get started: |
22 | | - |
23 | | -1. Fork this repository and clone your repository locally |
24 | | - |
25 | | -2. Clone the [OpenGamepadUI](https://github.com/ShadowBlip/OpenGamepadUI) repository next to your plugin folder. It should look something like this: |
26 | | - |
27 | | -```bash |
28 | | -$ ls |
29 | | -OpenGamepadUI |
30 | | -OpenGamepadUI-plugin-template |
31 | | -``` |
32 | | - |
33 | | -3. Edit `plugin.json` in your plugin repository and fill our your plugin details |
34 | | - |
35 | | -4. Run `make build` from your plugin repository to symlink your plugin inside the OpenGamepadUI project directory |
36 | | - |
37 | | -5. Open the OpenGamepadUI project in the Godot editor |
38 | | - |
39 | | -Once you have completed these steps, you can use the Godot editor to write your |
40 | | -plugin. |
41 | | - |
42 | 9 | You can build and install this plugin with: |
43 | 10 |
|
44 | 11 | ```bash |
45 | 12 | make install |
46 | 13 | ``` |
47 | | - |
48 | | -For more in-depth documentation on how to write plugins, refer to the |
49 | | -[Plugin Development Guide](https://github.com/ShadowBlip/OpenGamepadUI/blob/main/docs/PLUGINS.md) |
50 | | - |
51 | | -## Distribution |
52 | | - |
53 | | -You can distribute your plugin by building a plugin package with: |
54 | | - |
55 | | -```bash |
56 | | -make dist |
57 | | -``` |
58 | | - |
59 | | -This will create a zip file under the `dist` directory. |
60 | | - |
61 | | -To have your plugin be considered for inclusion in the OpenGamepadUI plugin store, |
62 | | -create a pull request to the [OpenGamepadUI-plugins](https://github.com/ShadowBlip/OpenGamepadUI-plugins) |
63 | | -repository with an entry for your plugin to have your plugin listed in the |
64 | | -plugin store. |
0 commit comments