You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-53
Original file line number
Diff line number
Diff line change
@@ -157,7 +157,7 @@ The following commands are required, which are the same as the Stream Deck softw
157
157
158
158
-`-info`: Additional information (formatted as json) about the plugin environment, as provided by the Stream Deck software.
159
159
160
-
There are also two additional options for specifying action scripts to load. Note that you can't use both of these options together, and the Stream Deck software doesn't pass in these options.
160
+
There are also two additional options for specifying action scripts to load. Note that you can't use both of these options together, and the Stream Deck software doesn't pass in these options.
161
161
162
162
- Plugin Directory: Pass the directory containing the plugin files as a positional argument:
163
163
@@ -172,58 +172,6 @@ There are also two additional options for specifying action scripts to load. Not
In addition to these, there is an additional option to use debug mode, which is discussed below.
176
-
177
-
#### Debugging
178
-
179
-
The SDK supports remote debugging capabilities, allowing you to attach a debugger after the plugin has started. This is particularly useful since Stream Deck plugins run as separate processes.
180
-
181
-
To enable debug mode, pass in the option `--debug {debug port number}`, which tells the plugin to waitfor a debugger to attach on that port number.
182
-
183
-
```bash
184
-
streamdeck --debug 5675
185
-
```
186
-
187
-
When running in debug mode, the plugin will pause for10 seconds after initialization, giving you time to attach your debugger. You'll see a messagein the logs indicating that the plugin is waiting for a debugger to attach.
188
-
189
-
If things get messy, and you have a prior instance already listening to that port, you should kill the process with something like the following command:
190
-
191
-
```bash
192
-
kill$(lsof -t -i:$DEBUG_PORT)
193
-
```
194
-
195
-
#### Debugging with VS Code
196
-
197
-
1. Create a launch configuration in`.vscode/launch.json`:
198
-
199
-
```json
200
-
{
201
-
"version": "0.2.0",
202
-
"configurations": [
203
-
{
204
-
"name": "Python: Attach to Stream Deck Plugin",
205
-
"type": "debugpy",
206
-
"request": "attach",
207
-
"connect": {
208
-
"host": "localhost",
209
-
"port": 5678
210
-
}
211
-
"pathMappings": [
212
-
{
213
-
"localRoot": "${workspaceFolder}",
214
-
"remoteRoot": "."
215
-
}
216
-
],
217
-
"justMyCode": false,
218
-
}
219
-
]
220
-
}
221
-
```
222
-
223
-
2. Start your plugin with debugging enabled
224
-
3. When you see the "waiting for debugger" message, use VS Code's Run and Debug view to attach using the configuration above
0 commit comments