Skip to content

Commit

Permalink
docs: studio features list (zmkfirmware#2598)
Browse files Browse the repository at this point in the history 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Peter Johanson <peter@peterjohanson.com>
  • Loading branch information
@Nick-Munnich @caksoylar @petejohanson
3 people authored Nov 2, 2024
1 parent 1cfce34 commit 40f59df
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/docs/features/studio.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 40f59df

Please sign in to comment.