zmkfirmware
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: studio features list (#2598) 

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Peter Johanson <peter@peterjohanson.com>
This commit is contained in:
Nicolas Munnich 2024-11-03 00:30:01 +01:00 committed by GitHub
parent 1cfce345ba
commit 40f59df2cc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/docs/features/studio.md
View File

@ -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.