zmk/docs/src/pages/keymap-upgrader.mdx
Joel Spadin 7fafc0bd71 refactor: Improve keymap upgrader
Moved the keymap upgrader to a top-level page like the power profiler
to make it more discoverable. It upgrades more things than key codes
now, so putting it in the codes category doesn't make much sense.

Converted the upgrader code to TypeScript and split it up into smaller
files to make it easier to add new upgrade functions.

Added upgrade functions to remove/replace "label" properties and rename
matrix-transform.h to matrix_transform.h.
2024-01-22 12:43:37 -06:00

20 lines
879 B
Text

---
title: Keymap Upgrader
sidebar_label: Keymap Upgrader
hide_title: true
hide_table_of_contents: true
---
# Keymap Upgrader
Some behaviors, key codes, and other features have been renamed to be more consistent with each other. This tool will upgrade most deprecated features to their replacements.
Paste the contents of a `.keymap` file below. Then, hover your mouse over the upgraded keymap and click the `Copy` button in the upper-right corner to copy it to your clipboard.
You will likely need to realign columns in the upgraded keymap. The upgrader also does not handle
codes inside a `#define`, so you will need to update those manually using
[this list of deprecated codes and replacements](https://github.com/zmkfirmware/zmk/blob/main/docs/src/keymap-upgrade/keycodes.ts).
import KeymapUpgrader from "@site/src/components/KeymapUpgrader/index";
<KeymapUpgrader />