QMKであそぼ。（ビルド環境構築編）

はじめに

一日で一番手に触れているものはキーボードという思い込みから、不便さを克服することにより得られる快楽を毎日満喫するために小さなキーボードの導入を思い立ち、2022年12月にClaw44の購入を決意。プログラミングと自作キーボードの知識ゼロから始めた自作キーボード素人によるカスタマイズの奮闘記を綴っていきたいと思います。

ビルド環境の構築

いざ、タップダンサーになってみたいとかVialを使ってみたいとか、七色発光体を輝かせてテンションMAXにしたいといっても、QMK Firmwareのビルド環境を構築するのが猫山王のような自作キーボード素人にとってはハードルが高いのも事実である。最近、猫山王の環境下においてQMK MSYSが謎のエラーに見舞われて、にっちもさっちもいかなくなってQMKのビルド環境を再構築したので、Vial信者を増やすべくQMKのビルド環境の構築方法をメモ書き程度の記録として残しておく。

１．QMK MSYSとQMK Firmwareのインストール
QMK MSYSの最新版はここで手に入る。
「Latest Version」をクリックして、QMK_MSYS.exeのダウンロードからのインストールの実行。はい、はいと進んで、チェックマークも全部付けて、OKしとけば良い。
インストール後は、デスクトップのQMK  MSYSのショートカットをクリックして暗黒画面で

qmk setup　エンター

でQMK Firmwareのフォルダーのコピーが開始される。途中、Y 入力・エンターを何度か押すことになるが、基本的に言われたとおりに進めばOK。これでQMKのビルド環境の構築は完了である。如何でしたでしょうか。今までハードルが高いと思っていたQMKの環境構築は簡単でしたね。公式ページのここにも同じ内容が書かれている。

エラーがでれば、

cd qmk_firmware　エンター
qmk doctor　エンター

で、足りないものがあれば自動的に追加してくれるが、初めての環境構築であれば、qmk doctor にお伺いしても何もないとコメントされるだけである。

２．Vial環境の構築
このままの流れで、来るべき日のためにもVial環境も構築しておくことを強くお勧めする。デスクトップのQMK  MSYSのショートカットをクリックして暗黒画面で

git clone https://github.com/vial-kb/vial-qmk　エンター

でvial-qmkのフォルダーのコピーが開始される。途中、Y 入力・エンターを何度か押したかは覚えていないが、基本的に言われたとおりに進めばOK。vial-qmkのフォルダーのコピーが完了すると

cd vial-qmk　エンター
make git-submodule　エンター

でvial-qmkフォルダ内でサブモジュールについてもコピーが開始される。途中、Y 入力・エンターを何度か押したかは覚えていないが、基本的に言われたとおりに進めばOK。最後に

qmk doctor　エンター

で、足りないものがあれば自動的に追加してくれる。これでVial環境の構築は完了である。如何でしたでしょうか。今までハードルが高いと思っていたVial環境構築は簡単でしたね。公式ページのここにも同じ内容が書かれている。

バージョンアップへの対応

いままで何の問題もなくコンパイルできていたのに、ある日突然謎のエラー地獄に陥るときがある。その際にはQMK環境を最新にすることで、エラーが解消される場合もある。ただ、QMK Firmwareは時々破壊的なバージョンアップをすることで有名であり、後方互換がなくなったり手に負えなくなる場合もあるので、QMK Firmwareのバージョンアップには心して取りかかる必要がある。

１．QMK MSYSのバージョンアップ
QMK MSYSを起動して暗黒画面上で

pacman -Syu
python3 -m pip install -U qmk
python3 -m pip install -U -r requirements.txt

をそれぞれ入力・エンターすると、QMK MSYS関連が最新化される。

２．QMK Firmwareのバージョンアップ
破壊的なバージョンアップに追随する場合は、QMK MSYSを起動して暗黒画面上で

git clone https://github.com/qmk/qmk_firmware.git --depth 1 --recurse-submodules --shallow-submodules -b 0.22.3 qmk_022.3

を入力・エンターすると、指定したバージョン(上記であれば、0.22.3)を指定したフォルダー(上記であれば、qmk_022.3)にコピーしてくれる。
また、上記以外にもqmk doctorにお伺いすることで不足しているファイルのコピーが開始され、エラーが解消される場合もある。コマンドは下記参照。

cd qmk_firmware　エンター   "qmk_firmware"は修行僧の環境に合わせて変更
qmk doctor　エンター

ビルド環境の再構築

QMK MSYSの起動時やコンパイル時に謎のエラーを吐き出すようになって、バージョンアップへの対応やqmk doctorにお伺いしてもにっちもさっちもいかなくなった場合には、ビルド環境を再構築することが手っ取り早い確実な方法である。

１．QMK MSYSのアンインストール
Windowsの設定のアプリのアンインストールからQMK MSYSのアンインストールを行う。

２．QMK_MSYSフォルダとqmk_firmwareフォルダの削除
QMKのビルド環境の構築手順に戻る前に、CドライブからQMK_MSYSフォルダとqmk_firmwareフォルダを直接削除しておく必要がある。この手順を行わないままビルド環境の再構築を試みたところ猫山王のケースだとエラーは解消されずにっちもさっちもいかないままであった。これは古いファイルの残党があれば、それを生かそうとすることからくる負の連鎖と思われる。ビルド環境の再構築の場合は過去との決別の意味合いも込めてアンイントールの手順では削除できないファイル・フォルダを削除しておくのが良いのであろう。なお、qmk_firmwareフォルダを削除する前には、お気に入りのキーボードのFirmwareのバックアップをとっておかないと、今までの修行の成果が水の泡となるので留意が必要である。

３．ビルド環境の再構築
あとは、ビルド環境の構築手順に従って、再度QMKのビルド環境を構築する。

おわりに

今回はQMKのビルド環境の構築からの再構築という、QMKの誕生からその最後までをお届けした。ビルド環境の構築は意外なほど簡単で、自作キーボードは敷居が高いと思われている方にとって、一日で一番手に触れているものはキーボードということで、不便さを克服することにより得られる快楽の世界への入門のための勇気づけとなれば幸いです。