|
1 | 1 | # 🦆 DuckyScript Cookbook |
2 | 2 |
|
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. |
4 | 4 |
|
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. |
10 | 6 |
|
11 | 7 |  |
12 | 8 |
|
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 | | - |
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 | | - |
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 | | - |
| 9 | +## Why install it? |
47 | 10 |
|
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. |
50 | 12 |
|
51 | | - |
| 13 | +With DuckyScript Cookbook you get: |
52 | 14 |
|
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 |
55 | 22 |
|
56 | | - |
| 23 | +## What it feels like to use |
57 | 24 |
|
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 |
60 | 26 |
|
61 | | - |
| 27 | +The extension highlights DuckyScript nicely even with your usual VS Code or VSCodium theme. |
62 | 28 |
|
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. |
64 | 30 |
|
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 |
70 | 32 |
|
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`. |
76 | 34 |
|
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. |
79 | 36 |
|
80 | | -## Why You'll Love It ❤️ |
| 37 | +### A cookbook panel for quick payload building |
81 | 38 |
|
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. |
86 | 40 |
|
87 | | -## Threads |
| 41 | +It is especially handy when you want to: |
88 | 42 |
|
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 |
90 | 46 |
|
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 |
92 | 48 |
|
93 | | -### Auto switch themes |
| 49 | +Loops, conditions, common commands, and reusable structures are quicker to drop in, tweak, and reuse. |
94 | 50 |
|
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 |
96 | 52 |
|
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. |
98 | 58 |
|
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 |
100 | 60 |
|
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 |
102 | 65 |
|
103 | | -### License 📄 |
| 66 | +## Available on |
104 | 67 |
|
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** |
106 | 70 |
|
107 | | -### Special Thanks 🎉 |
| 71 | +## Feedback, ideas, and contributions |
108 | 72 |
|
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? |
110 | 74 |
|
111 | | -### Credits |
| 75 | +Open an issue or contribute on GitHub: |
112 | 76 |
|
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` |
115 | 78 |
|
116 | | ---- |
| 79 | +## License |
117 | 80 |
|
118 | | -Happy Hacking and may the ducks be ever in your favor! 🦆💻✨ |
| 81 | +Released under the **GPLv3** license. See [LICENSE](./LICENSE). |
0 commit comments