Getting Started
Getting started with Stream Dock.
The quickest way to start with Stream Dock is to use the plugin template.
1. Stream Dock Plugin Template
Clone the plugin template from https://github.com/MiraboxSpace/StreamDock-Plugin-SDK, then choose the language template you need.
git clone git@github.com:MiraboxSpace/StreamDock-Plugin-SDK.git
2. Refactor Unique Identifier
Modify the folder name and the UUID in manifest.json.
3. Add the Plugin to Stream Dock
If it is a Vue template, npm run build or npm run dev will automatically add the plug-in to Stream Dock. For non-Vue templates, you need to manually add the plug-in to Stream Dock.
Manual addition example: Move the com.example.my-plugin.sdPlugin plugin to the C:\Users\{username}\AppData\Roaming\HotSpot\StreamDock\plugins folder
4. Debugging
You will need to restart Stream Dock after adding a plugin to the plugins folder for the first time. A list of plugins for debugging is accessible from your browser. Refresh a plugin or the Property Inspector at any time by reloading its page (changes to plugins require restarting Stream Dock).
Debugging URL
http:/
5. Build the Plugin
Now that everything is configured, you can build your Stream Dock plugin!