The plugin catalog (the DeckHost store)¶
DeckHost's own plugins are listed in a public GitHub repository, vman26/deckhost-plugins. Each
plugin is one JSON file there; a workflow checks every submission and publishes all of them as one
catalog.json on that repository's GitHub Pages. DeckHost reads it as the DeckHost source in
Plugins → Store, next to OpenAction and the Elgato community archive. No server, no costs: GitHub
hosts it and pull requests are the review process.
plugin author ──pull request──▶ deckhost-plugins/plugins/<id>.json
│ check: fields, download, checksum, DeckHost --check-plugin
▼ merge → publish
https://vman26.github.io/deckhost-plugins/catalog.json ──▶ DeckHost store
Setting it up (once)¶
- Create the repository
vman26/deckhost-plugins(public), and copy everything frompackaging/plugins-repo/in the DeckHost repository into it (README,plugins/,tools/,.github/). - Pages: Settings → Pages → Source: GitHub Actions.
- Protect
main: Settings → Rules → a ruleset formainthat requires a pull request and the check workflow to pass. Then nothing reaches the store without your review. - Fill in the OBS entry after DeckHost's first release (the release includes
deckhost.plugin.obs.zip): setdownload_urlto that release's file andsha256to its line in the release'sSHA256SUMS.txt. Merge it; the publish workflow builds the catalog, and DeckHost's store shows the plugin.
DeckHost already reads https://vman26.github.io/deckhost-plugins/catalog.json
(PluginStore.OfficialCatalogUrl); until the repository exists the source is simply empty.
Reviewing a submission¶
The check workflow does the mechanical part: the fields, the download, the checksum, the id and
version against the package's plugin.json, and loading it with DeckHost --check-plugin (from
DeckHost's latest release). Your part:
- Does the description match what it does? Is the author the one submitting it (or allowed to)?
- Do the
permissionsmake sense? A "clock" plugin asking forprocessesdeserves a question. - For an update: is the new
download_urlfrom the same author's repository? - Skim the source when it's open. A plugin with closed source is allowed, but say so in the review if anything looks off.
Merging is publishing: the catalog updates within a minute or two.
Removing a plugin¶
Delete its file (or ask the author to). DeckHost stops listing it; people who installed it keep it until they uninstall it.
For plugin authors¶
- Write and check the plugin (guide):
DeckHost --check-plugin your.plugin.zip. - Release the zip (a GitHub release of your repository is best) and note its SHA-256.
- Open a pull request adding
plugins/<your plugin id>.jsontovman26/deckhost-plugins, following its README.
| Field | |
|---|---|
id, name, author, description, version |
Required; id and version must match the package's plugin.json. |
download_url, sha256 |
Where the zip is (https) and its SHA-256: DeckHost refuses a download that doesn't match. |
repository, page, icon |
Optional links (https); the store shows the icon and opens the page. |
category |
Optional: Audio, Streaming, Smart home, Productivity, … (DeckHost guesses one otherwise). |
permissions |
What the plugin does beyond drawing and reacting to input; shown in the store. |
license |
The plugin's license, e.g. MIT, GPL-3.0-or-later, Proprietary. |
purchase_url, price |
For a paid plugin, instead of download_url/sha256: the store shows Buy, which opens the page; buyers install the file they get with Install plugin…. |
Selling plugins¶
The catalog lists paid plugins like free ones; payment and delivery are up to the author (a shop
such as Gumroad, Lemon Squeezy or Ko-fi, or your own site). The plugin API is MIT and DeckHost's
license explicitly allows plugins of any license (NOTICE),
so a paid, closed plugin is fine. If DeckHost later sells plugins itself, the same purchase_url
field is where its checkout goes.