Skip to content

Latest commit

 

History

History
151 lines (91 loc) · 4.73 KB

manual_setup.md

File metadata and controls

151 lines (91 loc) · 4.73 KB
Raw

Configure duckyPad Manually

Get duckyPad | Official Discord | Getting Started | Table of Contents

If you don't trust or unable to run the software, you can also configure duckyPad manually with a text editor.

Step 1: Preparing Profiles

A Profile contains a group of scripts corresponding to the keys on the duckyPad. Usually you want to set up one profile per program you want to control.

Profiles are created as folders at the root level of the SD card. They have naming conventions like profile#_name, where # is the profile number, and name being the name of the profile.

If you mount the SD card on your computer, you might see some examples like these:

Alt text

Existing examples are an excellent starting point of making your own profiles and scripts.

Up to 32 profiles are supported.

Step 2: Preparing Scripts

Now you're ready to write some scripts inside the profile folders. The script used in this project is Duckyscript, read more about it here.

Each key has its own script file, named like key#.txt, where # is the key number(top left is 1, bottom right is 15).

Here are some examples:

Alt text

  • Might be helpful to take a look at the sample profiles before writing your own

Step 3: Key Names and Optional Parameters

Create a file named config.txt in a profile folder like this:

Alt text

Key Names

In the config.txt, list the names of your keys like this:

z1 prev
z2 next
z3 close
z4 reopen
....
z15 save
  • The screen will only display the first 7 characters of the key name, so keep it short!

Loop Flag

If a key uses LOOP command, add a line like this:

s4 3

In this case, 4 is the key number, and 3 is the total number of actions. This tells duckyPad to look for the LOOP command instead of executing the script right away.

Backlight Colors

To set your custom background color, add the following line:

BG_COLOR 255 100 0

The number should be between 0 and 255, in the order of R-G-B.

  • Can't decide? Use this website to try some out. Use the rgb() value of each colour.

If unspecified, the default background color would be light purple.

Key-down Colors

To set the color of a key to change into when pressed, add the following line in config.txt:

KEYDOWN_COLOR 100 0 255

If unspecified, the default key-down color would be the inverse of background color.

Dim Unused Keys

By default unused keys are dimmed. If you want everything to light up, add the following line in config.txt:

DIM_UNUSED_KEYS 0

Individual Key Colors

You can also assign colors to individual keys, this will override the background color above.

Just add lines in config.txt for the keys you want like this:

SWCOLOR_1 148 0 211
SWCOLOR_2 148 0 211
SWCOLOR_3 148 0 211
SWCOLOR_4 0 0 255
SWCOLOR_5 0 0 255
SWCOLOR_6 0 0 255
SWCOLOR_7 0 255 0
SWCOLOR_8 0 255 0
SWCOLOR_9 0 255 0
SWCOLOR_10 255 255 0
SWCOLOR_11 255 255 0
SWCOLOR_12 255 255 0
SWCOLOR_13 255 0  0
SWCOLOR_14 255 0  0
SWCOLOR_15 255 0  0

Step 4: Run it!

Just like before, make sure the SD card is in FAT32 format, copy all the profile folders to the root of the SD card (if they are not already there), insert it in your duckyPad, and power on.

duckyPad should start up and display the profile names and key names, as well as the background color.

Press the corresponding keys to execute the scripts, if there is an error it will show up on the screen.

Press +/- button to change profiles.

Table of Contents

Main page

Getting Started Guide

Kit Assembly Guide

Using duckyScript | duckyScript 3 Info

Common issues / Troubleshooting

Firmware Updates and Version History

Make Your Own Keymap

Build a duckyPad Yourself

Kickstarter Backer Acknowledgments

Questions or Comments?

Please feel free to open an issue, ask in the official duckyPad discord, DM me on discord dekuNukem#6998, or email dekuNukem@gmail.com for inquires.