qmk_firmware/assets/ChangeLog_20230528.md.BQOXA7rR.js

16 lines
77 KiB
JavaScript
Raw Normal View History

import { _ as _export_sfc, c as createElementBlock, o as openBlock, a8 as createStaticVNode } from "./chunks/framework.B9AX-CPi.js";
const __pageData = JSON.parse('{"title":"QMK Breaking Changes - 2023 May 28 Changelog","description":"","frontmatter":{},"headers":[],"relativePath":"ChangeLog/20230528.md","filePath":"ChangeLog/20230528.md"}');
const _sfc_main = { name: "ChangeLog/20230528.md" };
const _hoisted_1 = /* @__PURE__ */ createStaticVNode('<h1 id="qmk-breaking-changes-2023-may-28-changelog" tabindex="-1">QMK Breaking Changes - 2023 May 28 Changelog <a class="header-anchor" href="#qmk-breaking-changes-2023-may-28-changelog" aria-label="Permalink to &quot;QMK Breaking Changes - 2023 May 28 Changelog&quot;"></a></h1><h2 id="notable-changes" tabindex="-1">Notable Changes <a class="header-anchor" href="#notable-changes" aria-label="Permalink to &quot;Notable Changes {#notable-changes}&quot;"></a></h2><p>As per last breaking changes cycle, there has been <em>a lot</em> of emphasis on behind-the-scenes changes, mainly around migration of configurables into <code>info.json</code> files, cleanup of <code>info.json</code> files, additional layout definitions for keyboards, adding support for general community layouts to keyboards, as well as addressing technical debt.</p><p>Of note for keyboard designers:</p><ul><li>Layout and matrix definitions in <code>info.json</code> are now <em>mandatory</em> for merge into QMK. <ul><li>Layout macros in <code>&lt;yourkeyboard&gt;.h</code> are no longer accepted into QMK Firmware.</li><li>Existing keyboards have been meticulously converted by the QMK collaborators</li><li>Layouts missing from keyboard definitions have been added in the process</li><li>Keys within layouts should not specify <code>&quot;w&quot;:1</code> or <code>&quot;h&quot;:1</code> if the key size is 1 -- <code>w</code>/<code>h</code> should only be present for sizes other than 1</li></ul></li><li><code>config_common.h</code> has been removed and should not be present anywhere in your keyboard code.</li><li><code>RGB_DI_PIN</code> will now cause an error during build: <ul><li>For WS2812-like LEDs, this should be moved to <code>info.json</code>: <code>&quot;ws2812&quot;: { &quot;pin&quot;: &quot;xxx&quot; }</code></li><li>For APA102 LEDs, this should be moved to <code>info.json</code>: <code>&quot;apa102&quot;: { &quot;data_pin&quot;: &quot;xxx&quot; }</code></li></ul></li><li>Other mandatory data-driven changes should be automatically flagged during build</li><li>Keymaps with <code>encoder_map</code> should now have the following change made: <ul><li><code>encoder_map[][NUM_ENCODERS][2]</code> =&gt; <code>encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS]</code></li><li>Users assumed the <code>2</code> referred to the number of encoders, rather than the number of directions (which is always 2)</li></ul></li></ul><h3 id="repeat-last-key" tabindex="-1">Repeat last key (<a href="https://github.com/qmk/qmk_firmware/pull/19700" target="_blank" rel="noreferrer">#19700</a>) <a class="header-anchor" href="#repeat-last-key" aria-label="Permalink to &quot;Repeat last key ([#19700](https://github.com/qmk/qmk_firmware/pull/19700)) {#repeat-last-key}&quot;"></a></h3><p>A new pair of keys has been added to QMK -- namely <code>QK_REPEAT_KEY</code> and <code>QK_ALT_REPEAT_KEY</code> (shortened: <code>QK_REP</code>/<code>QK_AREP</code>). These allow you to repeat the last key pressed, or in the case of the alternate key, press the &quot;opposite&quot; of the last key. For example, if you press <code>KC_LEFT</code>, pressing <code>QK_REPEAT_KEY</code> afterwards repeats <code>KC_LEFT</code>, but pressing <code>QK_ALT_REPEAT_KEY</code> instead sends <code>KC_RIGHT</code>.</p><p>The full list of default alternate keys is available on the <a href="./../features/repeat_key">Repeat Key</a> documentation.</p><p>To enable these keys, in your keymap&#39;s <code>rules.mk</code>, add:</p><div class="language-make vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">make</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">REPEAT_KEY_ENABLE = yes</span></span></code></pre></div><p>...and add them to your keymap.</p><h3 id="user-callback-for-pre-process-record" tabindex="-1">User callback for pre process record (<a href="https://github.com/qmk/qmk_firmware/pull/20584" target="_blank" rel="noreferrer">#2
const _hoisted_47 = [
_hoisted_1
];
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
return openBlock(), createElementBlock("div", null, _hoisted_47);
}
const _20230528 = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
export {
__pageData,
_20230528 as default
};