<divid="app"><divclass="Layout"data-v-5d98c3a5><!--[--><!--]--><!--[--><spantabindex="-1"data-v-0f60ec36></span><ahref="#VPContent"class="VPSkipLink visually-hidden"data-v-0f60ec36> Skip to content </a><!--]--><!----><headerclass="VPNav"data-v-5d98c3a5data-v-ae24b3ad><divclass="VPNavBar has-sidebar top"data-v-ae24b3addata-v-ccf7ddec><divclass="wrapper"data-v-ccf7ddec><divclass="container"data-v-ccf7ddec><divclass="title"data-v-ccf7ddec><divclass="VPNavBarTitle has-sidebar"data-v-ccf7ddecdata-v-ab179fa1><aclass="title"href="/"data-v-ab179fa1><!--[--><!--]--><!--[--><!--[--><!--[--><imgclass="VPImage dark logo"src="/badge-community-dark.svg"altdata-v-8426fc1a><!--]--><!--[--><imgclass="VPImage light logo"src="/badge-community-light.svg"altdata-v-8426fc1a><!--]--><!--]--><!--]--><!----><!--[--><!--]--></a></div></div><divclass="content"data-v-ccf7ddec><divclass="content-body"data-v-ccf7ddec><!--[--><!--]--><divclass="VPNavBarSearch search"data-v-ccf7ddec><!--[--><!----><divid="local-search"><buttontype="button"class="DocSearch DocSearch-Button"aria-label="Search"><spanclass="DocSearch-Button-Container"><spanclass="vp-icon DocSearch-Search-Icon"></span><spanclass="DocSearch-Button-Placeholder">Search</span></span><spanclass="DocSearch-Button-Keys"><kbdclass="DocSearch-Button-Key"></kbd><kbdclass="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><navaria-labelledby="main-nav-aria-label"class="VPNavBarMenu menu"data-v-ccf7ddecdata-v-7f418b0f><spanid="main-nav-aria-label"class="visually-hidden"data-v-7f418b0f>Main Navigation</span><!--[--><!--[--><aclass="VPLink link VPNavBarMenuLink"href="./"tabindex="0"data-v-7f418b0fdata-v-9c663999><!--[--><spandata-v-9c663999>Home</span><!--]--></a><!--]--><!--]--></nav><!----><divclass="VPNavBarAppearance appearance"data-v-ccf7ddecdata-v-e6aabb21><buttonclass="VPSwitch VPSwitchAppearance"type="button"role="switch"title="Switch to dark theme"aria-checked="false"data-v-e6aabb21data-v-d1f28634data-v-1d5665e3><spanclass="check"data-v-1d5665e3><spanclass="icon"data-v-1d5665e3><!--[--><spanclass="vpi-sun sun"data-v-d1f28634></span><spanclass="vpi-moon moon"data-v-d1f28634></span><!--]--></span></span></button></div><divclass="VPSocialLinks VPNavBarSocialLinks social-links"data-v-ccf7ddecdata-v-0394ad82data-v-7bc22406><!--[--><aclass="VPSocialLink no-icon"href="https://reddit.com/r/olkb"aria-labeltarget="_blank"rel="noopener"data-v-7bc22406data-v-eee4e7cb><svgxmlns="http://www.w3.org/2000/svg"viewBox="0 0 50 50"width="50px"height="50px"><pathd="M293C28.0625327.1640633.38281326.54C25.8359384.61718825.3632815.433594256.40625C24.3554698.14062524.08593810.39453124.0312513.03125C19.23437513.17968814.82031314.42187511.2812516.46875C10.21484415.468758.85546914.968757.514.96875C6.08984414.968754.67578115.5117193.5937516.59375C1.42578118.7617191.42578122.2382813.5937524.40625L3.8437524.65625C3.312526.035156327.488281329C333.5273445.56640637.5859389.562540.4375C13.55859443.28906319.007813452545C30.9921884536.44140643.28906340.437540.4375C44.43359437.5859384733.5273444729C4727.48828146.687526.03515646.1562524.65625L46.4062524.40625C48.57421922.23828148.57421918.76171946.4062516.59375C45.32421915.51171943.91015614.9687542.514.96875C41.14453114.9687539.78515615.4687538.7187516.46875C35.19531314.43359430.80078113.19140626.0312513.03125C26.0937510.54687526.3632818.4687526.8757.09375C27.1640636.31640627.5273445.75781327.8755.4375C28.2226565.11718828.5390635295C29.460938529.6835945.12530.031255.40625C30.3789065.687530.7851566.14843831.31256.6875C32.2539067.65234433.6953138.71484436.093758.9375C36.53906311.23828138.574219134113C43.75134610.75468C465.2543.753413C38.605469336.5742194.71093836.093756.96875C34.31256.79687533.5273446.10937532.755.3125C32.3007814.85156331.8867194.312531.31253.843
</code></pre><p><code>MIDI_ENABLE</code></p><p>This enables MIDI sending and receiving with your keyboard. To enter MIDI send mode, you can use the keycode <code>MI_ON</code>, and <code>MI_OFF</code> to turn it off. This is a largely untested feature, but more information can be found in the <code>quantum/quantum.c</code> file.</p><p><code>UNICODE_ENABLE</code></p><p>This allows you to send Unicode characters using <code>UC(<code point>)</code> in your keymap. Code points up to <code>0x7FFF</code> are supported. This covers characters for most modern languages, as well as symbols, but it doesn't cover emoji.</p><p><code>UNICODEMAP_ENABLE</code></p><p>This allows you to send Unicode characters using <code>UM(<map index>)</code> in your keymap. You will need to maintain a mapping table in your keymap file. All possible code points (up to <code>0x10FFFF</code>) are supported.</p><p><code>UCIS_ENABLE</code></p><p>This allows you to send Unicode characters by inputting a mnemonic corresponding to the character you want to send. You will need to maintain a mapping table in your keymap file. All possible code points (up to <code>0x10FFFF</code>) are supported.</p><p>For further details, as well as limitations, see the <ahref="./feature_unicode">Unicode page</a>.</p><p><code>AUDIO_ENABLE</code></p><p>This allows you output audio on the C6 pin (needs abstracting). See the <ahref="./feature_audio">audio page</a> for more information.</p><p><code>VARIABLE_TRACE</code></p><p>Use this to debug changes to variable values, see the <ahref="./unit_testing#tracing-variables">tracing variables</a> section of the Unit Testing page for more information.</p><p><code>KEY_LOCK_ENABLE</code></p><p>This enables <ahref="./feature_key_lock">key lock</a>.</p><p><code>SPLIT_KEYBOARD</code></p><p>This 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</p><p><code>SPLIT_TRANSPORT</code></p><p>As there is no standard split communication driver for ARM-based split keyboards yet, <code>SPLIT_TRANSPORT = custom</code> must be used for these. It will prevent the standard split keyboard communication code (which is AVR-specific) from being included, allowing a custom implementation to be used.</p><p><code>CUSTOM_MATRIX</code></p><p>Lets you replace the default matrix scanning routine with your own code. For further details, see the <ahref="./custom_matrix">Custom Matrix page</a>.</p><p><code>DEBOUNCE_TYPE</code></p><p>Lets you replace the default key debouncing routine with an alternative one. If <code>custom</code> you will need to provide your own implementation.</p><p><code>DEFERRED_EXEC_ENABLE</code></p><p>Enables deferred executor support -- timed delays before callbacks are invoked. See <ahref="./custom_quantum_functions#deferred-execution">deferred execution</a> for more information.</p><h2id="customizing-makefile-options-on-a-per-keymap-basis"tabindex="-1">Customizing Makefile Options on a Per-Keymap Basis <aclass="header-anchor"href="#customizing-makefile-options-on-a-per-keymap-basis"aria-label="Permalink to "Customizing Makefile Options on a Per-Keymap Basis""></a></h2><p>If your keymap directory has a file called <code>rules.mk</code> any options you set in that file will take precedence over other <code>rules.mk</code> options for your particular keyboard.</p><p>So let's say your keyboard's <code>rules.mk</code> has <code>BACKLIGHT_ENABLE = yes</code>. You want your particular keyboard to not have the backlight, so you make a file called <code>rules.mk</code> and specify <code>BACKLIGHT_ENABLE = no</code>.</p></div></div></main><footerclass="VPDocFooter"data-v-39a288b8data-v-09de1c0f><!--[--><!--]--><!----><navclass="prev-next"data-v-09de1c0f><divclass="pager"data-v-09de1c0f><aclass="VPLink link pager-link prev"href="/data_driven_config"data-v-09de1c0f><!--[--><spanclass="desc"data-v-09de1c0f>Previous page</span><spanclass="title"data-v-09de1c0f>Data Driven Configuration</span><
