Keybard
Svalboard-QMK launch edition

The Keybard
user manual.

Connect your board, make your first change, and learn every part of Keybard.

11 chaptersIllustrated walkthroughsBrowser editor + desktop Trainer
Open Standard Keys and drag A directly onto Q to replace its binding
Open the panel. Drag a letter. See the change. Open Standard Keys, drag A onto Q, and release. The key now shows A. Actual offline example; no keyboard writes.

Written against Keybard 8d01073. Screenshots use the bundled example and may show fewer behavior slots than current firmware. Connected hardware exposes additional controls. All screenshots can be enlarged.

Chapter 01 / Choose your starting point

Start with a keyboard—or an example

Keybard lets you configure your Svalboard, organize layers, create advanced bindings, and set up an on-screen trainer. You can explore the editor before connecting hardware. This guide starts with one ordinary key change, then builds toward reusable layouts and reliable backups.

Choose a starting point on the welcome screen:

ChooseWhat happensUse it for
Connect KeyboardThe browser asks which keyboard to open, then Keybard reads its configuration.Editing your connected Svalboard.
Load FileA saved layout opens as an offline draft.Inspecting a backup or continuing exported work.
QWERTY ExampleA bundled example opens without a keyboard.Learning the controls safely.
Open an example and make a first edit: actual Keybard workflow
Open an example and make a first edit. Open QWERTY Example, open Standard Keys, and drag A directly onto Q. This is an offline draft; no keyboard is changed. Offline example.

Three places your work can live

On your SvalboardThe saved configuration

Runs on the keyboard. Connecting reads it; applying edits changes it.

In this browser sessionThe current draft

May include unsaved changes. The layout you see is not always what the board runs.

On your computerAn exported file

A copy you keep. Export downloads it; import reviews which parts can be applied.

Take the five-minute tour

  1. Choose QWERTY Example.
  2. If only icons are showing, click the logo at the top of the left navigation rail to reveal its labels. Hovering an icon also identifies it.
  3. Open Standard Keys and drag a letter from the palette onto the position you want to change. Release it and check the new legend.
  4. Switch layer tabs to see how the same physical positions can carry different bindings.
  5. Choose Export Layout in the editor toolbar if you want to keep your experiment.
Offline means no keyboard writes. An example or loaded file is a draft in the current session. Export it before closing or refreshing. Connecting a keyboard later reads that keyboard; it does not automatically install your draft.

Demonstrations play automatically when visible. Autoplay is enabled even when your system requests reduced motion.

Most illustrations use the bundled offline example. Captions explicitly identify connected controls shown with controlled test-board data. No screenshot is presented as proof of a hardware write.

Chapter 02 / Connect your board

Connect and protect your starting point

Welcome → Connect Keyboard → browser device chooser

Use a desktop browser that supports WebHID, such as Chrome or Edge, and a USB data connection. The connection button is unavailable when the browser lacks the required API. Keybard's browser editor expects compatible Svalboard firmware; seeing a keyboard in a device chooser does not establish firmware compatibility.

  1. Connect your Svalboard by USB, open Keybard, and choose Connect Keyboard.
  2. Select the intended keyboard in the browser's chooser and grant access. With several keyboards attached, check which one you selected.
  3. Wait for the layout to load. Hover the connection/update controls to check the editing target before changing anything.
  4. Choose Export Layout. Keep the native .svil (Recommended) and Include Macros enabled, then choose Export.
  5. Name the downloaded file clearly—for example, before-first-edit.svil—and keep it somewhere you can find again.
Back up before editing. Export captures the configuration currently shown in the editor, including staged changes. Exporting after experiments does not recover the untouched configuration you originally connected to.
Export a backup: completed action in the actual Keybard interface
Export a backup. Open Export Layout and export the native .svil file. The recording verifies a downloaded file; this example uses the browser download fallback. Browsers with a native save picker show a Save dialog instead. Offline example.

Coming from an older configuration tool

Keep your existing layout backup before changing firmware. You can open a legacy .vil file offline to inspect it, but Keybard blocks direct import of old-protocol layouts into connected Sval firmware when keycode migration is required. Renaming the file extension is not a conversion.

For Svalboard Vial-QMK v2025-11-01 with the vial keymap, the firmware can migrate supported configuration on first boot. Follow the firmware upgrade instructions, connect in Keybard, and verify layers, macros, modifier options, timing and pointing settings. Then export a fresh native .svil. Other old or custom builds are not covered; keep the old file as a reference and recreate anything not migrated. A supported firmware migration is different from importing a legacy file in the browser.

Understand the editing target

StateMeaning
Editing keyboardChanges can be written to the connected device.
Offline draftChanges affect the loaded file or example in this session. Export to keep them.
Pending changesThe editor has changes waiting to be written; the displayed layout may differ from the board.
Not savedA write failed. Some writes may already have succeeded; follow the retry guidance.
Chapter 03 / Your first edit

Make and verify your first change

Offline Keybard editor with navigation, layer tabs, and the Svalboard layout
An offline example of the editing workspace: navigation on the left, layer selection above the layout.

Start with one easy-to-recognize binding on a known layer. Keep the keys you need for navigation and switching layers intact until you are comfortable restoring changes.

Review and apply a queued change
Review and apply a queued change. Change one setting in Manual Updates, check that Pending shows 1, then choose Apply 1 Change. The write endpoint is simulated test-board data; no physical keyboard is changed.

Choose when changes reach the board

Live Updating is on by default. While connected, ordinary queued edits are saved as you make them. For a controlled first experiment, use the lightning control labeled Switch to Manual Updates. You can then review pending edits before applying them.

ControlEffect
Live UpdatingEdits are saved as you make them; watch for saving or error messages.
Apply N ChangesWrites the pending changes in Manual mode.
Discard pending editsDiscards the current unsaved edits. It does not reverse changes already applied.
Switch to Live UpdatingApplies pending changes before enabling Live Updating.
  1. Select the layer you intend to edit.
  2. Open Standard Keys.
  3. Drag the replacement key from the palette onto the target position and release. Alternatively, select the position first and click a palette key.
  4. Check the resulting legend. In connected Manual mode, Pending (N) counts the edits waiting to be written.
  5. Choose Apply N Changes and wait for saving to finish. Do not assume a changed legend alone means the board was updated.
  6. Deselect the key, switch to a text editor, activate the appropriate layer, and test the result.
  7. Export the verified configuration as a new file.
Drag A onto the Q position: completed action in the actual Keybard interface
Drag A onto the Q position. Watch the pointer pick up A from Standard Keys, drag it onto Q, and release. The position now shows A. This changes the offline example only.
Swap two existing keys: actual Keybard workflow
Swap two existing keys. Drag Q onto A to exchange their bindings, then drag them back to restore the original layout. Palette-to-layout dragging assigns; layout-to-layout dragging swaps. Offline example.
Typing can assign a key. Typing Binds a Key is enabled by default. With an editing target selected, pressing a physical key can assign that key, including modifiers, to the target. Deselect before testing normal typing, or turn this option off in Settings → General.

Dragging an existing layout key onto another position swaps bindings, including across layers. Use this deliberately: it is different from copying a palette key. If an Undo button appears, its tooltip identifies the operation it can reverse; do not treat it as unlimited editing history.

Chapter 04 / Work with layers

Build a layout you can navigate

A layer is another set of bindings for the same physical key positions. Editing a layer tab changes what you are looking at in Keybard; using a layer binding on the physical keyboard changes what the keyboard types.

TermMeaning
Base/default layerThe starting layer used when no higher active layer provides a binding.
Transparent keyLooks through to a lower active layer for its binding.
Blank keyProduces no action at that position instead of falling through.
Momentary layer keyActivates another layer while held.
Layer-tap keyTypes one action when tapped and activates a layer when held.

Open Layer Keys for layer bindings. Start with a momentary key leading to a small navigation or symbols layer. Keep the activation key usable while that layer is active; a transparent binding at the corresponding position is often appropriate.

Build a small navigation layer: actual Keybard workflow
Build a small navigation layer. On unused layer 3, select three positions and press Left, Down, and Right to assign them using Typing Binds a Key. Return to base and assign MO(3). The remaining layer-3 positions inherit through Transparent. Offline example.
Combine a tap key with a layer hold: actual Keybard workflow
Combine a tap key with a layer hold. Assign A, select it again, choose Layer Keys → LT, then choose layer 3. The resulting key is A on tap and layer 3 on hold. Offline example.

Build a simple navigation layer

  1. Choose an unused layer, such as layer 3, and assign a small group of arrow keys from Standard Keys. Make the other positions transparent if they should inherit the base.
  2. Return to the base layer and select a spare position for entering navigation.
  3. Open Layer Keys, choose Momentary (MO), and assign the tile for layer 3 to that position.
  4. Review and apply the edits, then deselect the target. In a text editor, hold the new key and try the arrows. Release it and confirm normal typing returns.

For a tap action on the same key, assign its desired tap key first, select the position again if needed, then choose Layer Tap (LT) and its destination. The composer derives the tap action from the selected position.

Layer Keys choiceWhen to use it
Momentary · MOActivate a layer only while held.
Layer Tap · LTSend a key on tap; activate a layer on hold.
Toggle Layer · TGTurn a layer on or off with a tap. Keep a way to toggle it off.
Tap Toggle · TTHold momentarily, or tap the configured number of times to toggle.
One Shot Layer · OSLActivate a layer for the next key.
To Layer · TOReplace other active layers while retaining the default. Plan a return binding.
Default Layer · DFChange the base for this power session.
Persistent Default Layer · PDFSave the chosen base across power cycles.

Name, inspect, and reuse layers

Give a layer a useful name: actual Keybard workflow
Give a layer a useful name. Click Layer 0, enter Base, and leave the field to save the name in this offline layout. Offline example.
Compare layers together: actual Keybard workflow
Compare layers together. Use Show Multiple Layers, then 3D View to change the presentation. Viewing a layer does not activate it on the keyboard. Offline example.
Save a reusable layer: actual Keybard workflow
Save a reusable layer. Open the layer actions, choose Save Layer…, give it a name, and find it in Layouts. This is local browser storage, not a complete backup file. Offline example.

Click a layer name to rename it. Use its color control to make related layers easier to recognize. The layer's actions menu offers Copy Layer, Paste Layer, Make All Blank, Make All Transparent, and conversions between blank and transparent keys. Whole-layer operations affect many positions; check the target layer first.

Show Multiple Layers helps compare layers. 3D View changes their presentation. Hide All Transparent Keys helps inspect inherited bindings; it does not rewrite those transparent keys. Show All Layers reveals layers hidden by the transparent-layer filter.

  1. Open a layer's actions menu and choose Save Layer... to put a reusable copy in the local Layouts library.
  2. Open Layouts and expand a saved or imported layout.
  3. Drag the desired layer onto the destination layer in the editor.
  4. Read the replacement confirmation and confirm only when the destination is correct.
  5. Review and apply the resulting changes according to your update mode.
Apply a layer from the library: actual Keybard workflow
Apply a layer from the library. Choose destination layer 3, drag the library’s Layer 0 preview onto it, read the replacement confirmation, and choose OK. Check the destination before confirming. Offline example.

Start from a layout Svalboard provides

Layouts → sval-alt-alphas or sval-num-sym-layers

Besides your own saved layers, Layouts lists groups provided by Svalboard. Use any of their layers the same way as a saved one: drag it onto a layer in the editor.

GroupLayersWhat they are
sval-defaultThe stock layersThe standard Svalboard layout, for getting back to a stock layer.
sval-alt-alphasDvorak, Colemak, HD Promethium, HD Neu, GraphiteBase layers for alternative letter layouts. Each is the stock base layer with only the letters and that layout’s own punctuation moved, so your thumb keys and layer keys stay where they were. HD Promethium puts R on a left thumb key; Graphite adds Repeat on a right thumb key.
sval-num-sym-layersHome-row numbers (default NavNAS), Left-hand tenkey + right-hand navTwo numbers, symbols and navigation layers. The first is the factory NavNAS layer from the Svalboard firmware, with 1–0 on the center keys, shifted symbols above them and navigation below. The second puts 1–0 under the left hand as a tenkey, with arrows on the right home row. Their thumb keys are Transparent, so your base layer’s thumb keys keep working.
Put Dvorak on the base layer: actual Keybard workflow
Put Dvorak on the base layer. With layer 0 selected, search Layouts for Dvorak, drag its preview onto Layer 0, and choose OK. The letters move; the thumb keys stay. Offline example.
  1. Export a backup first if you are changing a layer you rely on, such as your base layer.
  2. Select the destination layer in the editor. For a letter layout this is usually layer 0; for a numbers layer, the layer your NavNAS key opens (layer 1 in the stock layout).
  3. Open Layouts and type a name, such as Colemak or tenkey, in the search box.
  4. Drag the layer’s preview onto the destination layer’s name. Read the confirmation, which names both layers, and choose OK.
  5. The destination keeps its own name but takes the layer’s color; rename it if you like. Review and apply the changes according to your update mode.
Try a different numbers layer: actual Keybard workflow
Try a different numbers layer. Select layer 1, search for tenkey, drag Left-hand tenkey + right-hand nav onto Layer 1, and choose OK. Offline example.

To try a letter layout without giving up your current one, drag it onto a spare layer instead, and add a Default Layer · DF key for that layer from Layer Keys. DF changes the base until the board restarts. You can also drag single keys out of a preview onto a position in your layout. Deleting a Svalboard group from Layouts is not permanent; Keybard adds it back.

Choose Transparent or Blank in Keybard: actual Keybard workflow
Choose Transparent or Blank in Keybard. On layer 3, set the A position to Transparent, then Blank. Return to base: A is still there. The comparison below explains what happens when the upper layer is active. Offline example.
Local library, not a backup service. Saved layers and imported library items belong to this browser's local storage. Export important configurations to files; clearing browser data can remove local library content.

Transparent keeps the key underneath. Blank turns it off.

Suppose a position types A on your base layer. You hold a key to activate another layer. What should that same position do while you hold it?

Keep typing A

Set that position to Transparent on the upper layer.

Upper layer · active while held▽ TransparentUse the assignment underneath ↓
Base layer · underneathA

Press this position → A

Make this position do nothing

Set that position to Blank on the upper layer.

Upper layer · active while heldBlankStop here. Do not use the key underneath.
Base layer · blockedA

Press this position → nothing

Release the layer key: you return to the base layer, so this position types A again in both cases. Blank disables it only while the upper layer applies.

If you assign a different key—such as 1—on the upper layer, the position types 1 while that layer is active.

Chapter 05 / Build useful behaviors

Give a key more than one job

Special Keys groups additional actions such as media and system controls; Layer Keys and Mouse Keys have their own palettes. Use the same select-and-assign or drag-and-drop interaction as Standard Keys.

A normal assignment sends a key. A behavior can send a sequence, distinguish a tap from a hold, or recognize several keys together. Start with one small example, verify it in an empty document, and then build on it. The maintained Svalboard firmware provides 256 slots each for macros, tap dances, combos, overrides, alternate-repeat mappings, and leader sequences. Available entries depend on the firmware or file you have loaded.

Editing and using are different steps. A macro or tap dance needs both a definition and a key that invokes it. Combos and overrides respond to their configured triggers. Leaders need a Leader key as well as a sequence. In Manual Updates, apply the queue with Apply N Changes before testing on the board. In Live Updating, supported edits reach the board as you make them. Close the binding editor, deselect the assignment target, and focus a disposable text document before testing: typing while an assignment target is selected may change the layout.

Macros: send a short sequence

Macro Keys → edit a slot

A macro runs its actions in order. Begin with something harmless, such as the text “hello”. You can author a macro in an offline layout; executing it requires assigning it on a connected board.

Create and assign a text macro: actual Keybard workflow
Create and assign a text macro. Add a Text action containing hello, close the editor, and drag Macro 0 onto Q. Both the definition and the invoking key are now in the offline draft. Offline example.
  1. Open Macro Keys and edit an unused numbered entry. In the compact bottom-panel presentation, the plus control opens an empty entry.
  2. Add Text and enter hello. Give the macro a useful name by clicking its title where renaming is available.
  3. Close the editor. Select a spare position in your layout, then choose that macro’s numbered key tile, or drag its tile onto the position.
  4. Apply queued changes if necessary. Deselect the assignment and focus an empty document. Press the physical key once; it should type your text.
  5. Return to the editor to add actions only after the small example works. Export a fresh backup when you are happy with it.

Key Tap presses and releases a key. Key Down holds it, and Key Up releases it. Delay inserts a pause in milliseconds. For a chord, use a modifier down, a key tap, and a matching modifier up. Always balance held keys with releases. Macro storage is shared across entries, rather than a separate fixed allowance for each macro.

Text macros send keyboard input, not clipboard contents. The operating system’s keyboard layout affects the resulting characters; do not assume arbitrary Unicode text will work. Start with simple text and test punctuation in your actual OS layout. Avoid using passwords or other secrets as examples: a macro and an exported configuration are not a secure secret store.

Tap dances: tap, hold, or tap twice

Tap Dance Keys → edit a slot

A tap dance gives one physical position several outputs. A simple learning example is Tap: A and Double-Tap: B, with unused actions left empty. This makes the difference easy to see in a scratch document.

Configure and assign a tap dance: actual Keybard workflow
Configure and assign a tap dance. Enable entry 0, assign A to Tap and B to Double-Tap, then drag its tile onto Q. The recording shows configuration; test physical tap timing on your board. Offline example.
  1. Open an unused entry in Tap Dance Keys.
  2. Select the Tap slot and assign A. Select Double-Tap and assign B. Hold is a sustained press; Tap-Hold is a tap followed by a held press.
  3. Review the timing field and leave Enabled on. Avoid changing timing and every action at once.
  4. Close the editor and assign the entry’s tap-dance tile to a spare keyboard position. Apply queued changes.
  5. Deselect and test a single tap, then a quick double tap in an empty document. Adjust the timing if your deliberate double taps are being separated.

Release before editing. Release a held tap-dance key before changing its action. The launch firmware has a known edge case where editing a held dance can leave its previous output held.

Combos: press a small chord

Combos → edit a slot

A combo recognizes up to four input keycodes pressed within its timing window, and emits an Output. For example, A and B together can send Escape. These are keycode triggers, not a named pair of physical positions: consider where those assignments appear in your layers.

Make A + B send Escape: actual Keybard workflow
Make A + B send Escape. Enable a combo, choose A and B as its first two inputs, then set Output to Escape. No separate combo key is needed. Offline example.
  1. Choose an unused combo. Fill the first two input slots with A and B and choose Escape for Output.
  2. Leave the remaining input slots empty and enable the entry.
  3. Apply changes. Deselect, focus a safe test window, and try each key separately before pressing them together.
  4. If the chord is difficult to catch, review Combo Timeout in the Combos panel while connected. Increase it cautiously: a generous window may catch ordinary typing rolls.

Choose combinations that are comfortable but uncommon in your normal text. After verifying the mechanics, replace the demonstration with your preferred inputs. There is no separate assignment step beyond having those input keycodes available on the keyboard.

Modifiers, mod-taps, and one-shots

Standard Keys → Modifiers → Mod, Mod-Tap, and One-Shot Mod

A modifier chord, a held modifier, and a mod-tap are different tools. A chord such as Ctrl+C sends a shortcut. A mod-tap can send A when tapped and hold Control when held. A one-shot modifier lets you tap Shift, release it, and then type a shifted key without holding both keys together.

  1. For the A/Control example, first assign A to the target position then select that position again if assignment cleared the selection.
  2. In Standard Keys, select Control under Modifiers. The constructed keys use the currently selected position’s base assignment.
  3. Choose the generated Mod-Tap tile. Do not choose the standalone modifier or one-shot tile by mistake.
  4. Apply changes, deselect, and test a tap in a scratch document. Then hold the key while pressing another key to verify the modifier behavior.

For a one-shot Shift, choose Shift and the generated one-shot tile instead. Test by tapping that key, releasing it, and typing a letter. Modifier controls include left/right choices; other composer presentations offer MEH (Control, Shift, Alt) and HYPER (those plus GUI). GUI is the Windows/Command-style modifier interpreted by your OS.

Use QMK Settings → One Shot Keys to review timeout and repeated-tap locking. Mod-tap decisions also depend on the Tap-Hold settings described below. Test typing rolls as well as isolated presses; a configuration that works slowly can feel different at speed.

Make one key A on tap and Control on hold: actual Keybard workflow
Make one key A on tap and Control on hold. Assign A, select the position again, choose CTRL, then choose the generated mod-tap tile. Assignment can clear selection, so reselect before composing. Offline example.
Assign one-shot Shift: actual Keybard workflow
Assign one-shot Shift. Select a position, choose SHIFT, and select the OSM tile. On your board, tap and release this key before typing the letter you want shifted. Offline example.

Overrides: change an action under a modifier

Overrides → edit a slot

An override replaces a trigger when its modifier and layer conditions match. A useful example is Shift+Backspace producing Delete. It changes how an existing assignment behaves, so you do not place an “override key” in your layout.

Make Shift + Backspace send Delete: actual Keybard workflow
Make Shift + Backspace send Delete. Enable the entry, choose Backspace and Delete, and select Shift in both Trigger and Suspended. Suspending Shift means the replacement is Delete without Shift. Offline example.
  1. Set Trigger to Backspace and Replacement to Delete.
  2. In the Trigger modifier tab, select the Shift modifier you use. Review handedness if you use both Shift keys.
  3. Use Suspended for the triggering modifier you do not want included with the replacement. Negative specifies modifiers that prevent the override; leave it empty for this basic example.
  4. Select the intended Layers, enable the entry, and keep advanced activation options at their existing defaults unless you have a reason to change them.
  5. Apply, deselect, and test against expendable text: Backspace should retain its normal action, while the configured Shift combination should perform Delete.

Leaders: type an ordered sequence

Leaders → Leader key and sequence entries

A leader sequence is ordered input after a dedicated Leader key. Unlike a combo, its keys are typed in succession. For a harmless first example, Leader, A, B can trigger a macro that types “hello”.

Set up Leader, A, B: actual Keybard workflow
Set up Leader, A, B. Enable the A-then-B sequence with Macro 0 as its output, then assign the Leader key. Create the hello macro in the preceding example first. Offline example.
  1. Create and test the simple text macro first.
  2. Open Leaders. Assign its Leader tile to a spare position.
  3. Edit an unused sequence. Set its first two keys to A and B, and its Output to your macro. Enable it. Sequences allow up to five keys.
  4. While connected, review Leader Timeout. Per-key timing resets that timeout after each key; otherwise the sequence shares its time allowance.
  5. Apply, deselect, focus a scratch document, and press Leader followed by A then B within the allowance.

Alternate repeat: associate two actions

Alt-Repeat → edit a mapping

Alternate repeat uses the remembered key to choose an alternate action. For exploration, map A to B and assign the alternate-repeat action to a spare position. After typing A, invoke alternate repeat and inspect the result in a scratch document.

Map A to B and assign alternate repeat: actual Keybard workflow
Map A to B and assign alternate repeat. Enable the A-to-B mapping, then place the Alt-Rep key in the layout. This records configuration, not firmware execution. Offline example.
  1. Choose an unused entry, set Trigger to A and Alternate to B, and enable it.
  2. Assign the alternate-repeat action from the panel to a physical position. Apply the changes and deselect.
  3. Test the simple mapping before exploring Bidirectional, Ignore mod handedness, or Default to alternate.

The launch firmware has known defects involving modifier matching and default-alternate behavior. Treat custom mappings as something to verify, especially with modifiers; do not depend on an untested mapping for a critical shortcut.

Chapter 06 / Pointing & mouse keys

Set up your pointing devices

Pointing Devices

Connect the board to see its sensor-specific controls. A loaded file can supply assignable pointing keys through the picker, but offline previews cannot demonstrate sensor behavior. The controls and ranges depend on the installed pointer, so your panel may differ from the example.

Adjust one pointer setting: actual Keybard workflow
Adjust one pointer setting. Change the left pointer from 800 to 1200 DPI. This uses controlled test-board data to demonstrate the controls; it is not a recommended sensitivity or a sensor test.
  1. Start with ordinary pointer movement. Adjust the left or right sensitivity in small steps, applying queued edits as needed.
  2. Test scrolling and its direction. Review per-side scrolling controls, axis lock, and natural scrolling where available.
  3. Assign a Sniper hold key to try slower, precise movement. Boost does the opposite. The 2×, 3×, and 5× versions choose the factor; toggle versions stay active without holding the key.
  4. If you use automouse, confirm its target layer contains useful mouse bindings and a comfortable way back to ordinary typing. Check which pointer may activate it, then tune threshold, decay, and timeout one at a time.
  5. Verify normal movement, scrolling, and layer return before exporting a backup.

Mouse Keys are keyboard-generated mouse movement and button actions; they are not the same as physical sensor sensitivity. TrackPoint recalibration applies to TrackPoint hardware. Avoid copying a sensitivity number between different sensor types and expecting identical movement.

Known firmware edge cases include buffered scrolling, combinations of speed factors, and disabling an active automouse layer. Keep the first configuration simple and verify the behavior you actually use.

Chapter 07 / Settings & diagnostics

Settings, timing, and board identity

Settings → General → QMK Settings…

Stage a timing change: actual Keybard workflow
Stage a timing change. Change Tapping Term from 200 to 210 ms. Pending (1) and Apply 1 Change appear. Controlled test-board data; the recording does not write physical hardware.
Change appearance and turn off typing assignment: actual Keybard workflow
Change appearance and turn off typing assignment. Try Dark, return to Light, and switch Typing Binds a Key off. These preferences belong to this browser. Offline example.

Settings has four sections: General, Fragments, Backups (see Automatic backups) and Developer. Browser choices include appearance, assignment behavior, and international palette selection. Choose a palette matching your OS keyboard layout; this does not change the OS layout itself. Settings → Fragments selects the finger and thumb assemblies used to draw your board. It describes the installed arrangement rather than rewiring it.

For timing, export a baseline first. Change one control, apply it, and test both slow deliberate presses and normal typing. Tapping Term influences tap-versus-hold decisions. Quick Tap Term affects repeated dual-role tapping. Permissive Hold (new), Hold On Other Key Press, and Retro Tapping (new) control how other presses and releases affect that decision. Chordal Hold uses the hand relationship between keys; Flow Tap can favor taps during rapid typing and is off at zero.

Tap Code Delay controls generated tap duration, Tap Hold Caps Delay handles generated Caps Lock taps, and Tapping Toggle controls TT’s tap count. Their launch defaults are 0 ms, 80 ms, and five taps; a stored toggle count of zero behaves as one. Grave Escape provides separate “Always send Escape” options for Alt, Control, GUI, and Shift.

A visible setting is not a guarantee that a firmware feature is enabled. Standard launch builds do not include Auto Shift, and some mouse-key settings have no runtime consumer. Use the launch notes for those limits rather than repeatedly adjusting an ineffective field.

Where supported, Board name changes how the keyboard appears to your computer. Save now writes immediately, even in manual mode; restart the keyboard for the USB name to change. Apply or export outstanding edits before restarting. Board identity is separate from a layout backup.

Settings → Developer → Scan Lab… is for advanced scanning, power, and firmware diagnostics. Its timing application and bootloader controls can affect hardware immediately. For a simple “does this switch register?” check, use Matrix Tester instead. Power estimates are not battery-life measurements, and longer idle intervals can delay the first response after inactivity.

Change a fragment and restore it: actual Keybard workflow
Change a fragment and restore it. Open Settings → Fragments, change the first finger cluster in the offline example, then restore its original selection. On your own board, choose the arrangement matching your hardware. Offline example.

Check every physical switch

Editor toolbar → Matrix Tester

  1. Connect the board and open Matrix Tester from the toolbar.
  2. Press each finger direction and each thumb key, holding briefly so the polling display can see it. Compare the highlighted position with the one you pressed.
  3. Use Clear Matrix to clear the visual test history and try again. It does not erase your layout or board settings.
  4. Exit Matrix Tester to return to editing.

This is a physical-switch check, not a monitor of the final text produced by macros, combos or tap dances. Very brief presses can fall between snapshots. If the matrix sees the switch but typing is wrong, inspect its layer and binding rather than assuming the switch failed.

Read and clear Matrix Tester history: actual Keybard workflow
Read and clear Matrix Tester history. Open Matrix Tester, see three switch reports, then use Clear Matrix. Reports are simulated test-board data; this is not a physical switch test.

Open Settings → General → Print Layers…. Review the non-empty layers and choose Print, then use the browser’s print dialog to print them or save a PDF. A printed diagram is a learning reference; export a .svil as well for an editable backup.

Prepare a printed layer reference: actual Keybard workflow
Prepare a printed layer reference. Open Settings → Print Layers…, review the layer count, then choose Print. The final frame shows Keybard’s actual print layout; the native print dialog is outside this browser recording. Offline example.
Chapter 08 / Backups & reusable layouts

Back up and import with confidence

Keybard keeps two kinds of backup. Automatic backups are snapshots Keybard saves on its own while a board is connected. Exported files are copies you make yourself and keep wherever you like. Use both: automatic backups catch the change you forgot to save, and an exported file survives a new computer or a cleared browser.

Automatic backups

Settings → Backups

Nothing needs to be turned on. While a board is connected, Keybard saves a snapshot of its configuration:

A snapshot holds the same information as an exported .svil file. If nothing changed since the previous snapshot, no new one is added.

A new automatic backup appears after an edit: actual Keybard workflow
A new backup appears after an edit. In Manual Updates, drag A onto Q. About ten seconds later, Settings → Backups lists a new Edited entry: 1 key, Unsent (1). Controlled test board; the earlier entries were added to show a history.

Backups are grouped by board, with the connected board first. Keybard tells boards apart by their USB serial number (or, with older firmware, the keyboard’s ID), so two Svalboards keep separate histories even if they share a name. Each entry shows:

ShownMeaning
Date and timeWhen the snapshot was saved.
Connected or EditedSaved when the board connected, or after you edited it.
Change summaryWhat changed since the previous backup of this board, such as 2 keys, 1 macro. The first backup of a board says As loaded.
Unsent (N)The snapshot includes N edits that were still pending in Manual Updates. Restoring it brings those edits back, even though the board never received them.

The newest eight backups of each board are shown; Show all lists the rest. Keybard keeps every backup from the last 24 hours, the latest backup of each day for 30 days, and after that the latest of each month. The most recent Connected backup is always kept.

Restore, download or delete a backup

Restore an earlier backup in Manual Updates: actual Keybard workflow
Restore an earlier backup. Choose Restore beside the October 3 backup, read the review, and choose Stage import. The differences wait under Pending until you apply them. Controlled test board; nothing is written.

Keep a copy in a folder

Automatic backups live inside the browser. To also keep them as ordinary files, choose Choose backup folder in Settings → Backups, pick a folder, and allow Keybard to edit files there. This needs a browser that lets websites save to a folder, such as Chrome or Edge; elsewhere the button is unavailable.

Choose a backup folder: actual Keybard workflow
Choose a backup folder. Choose backup folder, then Keybard shows the folder's name with Change folder and Stop using folder. It writes latest.svil and one dated file per day with backups. The recording replaces the system folder chooser with a stand-in folder.

Browsers ask again before a site may keep writing to a folder. When that happens, Settings → Backups shows Paused and a Resume backups button. Choose it, and if the browser offers Allow on every visit, choose that so later visits continue without asking. Backups made while paused are written when you resume. If the folder was moved or deleted, Keybard shows Folder not found; choose a folder again. Change folder switches to another folder, and Stop using folder stops writing files. Files already written stay where they are, and the browser's own backups continue.

Automatic backups have limits. They belong to this browser profile on this computer; another browser, profile or computer has its own list. Clearing this site's data deletes them, though copies in a backup folder remain. Only a connected board is backed up, not an offline example or file. Before a firmware update, export a .svil and keep it somewhere outside the browser.

Export and import files

Editor toolbar → Export Layout or Import Layout

Use native .svil for your working backups. The legacy .vil export retains QMK settings, but does not preserve all Sval-specific hardware values and metadata, including names, colors, and cluster selections.

OperationWhat it preserves or changes
Export LayoutDownloads the editor's current configuration, including staged work.
Load File on welcome screenOpens an offline draft; does not write a board.
Import Layout in editor toolbarReviews configuration changes for the current target.
Restore in Settings → BackupsOpens the same import review for an automatic backup.
Import in Layouts panelAdds reusable layouts to the browser library.
Save Layer...Saves one layer locally for reuse, not a complete device backup.

Import a compatible backup onto a connected keyboard

  1. Connect the destination board and export its current configuration before making changes.
  2. Apply or discard pending edits before beginning an import.
  3. Choose Import Layout, select the file, and read Review layout import.
  4. Check the destination, counts, warnings, and errors. Back up current layout is available in the review.
  5. In Manual mode, choose Stage import, review pending changes, then Apply. In Live Updating, Apply import writes the changes. Offline, Open layout replaces the current draft.
  6. Check the imported bindings and test important actions before relying on them.
Review and open an imported layout: actual Keybard workflow
Review and open an imported layout. Use Import Layout, read the offline review, then choose Open layout. On a connected board the review and write controls differ; see the steps below. Offline example.

Import is not a complete device-image restore. The current importer keeps the board's alt-repeat entries, leaders, one-shot configuration, layer colors, and fragment state. It reports unsupported fields and settings. Entries beyond the incoming file's layers and tables are kept rather than erased.

A file may be rejected for mismatched matrix dimensions, too many layers or table entries, incompatible keycodes, unsupported macro content, or capacity limits. Read the specific message instead of forcing the file through. Native backups preserve information even when a particular field cannot yet be restored automatically.

Chapter 09 / The desktop Trainer

Trainer and the desktop overlay

Trainer, directly below Layouts

Trainer previews the appearance and controls the optional desktop overlay. The browser is useful for choosing a style or reviewing an offline layout. Keybard Host supplies the native transparent window above your other applications and reads live board state directly. Its board operations are read-only.

Choose a readable overlay style: actual Keybard workflow
Choose a readable overlay style. Apply High contrast, then try the Busy background to judge readability. This is the browser appearance preview.
See the overlay respond to layer changes
See the overlay respond to layer changes. The actual shared native renderer receives controlled reports: base, symbols, function keys, then base with held-key highlighting. This demonstrates rendering; it is not a Windows desktop recording or a hardware latency test.

Install and show the Windows overlay

  1. Select Download for Windows at the top of Trainer. Extract the ZIP and run Start-Windows.cmd.
  2. Allow the first launch to download its private runtime. It needs internet, but no administrator rights, system Python, or PATH changes.
  3. The app opens Keybard. Connect your keyboard normally and select Trainer. If needed, use Connect to Keybard Host and allow the browser’s local-device access request. The install panel also links to local Keybard when Host is running.
  4. Choose the board in the host selector and use Show overlay. Host remembers its selected board for reconnection.
  5. Drag the overlay into place. In Overlay, optionally enable Click through keyboard; the small handle remains available for moving or hiding it. Place at bottom provides a convenient starting position.

The companion stays in the system tray when you close the browser. Use Hide overlay or the overlay’s handle controls to get it out of the way. After editing the keyboard layout, choose Reload layout so the companion refreshes its cached copy. If reconnection fails, check the host board selection and USB connection rather than importing a different layout to mask the problem.

The Windows download is a portable preview, not a signed installer. Linux source launch is available, with Wayland limitations for placement, stacking, click-through, and modifier reporting. macOS remains unverified; equivalent validated packages for all platforms are not promised.

Choose what you can see

Start with an Appearance preset, then adjust Key fill, Outline, and Legend colors and opacity independently. Try Contrasting legend halo over busy backgrounds. Use Outline thickness for definition without making the fill more opaque. Hands and Overlay size are in Overlay.

In Feedback, choose Layer-change highlight: Off, Quick flash, or Short fade, and its duration. Enable Highlight held keys for a matrix-tester-like indication. Matrix polling can miss very brief taps and does not describe every generated macro or combo output. The preview’s Preview held keys button simulates a chord.

Current firmware reports active and default layers automatically, including changes during use. Older firmware may require Default layer (older firmware). For offline previews, choose Default layer and Preview layer. Layout source distinguishes a loaded snapshot, editor draft, example, imported trainer layout, and a live read-only board. Import for trainer changes the preview source; it does not write that file to the keyboard.

Preview highlighting: actual Keybard workflow
Preview highlighting. Choose Short fade and use Preview held keys to see a simulated chord. The browser preview does not measure native overlay latency.
Look at different layers in Trainer: actual Keybard workflow
Look at different layers in Trainer. Change Preview layer from base to symbols to function keys, then return to base. This only changes the preview.

Practice recall without recording your typing

Practice one recall prompt: actual Keybard workflow
Practice one recall prompt. Enable Recall practice, decide where the requested binding lives, Reveal it, then choose Remembered to advance. Grading is your own assessment.
  1. Open Practice and enable Recall practice. Read the requested binding and hand, and decide where you would press.
  2. Choose Reveal, then Remembered or Again to advance. This is not an automatic typing test.
  3. For selective help, choose a key in the preview or the binding selector, click Mark familiar, and enable Hide familiar legends.
  4. Turn practice off to return to ordinary reference. Closing the temporary controls also returns the desktop overlay to reference mode.
Hide a binding you already know: actual Keybard workflow
Hide a binding you already know. Select a familiar binding, choose Mark familiar, and enable Hide familiar legends. The preview hides that binding’s legend.

Recall counts and familiar selections are temporary practice state, not a durable learning-history service. Appearance preferences are saved separately. When following the board, recall can also hide desktop legends; otherwise you are practicing against the selected preview layout.

Chapter 10 / Return to your work

Return to your work

After a refresh, Keybard intentionally returns to the welcome screen. Previously permitted keyboards can appear under or reconnect without the chooser. Select the correct device to read its saved state again.

Return to a saved file: actual Keybard workflow
Return to a saved file. Choose Load File on the welcome screen and open a .svil file. The operating-system file chooser is not included in this browser recording. Offline example.

Connected boards are also backed up automatically. If you forgot to export, open Settings → Backups: each board’s recent sessions are listed there, in this browser. See Automatic backups.

To continue offline work, choose Load File and reopen your exported draft. Browser preferences and the local Layouts library can persist, but they are not an automatic recovery copy of the current editor session.

Before each editing session, check the target, update mode, selected layer, and whether a key is selected. Use a small naming convention for backups: one before a major change, one after verification. Keep both until the new layout is comfortable.

Chapter 11 / Troubleshooting

Recover from common problems

I cannot connect

Check WebHID browser support, the USB data connection, the chosen device, and compatible firmware. Close other configuration applications if they are holding the device, then reconnect. A previously granted browser permission is not proof that the cable, firmware, or current device connection is working.

The layout changed, but typing did not

Check whether you are editing an offline draft or have pending Manual changes. Confirm the physical keyboard is on the layer you edited. Transparent keys may inherit a different binding, and a layer-tap key waits to distinguish a tap from a hold.

Typing unexpectedly changed a binding

Deselect the target and check Typing Binds a Key. In Manual mode, discard unwanted pending edits. If a change was already applied, explicitly restore the previous binding; discarding does not undo saved writes.

A save failed

Read the Not saved message. Pending edits remain, and some earlier writes may already have succeeded. If still connected, use Retry. If the device disconnected, export the retained draft before reconnecting. Reconnection reads the board again and may discard pending edits. An automatic backup saved after your edits also holds them, marked Unsent. Compare that state with your saved draft, then review an import if appropriate, observing the restore limitations above.

A name will not save

Layer, macro and tap-dance names have a 16-byte UTF-8 limit on supported firmware. Accented characters and emoji can use several bytes each. Shorten the name and read the error. A board’s USB name is a separate setting with its own limits.

Controls or layers seem missing

Expand the navigation rail, reveal Show editor controls if the toolbar is collapsed, or use Show All Layers. Some settings depend on firmware capabilities and attached hardware; an offline example cannot demonstrate every connected-device function.