docs/newbs_building_firmware_configurator.md

   1 # QMK Configurator
   2
   3 The [QMK Configurator](https://config.qmk.fm) is an online graphical user interface that generates QMK Firmware hex files.
   4
   5 ?> **Please follow these steps in order.**
   6
   7 Watch the [Video Tutorial](https://youtu.be/7RH-1pAbjvw)
   8
   9 The QMK Configurator works best with Chrome/Firefox.
  10
  11
  12 !> **Files from other tools such as KLE, or kbfirmware will not be compatible with QMK Configurator. Do not load them, do not import them. QMK Configurator is a DIFFERENT tool. **
  13
  14 ## Selecting your keyboard
  15
  16 Click the drop down box and select the keyboard you want to create a keymap for.
  17
  18 ?> If your keyboard has several versions, make sure you select the correct one.**
  19
  20 I'll say that again because it's important
  21
  22 !> **MAKE SURE YOU SELECT THE RIGHT VERSION!**
  23
  24 If your keyboard has been advertised to be powered by QMK but is not in the list, chances are a developer hasn't gotten to it yet or we haven't had a chance to merge it in yet. File an issue at [qmk_firmware](https://github.com/qmk/qmk_firmware/issues) requesting to support that particular keyboard, if there is no active [Pull Request](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+is%3Apr+label%3Akeyboard) for it. There are also QMK powered keyboards that are in their manufacturer's own github accounts. Double check for that as well.
  25
  26 ## Selecting your keyboard layout
  27
  28 Choose the layout that best represents the keymap you want to create. Some keyboards do not have enough layouts or correct layouts defined yet. They will be supported in the future.
  29
  30 ## Keymap Name
  31
  32 Call this keymap what you want.
  33
  34 ?> If you are running into issues when compiling, it may be worth changing this name, as it may already exist in the QMK  Firmware repo.
  35
  36 ## Creating Your Keymap
  37
  38 Keycode Entry is accomplished in 3 ways.
  39 1. Drag and dropping
  40 2. Clicking on an empty spot on the layout and clicking the keycode you desire
  41 3. Clicking on an empty spot on the layout, pressing the physical key on your keyboard.
  42
  43 Hover your mouse over a key and a short blurb will tell you what that keycode does. For a more verbose description please see
  44
  45 [Basic Keycode Reference](https://docs.qmk.fm/#/keycodes_basic)
  46 [Advanced Keycode Reference](https://docs.qmk.fm/#/feature_advanced_keycodes)
  47
  48 In the event that you can't find a layout that supports your keymap, for example three spots for spacebar, or two spots for backspace, or 2 spots for shift etc etc, Fill them ALL up.
  49
  50 ### Example:
  51
  52 3 spots for spacebar: Fill them ALL with spacebar
  53
  54 2 spots for backspace: Fill them BOTH with backspace
  55
  56 2 spots for right shift: Fill them BOTH with right shift
  57
  58 1 spot for left shift and 1 spot for iso support: Fill them both with left shift
  59
  60 5 spots, but only 4 keys: Guess and check or ask someone who has done it before.
  61
  62 ## Saving Your Keymap for Future Edits
  63
  64 When you're satisfied with your keymap or just want to work on it later, press the `Export Keymap` button. It will save your keymap as the name you chose above appended with .json.
  65
  66 You can then load this .json file in the future by pressing the `Import Keymap` button.
  67
  68 !> **CAUTION:** This is not the same type of .json file used for kbfirmware.com or any other tool. If you try to use this for those tools, or the .json from those tools with QMK Configurator, there is a chance your keyboard will **explode**.
  69
  70 ## Generating your firmware file
  71
  72 Press the green `Compile` button.
  73
  74 When the compilation is done, you will be able to press the green `Download Firmware` button.
  75
  76 ## Flashing Your Keyboard
  77
  78 Please refer to [Flashing Firmware](newbs_flashing.md)
  79
  80 ## Troubleshooting
  81
  82 #### My .json file is not working
  83
  84 If the .json file was generated with QMK Configurator, congratulations you have stumbled upon a bug. File an issue at [qmk_configurator](https://github.com/qmk/qmk_configurator/issues)
  85
  86 If not....how did you miss my big bold message at the top saying not to use other .json files?
  87
  88 #### There are extra spaces in my layout? What do I do?
  89
  90 If you're referring to having three spots for space bar, the best course of action is to just fill them all with space bar. The same can be done for backspace and shifts
  91
  92 #### What is the keycode for.......
  93
  94 Please see
  95
  96 [Basic Keycode Reference](https://docs.qmk.fm/#/keycodes_basic)
  97 [Advanced Keycode Reference](https://docs.qmk.fm/#/feature_advanced_keycodes)
  98
  99 #### It won't compile
 100
 101 Please double check the other layers of your keymap to make sure there are no random keys present.
 102
 103 ## Problems and Bugs
 104
 105 We are always accepting customer requests and bug reports. Please file them at [qmk_configurator](https://github.com/qmk/qmk_configurator/issues)