Files
LEDMatrix/docs/PLUGIN_WEB_UI_ACTIONS_EXAMPLE.json
T
ChuckandClaude Opus 5.5 698807cc62 docs(plugin-config): match the config tab, icon and web-action docs to the code
- PLUGIN_CONFIG_QUICK_START / PLUGIN_CONFIGURATION_TABS /
  PLUGIN_CONFIGURATION_GUIDE: there is no "Reset to Defaults" button (the
  tab has Refresh, Update, Uninstall, Save Configuration); plugin config
  hot-reloads (ConfigService + on_config_change), so no restart; the
  schema is found by the fixed name config_schema.json, not a manifest
  config_schema field; the tab row is "Plugin Manager", not "Plugins";
  forms are server-rendered from /v3/partials/plugin-config/<id>; the
  duration hook is get_display_duration()/display_duration; a class_name
  mismatch raises PluginError; the store requires id, name, class_name and
  display_modes (not version); plugin_system.debug/log_level do not exist
  (use run.py -d / LEDMATRIX_DEBUG). Drop "future" features that shipped.
- PLUGIN_CONFIG_CORE_PROPERTIES: list all of CORE_PLUGIN_PROPERTIES,
  including skin, skin_options and the vegas_* tuning keys.
- PLUGIN_CUSTOM_ICONS: icon is only a Font Awesome class (fallback
  fa-puzzle-piece); emoji/URL icons and getPluginIcon() never existed in
  v3. Note that /api/v3/plugins/installed currently omits icon.
- PLUGIN_WEB_UI_ACTIONS (+ example JSON): success_message, error_message
  and step1_message are never read.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-22 16:21:58 -04:00

73 lines
2.3 KiB
JSON

{
"id": "ledmatrix-music",
"name": "Music Player - Now Playing",
"version": "1.0.3",
"description": "Real-time now playing display for Spotify and YouTube Music with album art, scrolling text, and progress bars",
"author": "ChuckBuilds",
"entry_point": "manager.py",
"class_name": "MusicPlugin",
"api_version": "1.0.0",
"display_modes": ["now_playing"],
"update_interval": 2,
"dependencies": [
"spotipy==2.25.2",
"python-socketio[client]==5.15.1",
"requests==2.32.5",
"pillow==12.0.0"
],
"config_schema": "config_schema.json",
"requirements_file": "requirements.txt",
"tags": ["music", "spotify", "youtube-music", "now-playing", "album-art"],
"homepage": "https://github.com/ChuckBuilds/ledmatrix-music",
"website": "https://github.com/ChuckBuilds/ledmatrix-music",
"license": "MIT",
"compatible_versions": [">=2.0.0 <=3.0.0"],
"min_ledmatrix_version": "2.0.0",
"max_ledmatrix_version": "3.0.0",
"download_url_template": "https://github.com/ChuckBuilds/ledmatrix-music/archive/refs/tags/v{version}.zip",
"web_ui_actions": [
{
"id": "authenticate-spotify",
"type": "script",
"title": "Spotify Authentication",
"description": "Click to authenticate with Spotify",
"button_text": "Authenticate Spotify",
"icon": "fab fa-spotify",
"color": "green",
"script": "authenticate_spotify.py",
"oauth_flow": true,
"section_description": "Authenticate with Spotify or YouTube Music to enable music playback display.",
"step2_prompt": "Please paste the full redirect URL from Spotify after authorization:",
"step2_button_text": "Complete Authentication"
},
{
"id": "authenticate-ytm",
"type": "script",
"title": "YouTube Music Authentication",
"description": "Click to authenticate with YouTube Music",
"button_text": "Authenticate YTM",
"icon": "fab fa-youtube",
"color": "red",
"script": "authenticate_ytm.py"
}
],
"versions": [
{
"version": "1.0.3",
"ledmatrix_min_version": "2.0.0",
"released": "2025-11-05"
},
{
"version": "1.0.0",
"ledmatrix_min_version": "2.0.0",
"released": "2025-01-16"
}
],
"last_updated": "2025-11-05",
"stars": 0,
"downloads": 0,
"verified": true,
"screenshot": ""
}