MioIsland Plugin Registry

The official plugin registry for MioIsland — a macOS notch app.

Developers submit plugins via pull request. A maintainer reviews and merges. CI automatically validates submissions and regenerates registry.json on every merge to main.

Plugin types

Type	Directory	Description
Theme	plugins/themes/	Color palettes for the notch UI
Buddy	plugins/buddies/	Animated companions that live in the notch
Sound	plugins/sounds/	Sound packs for notifications and interactions

How to submit a plugin

1. Create your plugin — fork mio-plugin-template and follow its instructions.
2. Fork this repo and create a branch.
3. Add your plugin directory under plugins/<type>/<your-plugin-id>/. At minimum, include a plugin.json with the required fields.
4. Open a pull request against main. CI will validate your plugin.json automatically.
5. Wait for review — a maintainer will review your submission and merge it if everything looks good.

Once merged, your plugin will appear in the MioIsland plugin browser within minutes.

Registry format

The registry.json file at the root is auto-generated by CI. Do not edit it manually. MioIsland clients fetch this file to discover available plugins.

Required fields in plugin.json

Field	Type	Description
type	string	One of theme, buddy, sound
id	string	Unique identifier (kebab-case)
name	string	Display name
version	string	Semver version
author	object	{ "name": "..." } at minimum

See CONTRIBUTING.md for the full guide.

License

MIT