Skip to content

Commit 340e533

Browse files
committed
docs: document the process of submitting a new plugin to the catalogue
1 parent c086d03 commit 340e533

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## OpenAction Plugin Registry
2+
3+
This repository serves as the official registry and catalogue for OpenAction plugins.
4+
5+
### Project Structure
6+
7+
- `catalogue.json`: The central registry file containing metadata for all available plugins.
8+
- `icons/`: A directory containing the formatted icons for the plugins.
9+
- `format_icons.py` & `update_descriptions.py`: Python utility scripts used for maintaining the registry, fetching updates, and formatting assets.
10+
- `pyproject.toml`: Python project configuration and dependencies for the utility scripts.
11+
12+
### Submitting a Plugin
13+
14+
To submit your plugin to the OpenAction Marketplace, please follow these steps:
15+
16+
1. **Add the Repository Tag**: Add the `openaction` topic/tag to your plugin's repository on GitHub.
17+
2. **Update the Catalogue**: Fork this repository and add an entry for your plugin to the `catalogue.json` file.
18+
- The key should be your plugin's **bundle ID**.
19+
- The `name` and `author` fields must exactly match the values in your plugin's manifest file.
20+
- The `description` field should match the sidebar description of your plugin's GitHub repository.
21+
3. **Correct Placement**: Ensure your entry is added to the correct logical section in `catalogue.json`. The catalog is organized in the following order:
22+
1. **Official plugins from the OpenAction project**
23+
2. **Native OpenAction plugins** (probably where you want to add your plugin)
24+
3. **Device support plugins**
25+
4. **Open-source Stream Deck plugins**
26+
27+
*Note: Within each individual section, plugins are sorted alphabetically by their GitHub repository URL.*
28+
4. **Add an Icon**: Add a high-resolution icon representing your plugin to the `icons/` directory. The icon should match the icon provided in your plugin's manifest / bundle. The file should be named matching your plugin's bundle ID (e.g. `com.yourname.plugin.png`). *Note: You do not need to run the `format_icons.py` script yourself; a maintainer will run it in a standardised environment to format your icon when reviewing your submission.*
29+
30+
Once you have added your entry to the appropriate section, submit a Pull Request to this repository for review.
31+
32+
### Alternative Method (The Easy Way)
33+
34+
If you prefer an easier route, simply get in contact with us via Matrix, Discord, or by opening a GitHub Issue in this repository. Drop your plugin's repository URL, and a maintainer will add the plugin for you!

0 commit comments

Comments
 (0)