注意事項

ZMKのファームウェアをGithub上で管理・ビルドする場合、第三者からキーマップや各種設定が覧できるようになります。マクロ等に個人情報（メールアドレス、住所、氏名、パスワード）を登録するのはおやめください。

ZMKにおける３つのキーマップの編集方法

ZMKではキーマップの変更を簡単に行うツールが二つあります。また、直接設定ファイルを書き換えてキーマップを編集する方法もあります。それぞれの特徴を以下に示します。

メリット デメリット 難易度 設定の自由度
ZMK Studio Bluetooth経由でビルドせずともキーマップ書き換え可能（アプリ版のみ） 多彩なZMKの機能が使用できない（Combo, Macroなど） 低 低
keymap editor ほとんどのZMKの機能が使用できる ビルドしてUSB接続経由でファームウェアをキーボードに書き込む必要がある 中 中
直接設定ファイル書き換え トラックボールの動作の変更も行える
すべてのZMK機能を使える コードを書き換えるため、ZMKの知識が必要
ビルドとUSB経由の書き込みが必要 高 高a

ZMK Studio

まずは設定が簡単なZMK Studioから使用してみましょう。

  1. リンクを開くと、キーボードと接続するように指示されます。USB→ZaruBallを選択してください。

    ZMK Studio

  2. ZMK Studioと接続するためにはキーボードをUnlockする必要があります。初期キーマップではレイヤー1（Lower）の右手小指最下段の1.5uキーにてUnlockできます。

  3. Unlockすると、以下のような画面に遷移します。左のタブから編集したいレイヤーを選択します。

    image.png

    <aside> 💡

    TIPS

    レイヤーは+ボタンで最大2つ増やすことができるよう設定しています。

    もっとレイヤーが欲しいという方は増やしてみてください。

    </aside>

  4. 右のキーボードから変更したいキーを押します。

  5. 下のBehaviorとKeyにて選択したキーに割り当てる動作を指定します。

    Behaviorは動作の種類を示しています。一般的なキー入力にはKey Pressを選択して下さい。 その他、多用するBehaviorは以下の通りです。

    Behavior 説明
    Key Press 一般的なキー入力
    Transparent ひとつ上のレイヤーのキーと同じ動作を割り当て
    None キーの無効化
    Momentary Layer キーを押している間だけ指定したレイヤーに移動する機能
    Layer-Tap 長押しでMomentary Layer、短押しで指定したKey Pressに割り当て
    Mod-Tap 長押しと短押しで異なるキー入力に割り当て
    Bluetooth 接続先切り替え、接続情報のクリアなどのキー割り当て
    Output Selection USB接続とBluetooth接続の切り替え
    Studio Unlock ZMK Studioに接続するためのUnlock
    ind_ bat バッテリー残量をlEDの色で通知
    ind_con 接続状況をLEDの色で通知

  6. キーマップ編集が完了したら右上の保存マークで保存してください。キーボードで変更したキーマップが有効になります。

<aside> 💡

ZMK Studioはアプリケーション版とブラウザ版があります

ブラウザ版ではcentral側（PCと通信する側、ZaruBallでは右手側のキーボード）をPCとUSB接続することでキーマップを編集できます

対して、アプリケーション版はBluetooth接続でも編集できます

以下のリンクからダウンロードしてください(Windows, macOS, Linux)

ZMK Studio - Download

</aside>

keymap editor

もっと細かく設定したい！ComboやMacroも使いたい！という方はkeymap editorに挑戦しましょう。

  1. まずはZaruBallファームウェアリポジトリをご自身のアカウントにフォークしてください。複数ブランチがありますが、ZaruBallv1.x〜2.xの方はmainブランチを、v3.xの方はZaruBall-v3.xをご利用ください。

    https://github.com/ImSota/my-shield-module

  2. 以下のリンクからkeymap editorにアクセス。Githubを選択し、ご自身のGithubにログインしてフォークしたZaruBallのファームウェアリポジトリを選択してください。

    Keymap Editor

  3. 以下の画面がでたら、キーマップの変更を行います。基本的な操作はZMK Studioと同様です。

image.png