Skip to content

Getting started ​

  1. Select your keyboard and the controller variant matching your hardware.
  2. Start from the default layout or use Import project to open a Z-MapFlow JSON project or .keymap.
  3. Select a layer on the left. Click an action in the palette and then a key, or drag the action onto the layout.
  4. Click a key without a selected palette action to edit its parameters. Escape cancels palette selection.
  5. Choose Save to persist the project locally.

Layout and palette ​

The bottom palette contains keys, modifiers, tap/hold, layers, Bluetooth, mouse, resources and language aliases. Searching expands a collapsed palette. Drag the divider to share space between the layout and palette; Home or double-click restores the automatic split.

Main actions are in the right sidebar with tooltips. Layers are on the left of the keyboard, with scrolling when needed. The app version appears discreetly in the header.

The Keys palette expands across the available window width while preserving minimum key widths. On narrower windows, scroll horizontally to reach the remaining keys. Select Keyboard language in the palette to access ABNT2 or an imported language; see keyboard languages.

Behaviors, macros and combos ​

Behaviors provide reusable actions, including tap/hold, tap sequences and modifier-dependent alternatives. Each use may have different parameters. Macros run action sequences. Combos trigger an action when selected key positions are pressed together.

The editor validates parameter counts and types before assignment. Invalid drafts appear in red, preserve the last valid value and block saving. Use Discard draft in the key editor to close without applying invalid text. Firmware compilation checks additional hardware and module rules.

Save and export ​

  • Save persists the current project without building.
  • Build uses the last saved revision.
  • Save and build saves and builds that exact revision.
  • Export project creates an editable JSON project.
  • Export keymap writes ZMK files and required companion files.

Discard restores the last saved state, or the initial imported state before the first save.

Language ​

Choose the interface language in Settings → Application. This does not change your operating system layout or the keycodes in your project. Existing layer and macro names are preserved.

Support the project ​

Star on GitHub and Buy me a coffee remain visible in the header and open their respective pages in your browser. You can also star the repository or support development here. Support is optional; all features remain available.

The app may show a small, non-blocking star invitation after five launches and 30 minutes of active use. A separate donation invitation requires ten launches, two hours of active use and at least three launches after responding to the star invitation. Invitations wait until after the first minute of a session and are hidden during builds, flashing and other dialogs. Background or idle time does not count as active use.

Accepting, closing or choosing No, thanks permanently dismisses that invitation on this computer. The matching header button also dismisses it. The buttons remain available for later voluntary support. Counters and responses are stored locally, separately from keyboard projects, and survive updates. The app does not access your GitHub account, add stars automatically or process payments.

Released under the MIT license.