Skip to content

Commit 0da8046

Browse files
committed
Prepare release 1.1.0: docs, packaging, cleanup
Bump package to v1.1.0 and prepare release assets: add CHANGELOG.md and RELEASE_NOTES_1.1.0.md, update README for clearer messaging, and include avatar image. Clean up packaging and publishing metadata in package.json (files, license, keywords, repo/bugs info) and tweak tsconfig. Tidy project files by updating .gitignore and .vscodeignore, removing a temporary helper file, and renaming the GH Actions workflow to Deploy GitHub Pages. Remove unused/commented CSS/JS blocks to slim webview assets and adjust site config bio wording. These changes bundle polish, theme/syntax compatibility improvements, and groundwork for Pager command support and a cleaner publish.
1 parent 260d6be commit 0da8046

File tree

14 files changed

+252
-317
lines changed

14 files changed

+252
-317
lines changed

.github/workflows/jekyll-gh-pages.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
2-
name: A VSCode extension that speeds up DuckyScript development with ready-to-use snippets and fun ducky icons for a more efficient and enjoyable scripting experience.
2+
name: Deploy GitHub Pages
33

44
on:
55
# Runs on pushes targeting the default branch

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1-
dist
21
node_modules
2+
dist
33
*.vsix
4+
*.tgz
5+
*.log
6+
.DS_Store

.vscodeignore

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
.vscode/**
22
.vscode-test/**
33
test/**
4+
src/**
5+
.github/**
6+
.git/**
47
.gitignore
58
.yarnrc
6-
vsc-extension-quickstart.md
9+
_config.yml
10+
tmp_for_me
11+
node_modules/**
12+
**/tsconfig.json
713
**/jsconfig.json
814
**/*.map
915
**/.eslintrc.json

CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## [Unreleased]
6+
7+
## [1.1.0] - 2026-04-02
8+
9+
### Added
10+
- Base support for newer Pager-related commands in autocomplete, grammar, and bundled themes.
11+
- Initial command descriptions for the new Pager command set, ready to be expanded with examples in future updates.
12+
13+
### Changed
14+
- Improved TextMate scopes so syntax highlighting works better with standard editor themes.
15+
- Corrected and aligned the bundled dark and light themes for a more consistent DuckyScript palette.
16+
- Updated the cookbook panel so it follows the active VS Code or VSCodium theme more naturally.
17+
- Cleaned up release metadata and packaging rules for a leaner published extension.
18+
19+
### Fixed
20+
- Corrected the bundled dark theme contribution metadata so it is registered as a dark theme.
21+
- Reduced theme dependency for core syntax highlighting by using more compatible scope naming.

README.md

Lines changed: 47 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,118 +1,81 @@
11
# 🦆 DuckyScript Cookbook
22

3-
Welcome to the **DuckyScript Cookbook** - your quacktastic assistant for whipping up DuckyScript magic in no time! 🚀
3+
Write DuckyScript with less friction, better hints, and a handy cookbook panel full of ready-to-use payload ideas.
44

5-
## Available On
6-
7-
<a href="https://open-vsx.org/extension/Aleff/duckyscriptcookbook"> <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/5/56/VSCodium_Logo.png/960px-VSCodium_Logo.png?20200326145922" width="60" alt="VSCodium logo" style="vertical-align: middle; margin-right: 8px;"/></a> <a href="https://marketplace.visualstudio.com/items?itemName=Aleff.duckyscriptcookbook"> <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/9/9a/Visual_Studio_Code_1.35_icon.svg/960px-Visual_Studio_Code_1.35_icon.svg.png" width="60" alt="VSCode logo" style="vertical-align: middle; margin-right: 8px;"/></a>
8-
9-
_This is not an official extension of Hak5 or Flipper Zero but was developed by a third party._
5+
**DuckyScript Cookbook** is a community-made extension for **VS Code** and **VSCodium** that makes DuckyScript easier to read, faster to write, and a bit more fun to work with.
106

117
![](https://github.com/aleff-github/Deposito/blob/main/DuckyScriptCookbook/Hak5%20Disclaimer.png?raw=true)
128

13-
## Index
14-
15-
- [Features](#features)
16-
- [How To](#how-to-use-this-ducktastic-extension-)
17-
- [Threads](#threads)
18-
- [Other Stuff](#other-stuff)
19-
20-
## Features
21-
22-
### New Feature: Tips While Writing (*This feature is not yet complete*)
23-
24-
Now while you are writing you just need to press the CTRL SPACE combination to get some great tips from the official [Hak5 documentation](https://docs.hak5.org/hak5-usb-rubber-ducky). If you start writing down what you need, it will be even easier to reduce your search in the documentation!
25-
26-
![](https://github.com/aleff-github/Deposito/blob/main/DuckyScriptCookbook/last_feature.gif?raw=true)
27-
28-
### Syntax Highlighting Dark && Light
29-
30-
Syntax highlighting now works with standard VS Code and VSCodium themes too. The bundled Dark and Light DuckyScript themes are optional and give you a more tailored color palette if you want the full cookbook look.
31-
32-
![](https://github.com/aleff-github/Deposito/blob/main/DuckyScriptCookbook/syntax-highlighting.gif?raw=true)
33-
34-
### What's Cooking? 🍳
35-
36-
DuckyScript Cookbook is a simple yet powerful VSCode extension that helps you speedily paste ready-made DuckyScript snippets into your text files. Whether you're a coding newbie or a seasoned pro, we've got the right recipe to spice up your scripting experience!
37-
38-
<img src="https://github.com/aleff-github/DuckyScriptCookbook/blob/main/images/icon.png?raw=true" width="150"/>
39-
40-
### Features That Will Make You Quack with Joy 🥳
41-
42-
#### 🐤 A Duck Icon for Your Text Files
43-
44-
Ever wanted more ducks in your life? Now you can have an adorable duck icon grace all your text files! Sure, some might not be payloads, but who cares? Ducks make everything better, right? 🦆✨
45-
46-
![Duck in the text](https://github.com/aleff-github/Deposito/blob/main/DuckyScriptCookbook/Ducky-In-The-Text.png?raw=true)
9+
## Why install it?
4710

48-
#### 📖 Ready-to-Use Recipes (Sadly, Not Edible)
49-
Dive into our collection of pre-made DuckyScript "recipes" that are ready to be served hot into your projects. From simple tasks to complex operations, we've got a dish for every occasion. Bon appétit... err, we mean, happy coding! 🍽️
11+
Because plain text payload files deserve a little love too.
5012

51-
![DuckyScript Cookbook](https://github.com/aleff-github/Deposito/blob/main/DuckyScriptCookbook/Ducky-Script-Cookbook.gif?raw=true)
13+
With DuckyScript Cookbook you get:
5214

53-
#### 📝 Useful Snippets and Where to Find Them
54-
Channel your inner wizard and explore a library of handy snippets waiting to be discovered. No Marauder's Map needed—just a couple of clicks, and you're there! Accio, perfect script! 🧙‍♂️✨
15+
- syntax highlighting for DuckyScript
16+
- autocomplete with inline command help
17+
- snippets for common structures and commands
18+
- a cookbook side panel with ready-to-insert payload recipes
19+
- optional bundled light and dark themes
20+
- support for standard editor themes too
21+
- early support for newer Pager-related commands
5522

56-
![Usefull Snippets](https://github.com/aleff-github/Deposito/blob/main/DuckyScriptCookbook/Usefull-Snippets.gif?raw=true)
23+
## What it feels like to use
5724

58-
#### 😎 A Cool Style to Show Off to Your Desk Neighbors
59-
Tired of boring old scripts? Impress your colleagues with slick and stylish code that's as cool as the other side of the pillow. They'll be so jealous, they might just quack in envy! 🕶️🔥
25+
### Better colors, without forcing a theme
6026

61-
![DuckyScript Cookbook](https://github.com/aleff-github/Deposito/blob/main/DuckyScriptCookbook/Beautiful-Menu.gif?raw=true)
27+
The extension highlights DuckyScript nicely even with your usual VS Code or VSCodium theme.
6228

63-
## How to Use This Ducktastic Extension 🦆💻
29+
If you want the full cookbook vibe, you can also switch to the bundled **DuckyScript Light** or **DuckyScript Dark** themes.
6430

65-
1. **Install the Extension**:
66-
- Head over to the VSCode Extensions Marketplace.
67-
- Search for **"DuckyScript Cookbook"**.
68-
- Click that shiny **"Install"** button.
69-
- Voilà! You're ready to roll.
31+
### Help while you type
7032

71-
2. **Insert Snippets and Recipes**:
72-
- Open any text file in VSCode.
73-
- Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on Mac) to open the command palette.
74-
- Type **"DuckyScript Cookbook"** and select your desired snippet or recipe.
75-
- Watch as your script transforms into a masterpiece before your eyes!
33+
Start writing and trigger suggestions with `Ctrl+Space`.
7634

77-
3. **Enjoy the Duck Icons**:
78-
- Sit back and admire those cute duck icons adorning your files. Share the joy with your friends and turn your workspace into a virtual duck pond! 🦆🌊
35+
Commands, functions, and structures come with short inline explanations so you can stay in the editor instead of jumping back and forth between docs and notes.
7936

80-
## Why You'll Love It ❤️
37+
### A cookbook panel for quick payload building
8138

82-
- **Time Saver**: Spend less time typing repetitive code and more time doing what you love.
83-
- **User-Friendly**: Perfect for both beginners and experts alike. Simple, intuitive, and fun!
84-
- **Customizable**: Tailor the snippets and recipes to fit your unique needs and preferences.
85-
- **Mood Booster**: Because who wouldn't smile seeing ducks all over their workspace?
39+
Open the **DuckyScript Cookbook** view from the activity bar and insert recipe templates with a click.
8640

87-
## Threads
41+
It is especially handy when you want to:
8842

89-
### Feedback and Contributions 🗣️
43+
- start from a working payload skeleton
44+
- replace selected text with a recipe
45+
- keep reusable building blocks close to the editor
9046

91-
We'd love to hear your thoughts, ideas, and duck jokes! If you have any suggestions or want to contribute to making this extension even more awesome, head over to our [GitHub repository](https://github.com/aleff-github/DuckyScriptCookbook) and let’s make some waves together. 🦆🤝
47+
### Snippets that save repetitive typing
9248

93-
### Auto switch themes
49+
Loops, conditions, common commands, and reusable structures are quicker to drop in, tweak, and reuse.
9450

95-
It is annoying to change the topic I admit and we are trying to think of a solution... for now a trick has been posted that may come in handy but join the thread to find a better solution for everyone. [Read more...](https://github.com/aleff-github/DuckyScriptCookbook/issues/1)
51+
## Quick start
9652

97-
### Supporting new DuckyScript-based creations
53+
1. Open a `.ds`, `.duckyscript`, or compatible text file.
54+
2. Start typing DuckyScript.
55+
3. Press `Ctrl+Space` to explore commands and inline help.
56+
4. Open the **DuckyScript Cookbook** panel from the activity bar.
57+
5. Click a recipe to insert it into the active editor.
9858

99-
There are many devices that support the DuckyScript language in addition to the Hak5 devices such as the USB Rubber Ducky or the Flipper Zero. Here we are trying to figure out how to include the new features within the Syntax Highlighting system. [Read more...](https://github.com/aleff-github/DuckyScriptCookbook/issues/2)
59+
## Great for
10060

101-
## Other Stuff
61+
- learning DuckyScript a little faster
62+
- building payloads without starting from scratch every time
63+
- keeping recipes and snippets one click away
64+
- writing in a cleaner, more readable editor experience
10265

103-
### License 📄
66+
## Available on
10467

105-
This project is licensed under the [GPLv3 License](./LICENSE). Feel free to use, modify, and distribute as you like. Spread the ducky love! 🦆❤️
68+
- **VS Code Marketplace**
69+
- **Open VSX / VSCodium**
10670

107-
### Special Thanks 🎉
71+
## Feedback, ideas, and contributions
10872

109-
A big quacking thank you to all the developers and contributors who made this project possible. You’re all ducking amazing! 🙌 Oh but wait, I'm just -- would you like to hear this thank you from you? [Contribute by reporting](https://github.com/aleff-github/DuckyScriptCookbook/issues) new recipes or snippets!
73+
Got a recipe idea, found a bug, or want support for more DuckyScript features?
11074

111-
### Credits
75+
Open an issue or contribute on GitHub:
11276

113-
- Duck PNG image: <a href="https://www.flaticon.com/free-icons/water-toy" title="water toy icons">Water toy icons created by cube29 - Flaticon</a> | Flaticon License
114-
- Duck SVG image: <a href="https://www.svgrepo.com/svg/485117/duck">Flat Icon Design Sepia Vectors - flat-icon-design</a> | Public Domain Licence
77+
- GitHub repository: `aleff-github/DuckyScriptCookbook`
11578

116-
---
79+
## License
11780

118-
Happy Hacking and may the ducks be ever in your favor! 🦆💻✨
81+
Released under the **GPLv3** license. See [LICENSE](./LICENSE).

RELEASE_NOTES_1.1.0.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Release Notes - DuckyScript Cookbook 1.1.0
2+
3+
DuckyScript Cookbook 1.1.0 is a polish and compatibility release focused on improving the editing experience in VS Code and VSCodium while preparing the extension for a cleaner new publication cycle.
4+
5+
## Highlights
6+
7+
- Better syntax highlighting compatibility with standard editor themes
8+
- Corrected and improved bundled dark and light themes
9+
- Cookbook panel styling that adapts more naturally to the active theme
10+
- Base support for newer Pager commands
11+
- Final release cleanup for packaging and marketplace metadata
12+
13+
## What is included
14+
15+
### Syntax highlighting and themes
16+
- More standard TextMate scopes are now used for DuckyScript tokens, which improves color support outside the bundled themes.
17+
- The bundled DarkDuckyScript and LightDuckyScript themes have been aligned for more consistent highlighting.
18+
- The dark theme contribution metadata has been corrected.
19+
20+
### Cookbook panel
21+
- The cookbook panel now follows the active VS Code or VSCodium theme more closely instead of relying on a fixed custom palette.
22+
- Visual structure and spacing have been refined so the panel feels more native to the editor UI.
23+
24+
### Pager groundwork
25+
- Added base support for newer Pager commands in autocomplete and grammar.
26+
- Included initial command descriptions as a foundation for future examples and richer inline documentation.
27+
28+
### Release preparation
29+
- Cleaned up extension metadata and publishing inputs for a leaner package.
30+
- Added and organized the changelog for ongoing version tracking.
31+
32+
## Notes
33+
34+
- The bundled themes remain optional. Core syntax highlighting now behaves better with standard and third-party editor themes.
35+
- Pager command entries currently ship with concise descriptions and can be expanded with examples in a later release.

_config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ logo: "./images/icon.png"
88
repository: "aleff-github/DuckyScriptCookbook"
99
author:
1010
name : "Aleff"
11-
avatar : "aleff.jpg" # placed in /images/
12-
bio : "I'm Alessandro Greco, aka Aleff, a Computer Science graduate with a passion for networks and IT security."
11+
avatar : "aleff.jpg"
12+
bio : "I'm Alessandro Greco, aka Aleff, a computer science graduate with a passion for IT security."
1313
email : "alessandro.greco.1@protonmail.com"
1414
uri : "https://aleff-gitlab.gitlab.io/"

images/aleff.jpg

346 KB
Loading

media/css/main.css

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -96,18 +96,6 @@ button:focus-visible {
9696
line-height: 1.45;
9797
}
9898

99-
/* .status-panel {
100-
display: flex;
101-
flex-direction: column;
102-
justify-content: center;
103-
gap: 8px;
104-
padding: 14px;
105-
border-radius: var(--panel-radius-sm);
106-
background: var(--panel-surface-alt);
107-
border: 1px solid var(--panel-border);
108-
} */
109-
110-
/* .status-label, */
11199
.section-badge {
112100
width: fit-content;
113101
padding: 4px 10px;
@@ -124,30 +112,6 @@ button:focus-visible {
124112
color: var(--panel-badge-fg);
125113
}
126114

127-
/* .status-chip {
128-
display: inline-flex;
129-
align-items: center;
130-
width: fit-content;
131-
padding: 6px 10px;
132-
border-radius: 999px;
133-
border: 1px solid var(--panel-border);
134-
background: var(--vscode-input-background, var(--panel-surface));
135-
color: var(--vscode-foreground);
136-
font-weight: 600;
137-
} */
138-
139-
/* .status-chip.is-ready {
140-
background: var(--vscode-testing-iconPassed, var(--vscode-badge-background));
141-
color: var(--vscode-button-foreground, #ffffff);
142-
border-color: var(--vscode-testing-iconPassed, var(--panel-border));
143-
} */
144-
145-
/* .status-chip.is-warning {
146-
background: var(--vscode-inputValidation-warningBackground, var(--vscode-badge-background));
147-
color: var(--vscode-inputValidation-warningForeground, var(--vscode-foreground));
148-
border-color: var(--vscode-inputValidation-warningBorder, var(--panel-border));
149-
} */
150-
151115
.section-grid {
152116
display: grid;
153117
grid-template-columns: 1fr;

media/css/vscode.css

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -30,49 +30,11 @@ form > * {
3030
outline-color: var(--vscode-focusBorder) !important;
3131
}
3232

33-
/* a {
34-
color: var(--vscode-textLink-foreground);
35-
}
36-
37-
a:hover,
38-
a:active {
39-
color: var(--vscode-textLink-activeForeground);
40-
} */
41-
4233
code {
4334
font-size: var(--vscode-editor-font-size);
4435
font-family: var(--vscode-editor-font-family);
4536
}
4637

47-
/* button {
48-
border: none;
49-
padding: var(--input-padding-vertical) var(--input-padding-horizontal);
50-
width: 100%;
51-
text-align: center;
52-
outline: 1px solid transparent;
53-
outline-offset: 2px !important;
54-
color: var(--vscode-button-foreground);
55-
background: var(--vscode-button-background);
56-
}
57-
58-
button:hover {
59-
cursor: pointer;
60-
background: var(--vscode-button-hoverBackground);
61-
}
62-
63-
button:focus {
64-
outline-color: var(--vscode-focusBorder);
65-
}
66-
67-
button.secondary {
68-
color: var(--vscode-button-secondaryForeground);
69-
background: var(--vscode-button-secondaryBackground);
70-
}
71-
72-
button.secondary:hover {
73-
background: var(--vscode-button-secondaryHoverBackground);
74-
} */
75-
7638
input:not([type='checkbox']),
7739
textarea, select {
7840
display: block;

0 commit comments

Comments
 (0)