Plugin SDK

The DotMatrix Labs Plugin SDK lets you extend Dot X with background tasks, device integrations, and custom settings UI. Plugins connect to the host application over a local Socket.IO server and communicate using a simple async API.

Getting started

New to plugin development? Start here:

• First Plugin — Build your first plugin step by step
• Anatomy — Understanding plugin structure
• Manifest — Configuring manifest.json
• Examples — Common patterns and code samples
• Development Workflow — Tips for fast iteration

Guides

• Events & Communication — Device events, toasts, and connection status
• Plugin Config — Persisting plugin data locally

API Reference

Auto-generated from source:

• Plugin Lifecycle — Plugin base class, runPlugin()
• SettingsBuilder Components — All settings UI field types
• Action Mapper Modal — System utility buttons
• Global UI — Toast notifications
• Device Management — Device events and RGB control
• Channel Targets — Apps, devices, and system features selected on channels
• RGB Control — Lighting effects

Testing & Releasing

• Local Testing — Run your plugin during development
• Debugging — Common issues and fixes
• Submission — Building dist/<plugin-name>.dotxplugin for the marketplace
• GitHub Actions — Automated release workflow
• Guidelines — Quality checklist
• Beta Testing — Sharing early builds