mharjac / bad_ducky

Rubber Ducky compatible clone based on CJMCU BadUSB HW.
MIT License
280 stars 79 forks source link

Clearer Wiki Instructions incluidng mention of language which isn't currently mentioned #30

Open OdinsHat opened 4 years ago

OdinsHat commented 4 years ago

Unfortunately I can't fork and make a pull request (is this project dead btw as I see a LOT of pull requests).

I wrote an improved Wiki for Getting started:


Your only requirement is to have installed Arduino IDE. Once installed, download bad_ducky.ino and open it with Arduino IDE. Plug in your device (it should be recognized as Arduino Leonardo), choose proper serial port and upload the sketch. Format your SD card to FAT32 and save your first script on the card.

For writing scripts you can use any text editor that supports Unix LF line ending (if you are using Windows you can use notepad++). So, let's create first script. Open your text editor and write:

STRING Hello World!

Save it as demo1.txt on the SD card (device supports 8 characters long file name + 3 characters for extensions), insert the card into the device and plug it to your computer. Open Arduino IDE, check if you have selected proper port and open Serial Monitor. You should get something like this:

Now you can choose desired delivery mode. There are three work modes:

While watching the serial monitor in top bar of it:

  1. Input "a" and press [ENTER] key for selecting auto-disarm mode.
  2. Enter "en" for language and press [ENTER] key
  3. Now input "demo1.txt", press [ENTER] key

You are ready for the first script execution. Unplug your device, open text editor and plug it back in. You should be getting "Hello World!" text written in your text editor. If you unplug it and then plug it back again, you should not get anything this time. After executing your script, device switched it's mode to management.

If you have an error in your script or command is not recognized (even a blank line is considered to be an error), affected line will be skipped and rest of the script will be executed (the LED will start blinking at the end of execution).


## Git commit message:

Clarify issues for some users
* Currently nothing mentioned what language to choose. This has been
added.
* Also the fact you need to type in the top bar of the serial monitor has
been mentioned.
* Used [ENTER] to more clearly state the use of the enter key.
* Numbered each instruction to make it easier to follow.