mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-10 17:16:36 +00:00
docs(store): describe the monorepo registry and the store UI as they are
- PLUGIN_STORE_GUIDE: the Plugin Store is a section of the Plugin Manager tab; URL installs are "Install from GitHub" -> "Install Single Plugin"; bulk update exists (Check & Update All) plus opt-in weekly auto-update; PluginStoreManager() defaults to plugins/, so the Python examples pass plugin-repos; registry plugins are downloaded (GitHub API, ZIP fallback), not cloned; updates compare version with latest_version. - PLUGIN_REGISTRY_SETUP_GUIDE: replace the per-plugin-repo + tag walkthrough with a short page on the monorepo registry (plugin_path, latest_version, update_registry.py) that points at the monorepo's own SUBMISSION.md. Drops the reference to the deleted PLUGIN_IMPLEMENTATION_SUMMARY.md and setup_plugin_repos.py. - plugin_registry_template.json: use the real entry shape. - PLUGIN_QUICK_REFERENCE: automatic background updates exist (opt-in); registry example and publishing steps use the monorepo, not tags. - PLUGIN_DEVELOPMENT_GUIDE: tags/releases are not read by the store. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -99,20 +99,13 @@ class MyPlugin(BasePlugin):
|
||||
|
||||
### 3. Publishing
|
||||
|
||||
```bash
|
||||
# Create repo
|
||||
git init
|
||||
git add .
|
||||
git commit -m "Initial commit"
|
||||
git remote add origin https://github.com/YourName/ledmatrix-my-plugin
|
||||
git push -u origin main
|
||||
|
||||
# Tag release
|
||||
git tag v1.0.0
|
||||
git push origin v1.0.0
|
||||
|
||||
# Submit to registry (PR to ChuckBuilds/ledmatrix-plugins)
|
||||
```
|
||||
Official plugins live in the
|
||||
[ledmatrix-plugins](https://github.com/ChuckBuilds/ledmatrix-plugins)
|
||||
monorepo: add `plugins/<your-plugin-id>/`, bump `version` in its
|
||||
`manifest.json` on every change, run `python update_registry.py` there and
|
||||
open a pull request. A third-party plugin can stay in its own repository and
|
||||
be installed by URL. Git tags and releases are not read by the store; see
|
||||
[PLUGIN_REGISTRY_SETUP_GUIDE.md](PLUGIN_REGISTRY_SETUP_GUIDE.md).
|
||||
|
||||
## Using Plugins
|
||||
|
||||
@@ -166,20 +159,20 @@ follows this shape:
|
||||
"name": "Simple Clock",
|
||||
"author": "ChuckBuilds",
|
||||
"category": "time",
|
||||
"repo": "https://github.com/ChuckBuilds/ledmatrix-clock-simple",
|
||||
"versions": [
|
||||
{
|
||||
"version": "1.0.0",
|
||||
"ledmatrix_min_version": "2.0.0",
|
||||
"download_url": "https://github.com/.../v1.0.0.zip"
|
||||
}
|
||||
],
|
||||
"repo": "https://github.com/ChuckBuilds/ledmatrix-plugins",
|
||||
"branch": "main",
|
||||
"plugin_path": "plugins/clock-simple",
|
||||
"latest_version": "1.0.0",
|
||||
"verified": true
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
`plugin_path` is empty for a third-party plugin in its own repository. The
|
||||
store offers an update when the installed manifest's `version` is older
|
||||
than `latest_version`.
|
||||
|
||||
## Benefits
|
||||
|
||||
### For Users
|
||||
@@ -212,8 +205,11 @@ intentionally simple:
|
||||
slow plugins, but no hard CPU/memory caps.
|
||||
3. **Plugin ratings**: not yet — the Plugin Store shows version,
|
||||
author, and category but no community rating system.
|
||||
4. **Auto-updates**: manual via the Plugin Manager tab; no automatic
|
||||
background updates.
|
||||
4. **Auto-updates**: off by default. Update from the Plugin Manager tab
|
||||
(per plugin, or **Check & Update All**), or turn on weekly automatic
|
||||
updates in the General tab (`auto_update.enabled`,
|
||||
`web_interface/auto_update.py`), which update LEDMatrix and then the
|
||||
installed plugins.
|
||||
5. **Dependency conflicts**: each plugin's `requirements.txt` is
|
||||
installed via pip; conflicting versions across plugins are not
|
||||
resolved automatically.
|
||||
|
||||
Reference in New Issue
Block a user