docs/config_options.md

   1 # Configuring QMK
   2
   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.
   4
   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:
   6
   7 * QMK Default
   8 * Keyboard
   9 * Folders (Up to 5 levels deep)
  10 * Keymap
  11
  12 ## QMK Default
  13
  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.
  15
  16 ## Keyboard
  17
  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.
  19
  20 ## Folders
  21
  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.
  23
  24 ## Keymap
  25
  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.
  27
  28 # The `config.h` File
  29
  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:
  31
  32     #include "config_common.h"
  33
  34
  35 ## Hardware Options
  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)
  64 * `#define C4_AUDIO`
  65   * enables audio on pin C4
  66 * `#define C5_AUDIO`
  67   * enables audio on pin C5
  68 * `#define C6_AUDIO`
  69   * enables audio on pin C6
  70 * `#define B5_AUDIO`
  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)
  72 * `#define B6_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)
  74 * `#define B7_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
  95 ## Features That Can Be Disabled
  96
  97 If you define these options you will disable the associated feature, which can save on code size.
  98
  99 * `#define NO_DEBUG`
 100   * disable debugging
 101 * `#define NO_PRINT`
 102   * disable printing/debugging using hid_listen
 103 * `#define NO_ACTION_LAYER`
 104   * disable layers
 105 * `#define NO_ACTION_TAPPING`
 106   * disable tap dance and other tapping features
 107 * `#define NO_ACTION_ONESHOT`
 108   * disable one-shot modifiers
 109 * `#define NO_ACTION_MACRO`
 110   * disable all macro handling
 111 * `#define NO_ACTION_FUNCTION`
 112   * disable the action function (deprecated)
 113
 114 ## Features That Can Be Enabled
 115
 116 If you define these options you will enable the associated feature, which may increase your code size.
 117
 118 * `#define FORCE_NKRO`
 119   * 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.
 120 * `#define PREVENT_STUCK_MODIFIERS`
 121   * 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
 122
 123 ## Behaviors That Can Be Configured
 124
 125 * `#define TAPPING_TERM 200`
 126   * how long before a tap becomes a hold
 127 * `#define RETRO_TAPPING`
 128   * tap anyway, even after TAPPING_TERM, if there was no other key interruption between press and release
 129 * `#define TAPPING_TOGGLE 2`
 130   * how many taps before triggering the toggle
 131 * `#define PERMISSIVE_HOLD`
 132   * makes tap and hold keys work better for fast typers who don't want tapping term set above 500
 133 * `#define LEADER_TIMEOUT 300`
 134   * how long before the leader key times out
 135 * `#define ONESHOT_TIMEOUT 300`
 136   * how long before oneshot times out
 137 * `#define ONESHOT_TAP_TOGGLE 2`
 138   * how many taps before oneshot toggle is triggered
 139 * `#define IGNORE_MOD_TAP_INTERRUPT`
 140   * makes it possible to do rolling combos (zx) with keys that convert to other keys on hold
 141 * `#define QMK_KEYS_PER_SCAN 4`
 142   * Allows sending more than one key per scan. By default, only one key event gets
 143     sent via `process_record()` per scan. This has little impact on most typing, but
 144     if you're doing a lot of chords, or your scan rate is slow to begin with, you can
 145     have some delay in processing key events. Each press and release is a separate
 146     event. For a keyboard with 1ms or so scan times, even a very fast typist isn't
 147     going to produce the 500 keystrokes a second needed to actually get more than a
 148     few ms of delay from this. But if you're doing chording on something with 3-4ms
 149     scan times? You probably want this.
 150
 151 ## RGB Light Configuration
 152
 153 * `#define RGB_DI_PIN D7`
 154   * pin the DI on the ws2812 is hooked-up to
 155 * `#define RGBLIGHT_ANIMATIONS`
 156   * run RGB animations
 157 * `#define RGBLED_NUM 15`
 158   * number of LEDs
 159 * `#define RGBLIGHT_HUE_STEP 12`
 160   * units to step when in/decreasing hue
 161 * `#define RGBLIGHT_SAT_STEP 25`
 162   * units to step when in/decreasing saturation
 163 * `#define RGBLIGHT_VAL_STEP 12`
 164   * units to step when in/decreasing value (brightness)
 165 * `#define RGBW_BB_TWI`
 166   * bit-bangs TWI to EZ RGBW LEDs (only required for Ergodox EZ)
 167
 168 ## Mouse Key Options
 169
 170 * `#define MOUSEKEY_INTERVAL 20`
 171 * `#define MOUSEKEY_DELAY 0`
 172 * `#define MOUSEKEY_TIME_TO_MAX 60`
 173 * `#define MOUSEKEY_MAX_SPEED 7`
 174 * `#define MOUSEKEY_WHEEL_DELAY 0`
 175
 176 # The `rules.mk` File
 177
 178 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.
 179
 180 ## Build Options
 181
 182 * `DEFAULT_FOLDER`
 183   * Used to specify a default folder when a keyboard has more than one sub-folder.
 184 * `SRC`
 185   * Used to add files to the compilation/linking list.
 186 * `LAYOUTS`
 187   * A list of [layouts](feature_layouts.md) this keyboard supports.
 188
 189 ## AVR MCU Options
 190 * `MCU = atmega32u4`
 191 * `F_CPU = 16000000`
 192 * `ARCH = AVR8`
 193 * `F_USB = $(F_CPU)`
 194 * `OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT`
 195 * `BOOTLOADER = atmel-dfu` with the following options:
 196   * `atmel-dfu`
 197   * `lufa-dfu`
 198   * `qmk-dfu`
 199   * `halfkay`
 200   * `caterina`
 201   * `bootloadHID`
 202
 203 ## Feature Options
 204
 205 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.
 206
 207 * `BOOTMAGIC_ENABLE`
 208   * Virtual DIP switch configuration(+1000)
 209 * `MOUSEKEY_ENABLE`
 210   * Mouse keys(+4700)
 211 * `EXTRAKEY_ENABLE`
 212   * Audio control and System control(+450)
 213 * `CONSOLE_ENABLE`
 214   * Console for debug(+400)
 215 * `COMMAND_ENABLE`
 216   * Commands for debug and configuration
 217 * `NKRO_ENABLE`
 218   * USB N-Key Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
 219 * `AUDIO_ENABLE`
 220   * Enable the audio subsystem.
 221 * `RGBLIGHT_ENABLE`
 222   * Enable keyboard underlight functionality
 223 * `MIDI_ENABLE`
 224   * MIDI controls
 225 * `UNICODE_ENABLE`
 226   * Unicode
 227 * `BLUETOOTH_ENABLE`
 228   * Enable Bluetooth with the Adafruit EZ-Key HID