3 QMK is nearly infinitely configurable. Wherever possible we err on the side of allowing users to customize their keyboard, even at the expense of code size. That level of flexibility makes for a daunting configuration experience, however.
5 There are two main types of configuration files in QMK- `config.h` and `rules.mk`. These files exist at various levels in QMK and all files of the same type are combined to build the final configuration. The levels, from lowest priority to highest priority, are:
9 * Folders (Up to 5 levels deep)
14 Every available setting in QMK has a default. If that setting is not set at the Keyboard, Folder, or Keymap level this is the setting that will be used.
18 This level contains config options that should apply to the whole keyboard. Some settings won't change in revisions, or most keymaps. Other settings are merely defaults for this keyboard and can be overridden by folders and/or keymaps.
22 Some keyboards have folders and sub-folders to allow for different hardware configurations. Most keyboards only go 1 folder deep, but QMK supports structures up to 5 folders deep. Each folder can have its own `config.h` and `rules.mk` files that are incorporated into the final configuration.
26 This level contains all of the options for that particular keymap. If you wish to override a previous declaration, you can use `#undef <variable>` to undefine it, where you can then redefine it without an error.
30 This is a C header file that is one of the first things included, and will persist over the whole project (if included). Lots of variables can be set here and accessed elsewhere. The `config.h` file shouldn't be including other `config.h` files, or anything besides this:
32 #include "config_common.h"
37 * `#define VENDOR_ID 0x1234`
38 * defines your VID, and for most DIY projects, can be whatever you want
39 * `#define PRODUCT_ID 0x5678`
40 * defines your PID, and for most DIY projects, can be whatever you want
41 * `#define DEVICE_VER 0`
42 * defines the device version (often used for revisions)
43 * `#define MANUFACTURER Me`
44 * generally who/whatever brand produced the board
45 * `#define PRODUCT Board`
46 * the name of the keyboard
47 * `#define DESCRIPTION a keyboard`
48 * a short description of what the keyboard is
49 * `#define MATRIX_ROWS 5`
50 * the number of rows in your keyboard's matrix
51 * `#define MATRIX_COLS 15`
52 * the number of columns in your keyboard's matrix
53 * `#define MATRIX_ROW_PINS { D0, D5, B5, B6 }`
54 * pins of the rows, from top to bottom
55 * `#define MATRIX_COL_PINS { F1, F0, B0, C7, F4, F5, F6, F7, D4, D6, B4, D7 }`
56 * pins of the columns, from left to right
57 * `#define UNUSED_PINS { D1, D2, D3, B1, B2, B3 }`
58 * pins unused by the keyboard for reference
59 * `#define MATRIX_HAS_GHOST`
60 * define is matrix has ghost (unlikely)
61 * `#define DIODE_DIRECTION COL2ROW`
62 * COL2ROW or ROW2COL - how your matrix is configured. COL2ROW means the black mark on your diode is facing to the rows, and between the switch and the rows.
63 * `#define AUDIO_VOICES`
64 * turns on the alternate audio voices (to cycle through)
66 * enables audio on pin C6
68 * enables audio on pin B5 (duophony is enable if both are enabled)
69 * `#define BACKLIGHT_PIN B7`
70 * pin of the backlight - B5, B6, B7 use PWM, others use softPWM
71 * `#define BACKLIGHT_LEVELS 3`
72 * number of levels your backlight will have (maximum 15 excluding off)
73 * `#define BACKLIGHT_BREATHING`
74 * enables backlight breathing (only works with backlight pins B5, B6 and B7)
75 * `#define BREATHING_PERIOD 6`
76 * the length of one backlight "breath" in seconds
77 * `#define DEBOUNCING_DELAY 5`
78 * the delay when reading the value of the pin (5 is default)
79 * `#define LOCKING_SUPPORT_ENABLE`
80 * mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap
81 * `#define LOCKING_RESYNC_ENABLE`
82 * tries to keep switch state consistent with keyboard LED state
83 * `#define IS_COMMAND() ( keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) )`
84 * key combination that allows the use of magic commands (useful for debugging)
86 ### Features That Can Be Disabled
88 If you define these options you will disable the associated feature, which can save on code size.
93 * disable printing/debugging using hid_listen
94 * `#define NO_ACTION_LAYER`
96 * `#define NO_ACTION_TAPPING`
97 * disable tap dance and other tapping features
98 * `#define NO_ACTION_ONESHOT`
99 * disable one-shot modifiers
100 * `#define NO_ACTION_MACRO`
101 * disable all macro handling
102 * `#define NO_ACTION_FUNCTION`
103 * disable the action function (deprecated)
105 ### Features That Can Be Enabled
107 If you define these options you will enable the associated feature, which may increase your code size.
109 * `#define FORCE_NKRO`
110 * NKRO by default requires to be turned on, this forces it on during keyboard startup regardless of EEPROM setting. NKRO can still be turned off but will be turned on again if the keyboard reboots.
111 * `#define PREVENT_STUCK_MODIFIERS`
112 * when switching layers, this will release all mods
114 ### Behaviors That Can Be Configured
116 * `#define TAPPING_TERM 200`
117 * how long before a tap becomes a hold
118 * `#define RETRO_TAPPING`
119 * tap anyway, even after TAPPING_TERM, if there was no other key interruption between press and release
120 * `#define TAPPING_TOGGLE 2`
121 * how many taps before triggering the toggle
122 * `#define PERMISSIVE_HOLD`
123 * makes tap and hold keys work better for fast typers who don't want tapping term set above 500
124 * `#define LEADER_TIMEOUT 300`
125 * how long before the leader key times out
126 * `#define ONESHOT_TIMEOUT 300`
127 * how long before oneshot times out
128 * `#define ONESHOT_TAP_TOGGLE 2`
129 * how many taps before oneshot toggle is triggered
130 * `#define IGNORE_MOD_TAP_INTERRUPT`
131 * makes it possible to do rolling combos (zx) with keys that convert to other keys on hold
132 * `#define QMK_KEYS_PER_SCAN 4`
133 * Allows sending more than one key per scan. By default, only one key event gets
134 sent via `process_record()` per scan. This has little impact on most typing, but
135 if you're doing a lot of chords, or your scan rate is slow to begin with, you can
136 have some delay in processing key events. Each press and release is a separate
137 event. For a keyboard with 1ms or so scan times, even a very fast typist isn't
138 going to produce the 500 keystrokes a second needed to actually get more than a
139 few ms of delay from this. But if you're doing chording on something with 3-4ms
140 scan times? You probably want this.
142 ### RGB Light Configuration
144 * `#define RGB_DI_PIN D7`
145 * pin the DI on the ws2812 is hooked-up to
146 * `#define RGBLIGHT_ANIMATIONS`
148 * `#define RGBLED_NUM 15`
150 * `#define RGBLIGHT_HUE_STEP 12`
151 * units to step when in/decreasing hue
152 * `#define RGBLIGHT_SAT_STEP 25`
153 * units to step when in/decreasing saturation
154 * `#define RGBLIGHT_VAL_STEP 12`
155 * units to step when in/decreasing value (brightness)
156 * `#define RGBW_BB_TWI`
157 * bit-bangs TWI to EZ RGBW LEDs (only required for Ergodox EZ)
159 ### Mouse Key Options
161 * `#define MOUSEKEY_INTERVAL 20`
162 * `#define MOUSEKEY_DELAY 0`
163 * `#define MOUSEKEY_TIME_TO_MAX 60`
164 * `#define MOUSEKEY_MAX_SPEED 7`
165 * `#define MOUSEKEY_WHEEL_DELAY 0`
167 # The `rules.mk` File
169 This is a [make](https://www.gnu.org/software/make/manual/make.html) file that is included by the top-level `Makefile`. It is used to set some information about the MCU that we will be compiling for as well as enabling and disabling certain features.
171 ## `rules.mk` Options
176 * Used to specify a default folder when a keyboard has more than one sub-folder.
178 * Used to add files to the compilation/linking list.
180 * A list of [layouts](feature_layouts.md) this keyboard supports.
187 * `OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT`
188 * `BOOTLOADER = atmel-dfu` with the following options:
198 Use these to enable or disable building certain features. The more you have enabled the bigger your firmware will be, and you run the risk of building a firmware too large for your MCU.
201 * Virtual DIP switch configuration(+1000)
205 * Audio control and System control(+450)
207 * Console for debug(+400)
209 * Commands for debug and configuration
211 * USB N-Key Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
213 * Enable the audio subsystem.
215 * Enable keyboard underlight functionality
221 * Enable Bluetooth with the Adafruit EZ-Key HID