From a7992c2fb378676dfdd93c3b1cc54f567f822548 Mon Sep 17 00:00:00 2001 From: Dave Date: Sat, 24 Jun 2023 12:58:58 -0500 Subject: [PATCH] Update installation instructions --- README.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 59 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 802355e..3e198e2 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,61 @@
-## Install +## Quick Start Guide +Install and have your USB Rubber Ducky working in less than 5 minutes. + +1. Start on the [Releases](https://github.com/dbisu/pico-ducky/releases) page. + +2. Plug the device into a USB port while holding the boot button. It will show up as a removable media device named RPI-RP2. + +3. Install CircutlPython on the Pico or Pico W + +If using a Pico board: + +Copy the adafruit-circuitpython-raspberry_pi_pico-en_US-8.0.0.uf2 file to the root of the Pico (RPI-RP2). The device will reboot and after a second or so, it will reconnect as CIRCUITPY. + +If using a Pico W board: + +Copy the adafruit-circuitpython-raspberry_pi_pico_w-en_US-8.0.0.uf2 file to the root of the Pico (RPI-RP2). The device will reboot and after a second or so, it will reconnect as CIRCUITPY. + +4. Copy the lib folder to the root of the CIRCUITPY + +5. Copy *.py to the root of the CIRCUITPY + +6. Follow the instructions in README.md to enter setup mode + +7. Copy your payload as payload.dd to the root of the CIRCUITPY + +8. Unplug the device from the USB port and remove the setup jumper. + +Enjoy your Pico-Ducky. + +## Setup mode + +To edit the payload, enter setup mode by connecting the pin 1 (`GP0`) to pin 3 (`GND`), this will stop the pico-ducky from injecting the payload in your own machine. +The easiest way to do so is by using a jumper wire between those pins as seen bellow. + +![Setup mode with a jumper](images/setup-mode.png) + +## USB enable/disable mode + +If you need the pico-ducky to not show up as a USB mass storage device for stealth, follow these instructions. +- Enter setup mode. +- Copy your payload script to the pico-ducky. +- Disconnect the pico from your host PC. +- Connect a jumper wire between pin 18 (`GND`) and pin 20 (`GPIO15`). +This will prevent the pico-ducky from showing up as a USB drive when plugged into the target computer. +- Remove the jumper and reconnect to your PC to reprogram. + +Pico: The default mode is USB mass storage enabled. +Pico W: The default mode is USB mass storage **disabled** + +![USB enable/disable mode](images/usb-boot-mode.png) + + +----- + +# Full Install Instructions Install and have your USB Rubber Ducky working in less than 5 minutes. @@ -70,14 +124,14 @@ API endpoints /api/run/ ``` -### Setup mode +## Setup mode To edit the payload, enter setup mode by connecting the pin 1 (`GP0`) to pin 3 (`GND`), this will stop the pico-ducky from injecting the payload in your own machine. The easiest way to do so is by using a jumper wire between those pins as seen bellow. ![Setup mode with a jumper](images/setup-mode.png) -### USB enable/disable mode +## USB enable/disable mode If you need the pico-ducky to not show up as a USB mass storage device for stealth, follow these instructions. - Enter setup mode. @@ -92,7 +146,7 @@ Pico W: The default mode is USB mass storage **disabled** ![USB enable/disable mode](images/usb-boot-mode.png) -### Multiple payloads +## Multiple payloads Multiple payloads can be stored on the Pico and Pico W. To select a payload, ground one of these pins: @@ -101,7 +155,7 @@ To select a payload, ground one of these pins: - GP10 - payload3.dd - GP11 - payload4.dd -### Changing Keyboard Layouts +## Changing Keyboard Layouts Copied from [Neradoc/Circuitpython_Keyboard_Layouts](https://github.com/Neradoc/Circuitpython_Keyboard_Layouts/blob/main/PICODUCKY.md)