CircuitPython library for running DuckyScript
You can find the DuckyScript Documentation here
This driver depends on:
Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.
Installing from PyPI¶
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:
pip3 install adafruit-circuitpython-ducky
To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-ducky
To install in a virtual environment in your current project:
mkdir project-name && cd project-name python3 -m venv .venv source .venv/bin/activate pip3 install adafruit-circuitpython-ducky
Installing to a Connected CircuitPython Device with Circup¶
Make sure that you have
circup installed in your Python environment.
Install it with the following command if necessary:
pip3 install circup
circup installed and your CircuitPython device connected use the
following command to install:
circup install ducky
Or the following command to update an existing version:
Here is an example of using the Ducky library. First you will need to import the libraries
import time import usb_hid from adafruit_hid.keyboard import Keyboard from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS import ducky
Once this is done, define the keyboard layout and initialize the
time.sleep(1) # Sleep for a bit to avoid a race condition on some systems keyboard = Keyboard(usb_hid.devices) keyboard_layout = KeyboardLayoutUS(keyboard) # We're in the US :) duck = ducky.Ducky('duckyscript.txt', keyboard, keyboard_layout)
Now, set up a loop which will run a line of the script every time
loop is called.
result = True while result is not False: result = duck.loop()
API documentation for this library can be found on Read the Docs.
For information on building library documentation, please check out this guide.
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.