Skip to content

Commit db07b0c

Browse files
committed
docs: explain custom DuckyScript commands in settings.json
1 parent 1f21cbd commit db07b0c

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ With DuckyScript Cookbook you get:
1919
- optional bundled light and dark themes
2020
- support for standard editor themes too
2121
- early support for newer Pager-related commands
22+
- configurable highlighting for additional firmware-specific commands
2223

2324
## What it feels like to use
2425

@@ -28,6 +29,25 @@ The extension highlights DuckyScript nicely even with your usual VS Code or VSCo
2829

2930
If you want the full cookbook vibe, you can also switch to the bundled **DuckyScript Light** or **DuckyScript Dark** themes.
3031

32+
### Highlight commands from other DuckyScript implementations
33+
34+
The extension includes syntax highlighting for known USB Army Knife commands. If your firmware adds more commands (for example, custom USB Army Knife or Flipper Zero extensions), you can highlight them without changing this extension.
35+
36+
Open your **user** `settings.json` to use them everywhere, or the project's **.vscode/settings.json** to configure a specific workspace. Add the command names under `duckyscript.customCommands`:
37+
38+
```json
39+
{
40+
"duckyscript.customCommands": [
41+
"MY_CUSTOM_COMMAND",
42+
"ANOTHER_COMMAND"
43+
]
44+
}
45+
```
46+
47+
Replace these examples with the actual command names supported by your device. Commands match **case-insensitively** at the **start of a line** (leading spaces are allowed). The longest configured name takes priority when names share a prefix. Changes to the setting refresh highlighting automatically.
48+
49+
This setting adds **syntax highlighting only**; it does not add command execution, documentation or autocomplete for those commands. Semantic highlighting must be enabled in your active editor theme (it is enabled in both bundled DuckyScript themes).
50+
3151
### Help while you type
3252

3353
Start writing and trigger suggestions with `Ctrl+Space`.

0 commit comments

Comments
 (0)