3. Customizing Keyboard Layout for Windows and Mac with QMK (Version 2022-01-10)
Previous2. About Your Keyboard (Version 2022-01-10)Next4. Customizing Keyboard Layout for Linux with QMK (Version 2022-01-10)
Last updated
Last updated
QMK Toolbox currently does not support Linux. See Section 4 instead.
3.1 Navigate to QMK Configurator to begin creating a custom key map for your keyboard.
A. Keyboard: Selects pre-configured key mappings. Typing in dactyl will bring up a list of different variations of the dactyl_manuform keymapping. Select handwired/dactyl_manuform/5x6 here.
B. Keymap Name: Enter a name for your custom keymap. Eventually, QMK will generate a hex file with the name handwired_dactyl_manuform_5x6_your_keymap_name.hex
C. Download keymap.json: Downloads a keymap.json file with your current keymapping. This file saves your progress as you create a new keymap. You can return to your save point by uploading the keymap.json file on the QMK Configurator website. Note that downloading the keymap.json file is optional and the file is not what you use to flash your keyboard.
D. Upload keymap.json: As described in C, this gives you the option to upload the keymap.json file to return to your save point.
E. Layers: Layers are a QMK specific functionality. The concept is similar to a Fn or FnLock key that is seen on some keyboards. In Figure 3.1, layer 0 is selected. Clicking on 1 or 2 in the layer section will bring up a different keymap.
A layer key is what you actually press on your keyboard to switch to a different layer. On the keymap in Figure 3.1, the layer keys look like "MO(1)" or "MO(2)". The MO(layer) stands for Momentarily activating the layer, similar to a Fn or Shift key on a regular keyboard. For example in the keymap in Figure 3.1, you must hold both "MO(2)" and "P" to get "Scroll Lock" on layer 2. As soon as you release the "MO(2)" key, it goes back to the original layer. Layers range from 0 to 15.
A more useful layer key is the DF(layer) key. The DF stands for Default. Tapping this key switches your keymapping to the new layer until you decide to switch to a different layer by pressing another DF key. This is similar to the FnLock key seen on some keyboards.
F. Keycodes: Drag the keycode onto the keymap to replace the key. As per QMK, North America primarily uses ANSI, Europe and Africa primarily use ISO, and Japan uses JIS. You'll find the MO(layer) and DF(layer) keys by navigating to Quantum > Layer and Layer Tap functions.
G. When you are finished customizing your keymap, click compile. You should see a nice rotating potato baking in outerspace. Once QMK has finished compiling, the Download Firmware button should become clickable.
H. Download Firmware: Download the handwired_dactyl_manuform_5x6_your_keymap_name.hex file. You will use this to flash your keyboard.
3.2 Open the website to QMK Toolbox, which is used to flash the hex file onto your keyboard.
A. Check that you are looking at the latest release. In the photo above, the latest version was 0.0.21. The latest release as of this writing is 0.1.1, but this could be different from what you see.
B. Download QMK.Toolbox.pkg if you use a Mac.
C. Download qmk_toolbox.exe if you use Windows.
3.3 Open QMK.Toolbox.pkg or qmk_toolbox.exe. If you are opening QMK Toolbox for the first time on Windows, you might see a dialogue box asking "Would you like to install drivers for your devices?". Select "Yes".
A. Install Drivers: If this is your first time using QMK Toolbox on your Windows PC and you did not see the install drivers dialogue box, right click the bottom bar of the QMK Toolbox and select Install Drivers.
B. Open Local File: Open the handwired_dactyl_manuform_5x6_your_keymap_name.hex file you previously downloaded.
C. Make sure it says atmega32u4. If it doesn't, it select from the drop down.
D. Select Auto-Flash. Do not click Flash yet! First ensure your keyboard is unplugged from your computer. Disconnect the RJ9 cord from each piece of the keyboard. Then connect only one piece of the keyboard to your computer via USB.
E. After ensuring only one piece of the keyboard is connected to your computer and the RJ9 cord is disconnected from both sides, click Flash. The toolbox will wait for you as you perform the following step.
3.4 Next, double click the reset button seen in Figure 3.4. You will need to use a stick or a pen to click it.
3.5 Repeat sections 2.4 and 2.5 for the other piece of your keyboard.
3.6 Connect the RJ9 cord to the two pieces. Then connect the USB cord from the left keyboard to the computer.
