summaryrefslogtreecommitdiff
path: root/docs/config_options.md
AgeCommit message (Collapse)AuthorFilesLines
2025-06-09Remove `DEFAULT_FOLDER` handling (#23281)Joel Challis1-2/+0
2025-05-14Deprecate `usb.force_nkro`/`FORCE_NKRO` (#25262)Joel Challis1-2/+0
2025-04-20DOCS: `qmk-hid` missing in bootloaders list? (#25177)Jan Bláha1-0/+1
2024-09-24Remove `RING_BUFFERED_6KRO_REPORT_ENABLE` due to disuse. (#24433)Nick Brassel1-2/+0
2024-09-06[Docs] Remove references to bootmagic lite (#24369)jack1-1/+1
2024-06-02[docs] Organize driver & feature docs into subfolders (#23848)Ryan1-6/+6
Co-authored-by: Nick Brassel <nick@tzarc.org>
2024-05-30Vitepress conversion of docs. (#23795)Nick Brassel1-18/+20
2024-04-28Rename `RGBW` define to `WS2812_RGBW` (#23585)Ryan1-1/+1
2024-04-24Fix WAIT_FOR_USB handling (#23598)Joel Challis1-1/+1
2024-01-09Align `SPLIT_HAND_MATRIX_GRID` left/right logic with `SPLIT_HAND_PIN` (#22775)Joel Challis1-1/+1
2023-12-12Rename `RGBLED_NUM` -> `RGBLIGHT_LED_COUNT` (#22570)Ryan1-1/+1
2023-07-29Bluetooth: driver naming cleanups (#21624)Ryan1-1/+1
2023-05-15Keymap introspection for combos. (#19670)Nick Brassel1-2/+0
2023-04-06Migrate `rgblight.pin` and `RGB_DI_PIN` to `ws2812.pin` (#20303)Ryan1-2/+2
2023-04-03Make IGNORE_MOD_TAP_INTERRUPT the default behaviour for mod-taps (#20211)precondition1-4/+1
2023-02-13Make Magic handling more consistent in Action Keycode handling (#9126)Drashna Jaelre1-0/+3
Co-authored-by: Ryan <fauxpark@gmail.com>
2023-01-31Remove usages of config_common.h from config.h files. (#19714)Nick Brassel1-7/+2
2022-12-13Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of ↵precondition1-2/+5
HOLD_ON_OTHER_KEY_PRESS_PER_KEY (#15741)
2022-12-12[Core] Replace Tapping Force Hold feature with Quick Tap Term (#17007)Albert Y1-6/+7
* Replace Tapping Force Hold feature with Quick Tap Term * Replace keyboard level TAPPING_FORCE_HOLD with QUICK_TAP_TERM 0 * Deprecate force hold in info_config.json * Before and after quick tap term unit tests * Quick tap unit tests iteration * Keymap config.h correction * Remove TAPPING_FORCE_HOLD_PER_KEY macros that were missed * Add two more test cases for quick tap * Replace TAPPING_FORCE_HOLD with QUICK_TAP_TERM in configs #2 * Replace TAPPING_FORCE_HOLD_PER_KEY with QUICK_TAP_TERM_PER_KEY in configs #2 * Add function declaration for get_quick_tap_term Co-authored-by: Stefan Kerkmann <karlk90@pm.me>
2022-11-15Merge remote-tracking branch 'origin/master' into developQMK Bot1-1/+1
2022-11-15[Docs] Note default value for TAP_CODE_DELAY (#19078)Albert Y1-1/+1
2022-10-06Implement split comms watchdog (#18599)Dasky1-0/+7
2022-10-05Merge remote-tracking branch 'origin/master' into developQMK Bot1-1/+1
2022-10-05docs: some typos (#18582)George Rodrigues1-1/+1
probably hacktoberism
2022-09-30Merge remote-tracking branch 'upstream/master' into developfauxpark1-1/+11
2022-09-29[docs] Improve documentation regarding info.json (#18508)Less/Rikki1-1/+11
* docs: raise info.json awareness * docs: note that DD migration is WIP
2022-08-28Switch over MANUFACTURER and PRODUCT to string literals (#18183)Ryan1-3/+3
2022-08-06Remove `UNUSED_PINS` (#17931)Nick Brassel1-7/+5
2022-08-06[Core] Process all changed keys in one scan loop, deprecate ↵Stefan Kerkmann1-9/+0
`QMK_KEYS_PER_SCAN` (#15292)
2022-08-04Add deprecated check for RGBLIGHT_ANIMATIONS (#17832)Drashna Jaelre1-2/+0
2022-07-20docs: fix default value of USB_SUSPEND_WAKEUP_DELAY (#17501)Ben Fiedler1-2/+4
Documents the change made in #12081
2022-06-24Do not enable PERMISSIVE_HOLD when TAPPING_TERM exceeds 500ms (#15674)precondition1-1/+1
2022-06-08Add support for large Mouse Reports (#16371)Drashna Jaelre1-0/+2
Co-authored-by: Sergey Vlasov <sigprof@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2022-03-17[Core] Add compile/make macro to core (#15959)Drashna Jaelre1-0/+2
* [Core] Add KC_MAKE keycode to core fix linting fix testing error work around test idiocyncracies fix more lint something something stupid tests add doc * updates based on feedback * Add bad names * Fixup docs * semantics but cleaner Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Hide oneshot checks behind preprocessors * Move no-compile option around * Fix formatting * make shift optional * Make opt in * fix formatting * update send string function name Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> Co-authored-by: Joel Challis <git@zvecr.com>
2022-02-09Merge remote-tracking branch 'upstream/master' into developNick Brassel1-0/+2
2022-02-09Add support for driving unselected row/col. (#16278)Nick Brassel1-0/+2
2022-01-30Rename `AdafruitBLE` to `BluefruitLE` (#16127)Ryan1-2/+2
2022-01-24Rip out old macro and action_function system (#16025)Ryan1-5/+0
* Rip out old macro and action_function system * Update quantum/action_util.c Co-authored-by: Joel Challis <git@zvecr.com>
2021-11-26New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036)precondition1-0/+2
* New feature: `DYNAMIC_TAPPING_TERM_ENABLE` 3 new quantum keys to configure the tapping term on the fly. * Replace sprintf call in tapping_term_report by get_u16_str * Replace tab with 4 spaces
2021-11-15Add support for deferred executors. (#14859)Nick Brassel1-0/+2
* Add support for deferred executors. * More docs. * Include from quantum.h * Cleanup. * Parameter checks * Comments. * qmk format-c * I accidentally a few words. * API name change. * Apply suggestions from code review Co-authored-by: Sergey Vlasov <sigprof@gmail.com> * Review comments. * qmk format-c * Review comments. Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
2021-11-05Remove `BOOTMAGIC_ENABLE = lite` option (#15002)James Young1-1/+1
* remove BOOTMAGIC_ENABLE=lite setting * change keyboard BOOTMAGIC_ENABLE rules Edits keyboard-level instances of `BOOTMAGIC_ENABLE = lite` to `BOOTMAGIC_ENABLE = yes`. * change keyboard BOOTMAGIC_ENABLE inline comments Edits keyboard-level BOOTMAGIC_ENABLE inline comments to "Enable Bootmagic Lite". * change keymap BOOTMAGIC_ENABLE rules Edits keymap-level instances of `BOOTMAGIC_ENABLE = lite` to `BOOTMAGIC_ENABLE = yes`. * change keymap BOOTMAGIC_ENABLE inline comments Edits/adds keymap-level BOOTMAGIC_ENABLE inline comments to read "Enable Bootmagic Lite". * change layout/user BOOTMAGIC_ENABLE rules/comments Edits instances of `BOOTMAGIC_ENABLE = lite` to `BOOTMAGIC_ENABLE = yes`. Edits/adds keymap-level BOOTMAGIC_ENABLE inline comments to read "Enable Bootmagic Lite". * update non-rules.mk BOOTMAGIC_ENABLE references in keyboards/ * remove docs references to Full Bootmagic * convert data-driven Bootmagic Lite instances * remove Bootmagic Lite bodge from data-driven generation * Merge remote-tracking branch 'upstream/develop' into rm/bootmagic-full_q4a * update docs/ja/config_options.md per mtei * update docs/faq_misc.md per mtei Remove remaining Full Bootmagic reference.
2021-11-03Basic keycode overhaul (#14726)Ryan1-1/+1
2021-10-26Document `MAGIC` feature (#14301)JayceFayne1-0/+2
2021-09-29[Core] Fix "6kro enable" and clarify naming (#14563)Drashna Jaelre1-0/+2
* Fix USB_6KRO_ENABLE compilation errors * Add info to docs * Rename define to be more accurate * Remove unused rule * Refixe docs
2021-09-10Change USBasp and bootloadHID bootloaders to lowercase (#14354)Ryan1-2/+2
2021-08-15Enable sync of OLED/ST7565 display on/off state on Splits (#13542)Drashna Jaelre1-0/+6
* Enable sync of OLED/ST7565 display on/off state on Splits * Only send if states are not matched Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Nick Brassel <nick@tzarc.org>
2021-08-06Process combos earlier & overlapping combos (#8591)Pete Sevander1-1/+13
* Combo processing improvements. Now it is possible to use ModTap and LayerTap keys as part of combos. Overlapping combos also don't trigger all the combos, just exactly the one that you press. New settings: - COMBO_MUST_HOLD_MODS - COMBO_MOD_TERM - COMBO_TERM_PER_COMBO - COMBO_MUST_HOLD_PER_COMBO - COMBO_STRICT_TIMER - COMBO_NO_TIMER * Remove the size flags from combo_t struct boolean members. This in the end actually saves space as the members are accessed so many times. The amount of operations needed to access the bits uses more memory than setting the size saves. * Fix `process_combo_key_release` not called correctly with tap-only combos * Fix not passing a pointer when NO_ACTION_TAPPING is defined. * Docs for `COMBO_ONLY_FROM_LAYER` * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update quantum/process_keycode/process_combo.c Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Add `EXTRA_SHORT_COMBOS` option. Stuff combo's `disabled` and `active` flags into `state`. Possibly can save some space. * Add more examples and clarify things with dict management system. - Simple examples now has a combo that has modifiers included. - The slightly more advanced examples now are actually more advanced instead of just `tap_code16(<modded-keycode>)`. - Added a note that `COMBO_ACTION`s are not needed anymore as you can just use custom keycodes. - Added a note that the `g/keymap_combo.h` macros use the `process_combo_event` function and that it is not usable in one's keymap afterwards. * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Change "the" combo action example to "email" example. * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Fix sneaky infinite loop with `combo_disable()` No need to call `dump_key_buffer` when disabling combos because the buffer is either being dumped if a combo-key was pressed, or the buffer is empty if a non-combo-key is pressed. * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
2021-07-13[Feature] Key Overrides (#11422)Jonas Gessner1-0/+4
2021-06-18Extensible split data sync (#11930)Nick Brassel1-2/+24
* Extensible split data sync capability through transactions. - Split common transport has been split up between the transport layer and data layer. - Split "transactions" model used, with convergence between I2C and serial data definitions. - Slave matrix "generation count" is used to determine if the full slave matrix needs to be retrieved. - Encoders get the same "generation count" treatment. - All other blocks of data are synchronised when a change is detected. - All transmissions have a globally-configurable deadline before a transmission is forced (`FORCED_SYNC_THROTTLE_MS`, default 100ms). - Added atomicity for all core-synced data, preventing partial updates - Added retries to AVR i2c_master's i2c_start, to minimise the number of failed transactions when interrupts are disabled on the slave due to atomicity checks. - Some keyboards have had slight modifications made in order to ensure that they still build due to firmware size restrictions. * Fixup LED_MATRIX compile. * Parameterise ERROR_DISCONNECT_COUNT.
2021-06-09Use single memcmp to determine if matrix changed. (#13064)Nick Brassel1-0/+3
* Use memcmp to determine if matrix changed. * Firmware size issues. * Add documentation for the lack of need of MATRIX_ROW_PINS/MATRIX_COL_PINS, when overriding low-level matrix functions.