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"
36 * `#define VENDOR_ID 0x1234`
37 * defines your VID, and for most DIY projects, can be whatever you want
38 * `#define PRODUCT_ID 0x5678`
39 * defines your PID, and for most DIY projects, can be whatever you want
40 * `#define DEVICE_VER 0`
41 * defines the device version (often used for revisions)
42 * `#define MANUFACTURER Me`
43 * generally who/whatever brand produced the board
44 * `#define PRODUCT Board`
45 * the name of the keyboard
46 * `#define DESCRIPTION a keyboard`
47 * a short description of what the keyboard is
48 * `#define MATRIX_ROWS 5`
49 * the number of rows in your keyboard's matrix
50 * `#define MATRIX_COLS 15`
51 * the number of columns in your keyboard's matrix
52 * `#define MATRIX_ROW_PINS { D0, D5, B5, B6 }`
53 * pins of the rows, from top to bottom
54 * `#define MATRIX_COL_PINS { F1, F0, B0, C7, F4, F5, F6, F7, D4, D6, B4, D7 }`
55 * pins of the columns, from left to right
56 * `#define UNUSED_PINS { D1, D2, D3, B1, B2, B3 }`
57 * pins unused by the keyboard for reference
58 * `#define MATRIX_HAS_GHOST`
59 * define is matrix has ghost (unlikely)
60 * `#define DIODE_DIRECTION COL2ROW`
61 * 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.
62 * `#define AUDIO_VOICES`
63 * turns on the alternate audio voices (to cycle through)
65 * enables audio on pin C4
67 * enables audio on pin C5
69 * enables audio on pin C6
71 * enables audio on pin B5 (duophony is enables if one of B[5-7]_AUDIO is enabled along with one of C[4-6]_AUDIO)
73 * enables audio on pin B6 (duophony is enables if one of B[5-7]_AUDIO is enabled along with one of C[4-6]_AUDIO)
75 * enables audio on pin B7 (duophony is enables if one of B[5-7]_AUDIO is enabled along with one of C[4-6]_AUDIO)
76 * `#define BACKLIGHT_PIN B7`
77 * pin of the backlight - B5, B6, B7 use PWM, others use softPWM
78 * `#define BACKLIGHT_LEVELS 3`
79 * number of levels your backlight will have (maximum 15 excluding off)
80 * `#define BACKLIGHT_BREATHING`
81 * enables backlight breathing (only works with backlight pins B5, B6 and B7)
82 * `#define BREATHING_PERIOD 6`
83 * the length of one backlight "breath" in seconds
84 * `#define DEBOUNCING_DELAY 5`
85 * the delay when reading the value of the pin (5 is default)
86 * `#define LOCKING_SUPPORT_ENABLE`
87 * mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap
88 * `#define LOCKING_RESYNC_ENABLE`
89 * tries to keep switch state consistent with keyboard LED state
90 * `#define IS_COMMAND() ( keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) )`
91 * key combination that allows the use of magic commands (useful for debugging)
92 * `#define USB_MAX_POWER_CONSUMPTION`
93 * sets the maximum power (in mA) over USB for the device (default: 500)
94 * `#define SCL_CLOCK 100000L`
95 * sets the SCL_CLOCK speed for split keyboards. The default is `100000L` but some boards can be set to `400000L`.
97 ## Features That Can Be Disabled
99 If you define these options you will disable the associated feature, which can save on code size.
104 * disable printing/debugging using hid_listen
105 * `#define NO_ACTION_LAYER`
107 * `#define NO_ACTION_TAPPING`
108 * disable tap dance and other tapping features
109 * `#define NO_ACTION_ONESHOT`
110 * disable one-shot modifiers
111 * `#define NO_ACTION_MACRO`
112 * disable all macro handling
113 * `#define NO_ACTION_FUNCTION`
114 * disable the action function (deprecated)
116 ## Features That Can Be Enabled
118 If you define these options you will enable the associated feature, which may increase your code size.
120 * `#define FORCE_NKRO`
121 * 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.
122 * `#define PREVENT_STUCK_MODIFIERS`
123 * stores the layer a key press came from so the same layer is used when the key is released, regardless of which layers are enabled
125 ## Behaviors That Can Be Configured
127 * `#define TAPPING_TERM 200`
128 * how long before a tap becomes a hold, if set above 500, a key tapped during the tapping term will turn it into a hold too
129 * `#define RETRO_TAPPING`
130 * tap anyway, even after TAPPING_TERM, if there was no other key interruption between press and release
131 * See [Retro Tapping](feature_advanced_keycodes.md#retro-tapping) for details
132 * `#define TAPPING_TOGGLE 2`
133 * how many taps before triggering the toggle
134 * `#define PERMISSIVE_HOLD`
135 * makes tap and hold keys work better for fast typers who don't want tapping term set above 500
136 * See [Permissive Hold](feature_advanced_keycodes.md#permissive-hold) for details
137 * `#define IGNORE_MOD_TAP_INTERRUPT`
138 * makes it possible to do rolling combos (zx) with keys that convert to other keys on hold
139 * See [Mod tap interrupt](feature_advanced_keycodes.md#mod-tap-interrupt) for details
140 * `#define TAPPING_FORCE_HOLD`
141 * makes it possible to use a dual role key as modifier shortly after having been tapped
142 * See [Hold after tap](feature_advanced_keycodes.md#hold-after-tap)
143 * `#define LEADER_TIMEOUT 300`
144 * how long before the leader key times out
145 * `#define ONESHOT_TIMEOUT 300`
146 * how long before oneshot times out
147 * `#define ONESHOT_TAP_TOGGLE 2`
148 * how many taps before oneshot toggle is triggered
149 * `#define QMK_KEYS_PER_SCAN 4`
150 * Allows sending more than one key per scan. By default, only one key event gets
151 sent via `process_record()` per scan. This has little impact on most typing, but
152 if you're doing a lot of chords, or your scan rate is slow to begin with, you can
153 have some delay in processing key events. Each press and release is a separate
154 event. For a keyboard with 1ms or so scan times, even a very fast typist isn't
155 going to produce the 500 keystrokes a second needed to actually get more than a
156 few ms of delay from this. But if you're doing chording on something with 3-4ms
157 scan times? You probably want this.
159 ## RGB Light Configuration
161 * `#define RGB_DI_PIN D7`
162 * pin the DI on the ws2812 is hooked-up to
163 * `#define RGBLIGHT_ANIMATIONS`
165 * `#define RGBLED_NUM 15`
167 * `#define RGBLIGHT_HUE_STEP 12`
168 * units to step when in/decreasing hue
169 * `#define RGBLIGHT_SAT_STEP 25`
170 * units to step when in/decreasing saturation
171 * `#define RGBLIGHT_VAL_STEP 12`
172 * units to step when in/decreasing value (brightness)
173 * `#define RGBW_BB_TWI`
174 * bit-bangs TWI to EZ RGBW LEDs (only required for Ergodox EZ)
178 * `#define MOUSEKEY_INTERVAL 20`
179 * `#define MOUSEKEY_DELAY 0`
180 * `#define MOUSEKEY_TIME_TO_MAX 60`
181 * `#define MOUSEKEY_MAX_SPEED 7`
182 * `#define MOUSEKEY_WHEEL_DELAY 0`
184 ## Split Keyboard Options
186 Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk
188 * `#define SPLIT_HAND_PIN B7`
189 * For using high/low pin to determine handedness, low = right hand, high = left hand. Replace 'B7' with the pin you are using. This is optional and you can still use the EEHANDS method or MASTER_LEFT / MASTER_RIGHT defines like the stock Let's Split uses.
192 * For using I2C instead of Serial (defaults to serial)
194 # The `rules.mk` File
196 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.
201 * Used to specify a default folder when a keyboard has more than one sub-folder.
203 * Used to add files to the compilation/linking list.
205 * A list of [layouts](feature_layouts.md) this keyboard supports.
212 * `OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT`
213 * `BOOTLOADER = atmel-dfu` with the following options:
223 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.
226 * Virtual DIP switch configuration(+1000)
230 * Audio control and System control(+450)
232 * Console for debug(+400)
234 * Commands for debug and configuration
236 * USB N-Key Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
238 * Enable the audio subsystem.
240 * Enable keyboard underlight functionality
246 * Enable Bluetooth with the Adafruit EZ-Key HID
248 * Enables split keyboard support (dual MCU like the let's split and bakingpy's boards) and includes all necessary files located at quantum/split_common