diff options
| author | Nicolas Munnich <[email protected]> | 2024-11-03 00:30:01 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-11-03 00:30:01 +0100 |
| commit | 40f59df2cc68bdeec15f47f1a4983fee350a24fe (patch) | |
| tree | eafb2432f9375dd73d97210b28be4ac0d349a80f | |
| parent | 1cfce345bab7d8b577096a2144ada02731f317bd (diff) | |
| download | zmk-40f59df2cc68bdeec15f47f1a4983fee350a24fe.tar.gz zmk-40f59df2cc68bdeec15f47f1a4983fee350a24fe.zip | |
docs: studio features list (#2598)
Co-authored-by: Cem Aksoylar <[email protected]>
Co-authored-by: Peter Johanson <[email protected]>
| -rw-r--r-- | docs/docs/features/studio.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/docs/features/studio.md b/docs/docs/features/studio.md index fb7c90cbc3..9c98c70636 100644 --- a/docs/docs/features/studio.md +++ b/docs/docs/features/studio.md @@ -10,6 +10,35 @@ ZMK Studio is in beta. Although every effort has been made to provide a stable e ZMK Studio provides runtime update functionality to ZMK powered devices, allowing users to change their keymap layers without flashing new firmware to their keyboards. Studio is still under active development, and is not yet ready for casual end user use. +## Capabilities + +ZMK Studio currently has the following capabilities: + +| Legend: | ✅ Supported | 🚧 Under Development | 💡 Planned | 🕯️ Low Priority | ❌ Not Planned | +| :------ | :----------- | :------------------- | :--------- | :-------------- | -------------- | + +| Status | Feature/Capability | +| :----: | ----------------------------------------------------------------------------------------------------------------------------------------- | +| ✅ | Making keymap changes while keyboard is in use | +| ✅ | Making changes while connected via USB | +| ✅ | Native app for: Windows, Linux, MacOS | +| ✅ | Making changes while connected via BLE (Linux web-app & native apps only) | +| ✅ | Assigning [predefined behaviors](../keymaps/behaviors/index.mdx) to keys | +| ✅ | Assigning [user-defined behaviors](../keymaps/behaviors/index.mdx#user-defined-behaviors) to keys | +| 💡 | [Configuring basic behavior properties](../config/behaviors.md) | +| 💡 | Configuring advanced behavior properties, e.g. [tap dance](../keymaps/behaviors/tap-dance.mdx), [macros](../keymaps/behaviors/macros.md), | +| ❌ | Defining new behaviors not specified in devicetree | +| 💡 | Configuring [combos](../keymaps/combos.md) | +| 💡 | Configuring [conditional layers](../keymaps/conditional-layers.md) | +| 🕯️ | Assigning behaviors to encoders | +| ✅ | Selecting alternative pre-defined physical layouts for the keyboard | +| ❌ | Defining new physical layouts for the keyboard | +| ✅ | Renaming layers & enabling [extra layers](#including-extra-layers) | +| ❌ | Adding more layers than specified by devicetree | +| 💡 | Host locale selection | + +Items listed as "planned", "under development", "low priority", or "not planned" can be configured using [devicetree](../config/index.md#devicetree-files) instead. + ## Keymap Changes To unlock your keyboard to allow ZMK Studio to make changes, you'll need to add a [`&studio_unlock`](../keymaps/behaviors/studio-unlock.md) binding to the keymap. |