qmk / qmk.fm

The website-side of qmk_firmware! The compiled binaries are generated automatically on every push to the main repo

How to add translations of the qmk.fm website

Each language should have its own folder in _i18n/, named using the ISO 639-1 language code, followed by - and the country code where relevant. A list of common ones can be found here.

Permalinks should be generated automatically from the filename, but need to be set manually for index.md pages. The lang variable should be set on all pages. Both of these, along with title (used in <title> in the head, and other metadata) are exemplified in the front matter (put at the top of the file) here:

---
title: "QMK固件"
permalink: /zh-cn/
lang: "zh-cn"
---

A summary.md is needed to render the sidebar content - _includes/en_sidebar.md should be used as the template. Links should be relativised with the language preceding it: /zh-cn/support.

The _data/strings.yml file also needs to have an entry for the language:

  zh-cn: &DEFAULT_ZH_CN
    <<: *DEFAULT_EN
    language_name: "中文"
    language: "语言"
    qmk_firmware: "QMK固件"

The <<: *DEFAULT_EN allows zh-cn to inherit all values from the English entry, and the keys following it override those. It's recommended to translate all entries for full coverage.

qmk.fm's Issues

[Feature Request] Keychron C1

Description

Would love to see Keychron supported! Specifically a C1 for me (it has an unmappable Siri/Cortana key).

[Feature Request] KBDPad MK III Firmware Support

Description

Hello!
I'm currently trying to change the firmware on my KBDPad MK II keypad, but it seems they updated the pcb with firmware for a mk III and the MK II option in the configurator doesn't flash properly and needs the new firmware from the website. https://kbdfans.com/products/gb-kbdpad-markii-mechanical-keyboard-kit
Would it be possible to add the new firmware to the site?
Thank you!

I've done goofed - qmk.fm isn't building properly after my commit.

Hi! After my commit which included Polish translations, GitHub Pages isn't able to build the repo.
I'm not sure what went wrong yet, but I hope I can fix it or at least learn what I did wrong.
@noroadsleft or @drashna , could you help me understand what's wrong?

There are identical files only differing in capitalisation. This doesn't work on windows

I'm in the process of adding a page for a keyboard, and git has complained about some "duplicate" files.

in particular:

• compiled/handwired_CMD60_default.hex and compiled/handwired_cmd60_default.hex
• compiled/handwired_MS_sculpt_mobile_default.hex and compiled/handwired_ms_sculpt_mobile_default.hex

It seems the lower-case files are much newer, and it probably isn't even intentional to have two copies around. But I don't know that for sure :)

Search index isn't working

The search index on the docs site seems to not be working for some terms. I see this when searching for "adjust"; first letter works fine, subsequent characters produce the following error in the console:

lunr.min.js:7 Uncaught TypeError: Cannot read property 'tf' of undefined
    at t.Index.documentVector (lunr.min.js:7)
    at t.Index.<anonymous> (lunr.min.js:7)
    at Array.map (<anonymous>)
    at t.SortedSet.map (lunr.min.js:7)
    at t.Index.search (lunr.min.js:7)
    at LunrSearchEngine.search (search-lunr.js:34)
    at Object.query (search-engine.js:31)
    at launchSearch (search.js:79)
    at handleUpdate (search.js:121)
    at HTMLInputElement.<anonymous> (search.js:142)

Seems to be an issue with lunr (see olivernn/lunr.js#243) which Gitbook uses. Having never used Gitbook and being unfamiliar with the context, it seems that the fix is just to recreate the index.

Gamakay/Womier K61

Description

I'm new to all this, and got my first keyboard which is Gamakay K61, is it possible to add it to QMK? I would like to rebind keys in it. On box it says ARM 33bit mcu & led controller.

I would love to see it added to QMK

Satan GH60 RevCHN

I'm sure this has been asked before but I'm struggling to find any information. I'm new to keyboards and assumed that the GH60 was supported by QMK_Firmware but now I have the board and soldered it up it appears not.
I'm not new to embedded programming so I guess if I can make sense of the schematic and the build process then I could port the firmware?
So no this ain't an issue but didn't see where else to question the project.

handwired/dactyl_lightcycle is missing

Hi guys !!!, handwired/dactyl_lightcycle is missing from the list. dactyl and dactyl/manuform are in the list, but the version of the dactyl with 4 rows x 6 columns and 5 thumb keys per hand is missing.
Thanks !!!

GK68x(s) QMK support!

Hello, is there any plans to support QMK for this keyboard ?? She has an M3 MCU microcontroller and 8 megabytes of memory.

Veloclifire M2

Is Your's firmware compatibile with my keyboard? Thanks in advance

[Feature Request] Can you add some akko keyboards.

Description

yunzii akko arc 61 and other akko keyboards if possible can they be added. I use akko acr 61 and i had not being able to use qmk firmware being able to program different keys and more.

crkbd is listed under supported keyboards, but only .hex is provided

When I try to flash my Proton C using QMK Toolbox, it says that only .bin is supported for dfu.

replace gratipay with liberapay

Gratipay has shut down.

https://gratipay.news/the-end-cbfba8f50981

There is a fork, Liberapay. Gratipay has hand their asset's over to them.

I also use Liberapay sucessfully, so i can reccommend that!

That will fix this broken link on your website: https://gratipay.com/QMK/

generate_keyboard_page.sh needs to be updated to use hex or bin files

Specifically:

qmk.fm/_util/generate_keyboard_page.sh

Lines 11 to 14 in e613bbf

	if [ -e compiled/${keyboard}_default.hex ]; then
	echo -n "| <i class='fa fa-github' aria-hidden='true'></i> [${line}](https://github.com/qmk/qmk_firmware/tree/master/keyboards/${line}) | " >> _pages/keyboards.md
	echo -n "[<i class='fa fa-download' aria-hidden='true'></i>](https://qmk.fm/compiled/${keyboard}_default.hex \"$line's latest default QMK firmware\")" >> _pages/keyboards.md
	echo -n "[<span class='fa-stack fa-lg'><i class='fa fa-circle fa-stack-1x'></i><i class='fa fa-inverse fa-stack-1x psi-icon'>&Psi;</i></span>](qmk:https://qmk.fm/compiled/${keyboard}_default.hex \"Open in QMK Toolbox\")" >> _pages/keyboards.md

This needs to be updated to look for hex or bin files.

Unfortunately, I'm not quite sure how to do that, as bash/shell scripts are not something that I'm familiar enough with.

KLE to convertion QMK fails

How I discovered the bug
I pasted the raw data from http://www.keyboard-layout-editor.com/#/gists/2fea0143064790fed378761bfa7f5600
in to https://qmk.fm/converter/
I tried to upload the result in to https://config.qmk.fm , but I get this error message

Sorry, this doesn't appear to be a QMK keymap file.

I had to rename the *.json file to *.txt to make attachment possible.

info.txt

Keyboard not supported

Information

• None of the other issue templates apply

Description

How could I know whether a keyboard that is not on your list is just a rebranded version of one that is supported by qmk?

Particurlarly, I need to know about the TEENII T1

[Bug] Missing Default Firmware .hex/.bin Files

Describe the Bug

Tried to load in the .hex file for the new momoka_ergo and qmktoolbox cannot find the file. Going on the qmkconfigurator allows me to grab a default / customized .hex file.

Additional Context?

No response

Support for Keychron K8 Pro QMK or Q3

Description

Hi,

With the new K8 and the Q3 keyboard from Keychron, there are now 80% keyboards with QMK firmware from this manufacturer, but I can't find a suitable layout for them.

https://www.keychron.com/products/keychron-k8-pro-qmk-via-wireless-mechanical-keyboard

https://www.keychron.com/products/keychron-q3-qmk-custom-mechanical-keyboard

Add the Kyria as a Powered by QMK keyboard

I'd be interested in having the Kyria featured as one of the keyboards that's supported by QMK. What are the steps I can undertake to make that happen?

[Feature Request] Not able to change the configuration of my Ducky one 2 SF

Description

Not able to change the configuration of my Ducky one 2 SF keyboard although it is listed in the layout edit tab, but I am not able to enter the flashing state in the configurator tool

Language symbol

On the main page https://qmk.fm/ rather than using the word Language/Sprache/Idioma/Langue/भाषा/Lingua/ഭാഷ/इंग्रजी/Linguagem/Язык/语言/言語 it may be better to use a language translation icon from http://www.languageicon.org/ Can implement this if it seems ok.

Getting XD60/64 V3 Underglow Working

Hello Everyone,
A while back I built a keyboard using the XD60/64 PCB and I installed the QMK firmware onto it relatively easy with just a couple of hiccups. The keyboard matrix works just fine and I love being able to customize the firmware so much, but I cannot get the RGB underglow working on this keyboard. It worked just fine when I bought it still had the stock TMK firmware, but since then I haven't been able to get it working. After some digging in the config.h files for this board and my layout, it seems that the current layout for the xd60 in the repository is for the v2 version of the board, and I have the v3 version. After pulling up a diagram of the pinouts of the atmega 32u4 I tried specifying some different pins that weren't being used to no success. Occasionally the keyboard stops working if I wiggle the USB-C connector when the board is outside of its case and the one of the underglow LED's will flash green when this happens. Simply plugging the board back in solves that issue, but I know that at least that LED isn't burnt out.

I guess my main question is how should I go about solving this. I'm not sure how I would get a board schematic. I'm not the most experienced dealing with microcontrollers and C but I have done a little bit. I wish I had a better multimeter and setup to probe around the board to see where everything is going but since it's multilayered I haven't had much luck with my limited skills.

delete

delete

[Bug] - ERROR: It seems you are not using the MINGW64 terminal.

Describe the Bug

I tried install qmk on Windows 10, I acted as it was told here - https://docs.qmk.fm/#/newbs_getting_started
Both of MYSYS2, python, pip and git have been installed successfully, and it seemed that qmk itself has been installed successfully:

Using legacy 'setup.py install' for halo, since package 'wheel' is not installed.
Using legacy 'setup.py install' for termcolor, since package 'wheel' is not installed.
Using legacy 'setup.py install' for hid, since package 'wheel' is not installed.
Building wheels for collected packages: pyrsistent
Building wheel for pyrsistent (PEP 517) ... done
Created wheel for pyrsistent: filename=pyrsistent-0.18.0-cp39-cp39-msys_3_2_0_x86_64.whl size=56362 sha256=bb97405e07d30e64d20a4634bba097f87338c9f37b361338e1667fd4ff4cb114
Stored in directory: /home/MQ/.cache/pip/wheels/dd/c8/61/04c6d218b3691f75353d7f74fed3fbd40e0ee9e2d1e2ce24c6
Successfully built pyrsistent
Installing collected packages: colorama, termcolor, spinners, six, log-symbols, pyrsistent, halo, attrs, argcomplete, appdirs, qmk-dotty-dict, pyusb, pygments, milc, jsonschema, hjson, hid, qmk
Running setup.py install for termcolor ... done
Running setup.py install for halo ... done
Running setup.py install for hid ... done
Successfully installed appdirs-1.4.4 argcomplete-1.12.3 attrs-21.2.0 colorama-0.4.4 halo-0.0.31 hid-1.0.4 hjson-3.0.2 jsonschema-4.2.1 log-symbols-0.0.14 milc-1.6.5 pygments-2.10.0 pyrsistent-0.18.0 pyusb-1.2.1 qmk-1.0.0 qmk-dotty-dict-1.3.0.post1 six-1.16.0 spinners-0.0.24 termcolor-1.1.0

but , when I ran "qmk --version" and "qmk - version", it always prompted:

ERROR: It seems you are not using the MINGW64 terminal.
Please close this terminal and open a new MSYS2 MinGW 64-bit terminal.
Python: /usr/bin/python3.exe, MSYSTEM: MSYS

even when I opened a new MSYS2 MinGW 64-bit terminal:

• https://ibb.co/J52YmrB

• https://ibb.co/94k6HzM

Additional Context?

No response

Idobao Montex Pad missing

Can’t find it anywhere

KP_3 does not exist

For some reason, on the keyboard configurator, where you select which keys you want on the slot you've selected, there is no 3 there is another 4 instead (https://i.imgur.com/N5jKP8D.png). Even when I have a number pad plugged in, qmk.fm will recognize the other numbers if I fill them in by physically pressing the keys, but not 3. As far as I can tell, there is no way to bind anything to KP_3 at all.

[Bug] *** No .hex file found, trying https://qmk.fm/compiled/montex_default.bin Something went wrong when trying to get the default keymap file.

Describe the Bug

Howdy

I'm always getting this error msg when trying to flash my idobao montex numpad firmware.

I've check on the website there is a missing montex hex file

Please assist me to help so that I can remap my montex numpad thank you

Additional Context?

No response

flabbergast keyboard

hi .. could you help me add the flabbergast keyboard to qmk .. here are the files from tmk
kb45p.zip

planck-like OCD40 based on QMK

https://github.com/80Ultraman/OCD40_Keyboard.git

Encoder page link in features page

The encoders page https://docs.qmk.fm/#/feature_encoders has not been linked properly to the features page https://docs.qmk.fm/#/features. Can someone please update the features page with a link to the encoders page.

NT980 Keyboard Firmware

Information

• None of the other issue templates apply

Description

I recently bought a new keyboard from Aliexpress called the NT980. When I plugged initially plugged it into my computer, it worked perfectly fine, RGB and all. The only problem I ran into was that it wasn't being detected by VIA, and it was advertised that it supported VIA. Looking up the supported firmware, I saw there was a folder named NT980 from Evyd13, thinking that was the firmware I needed to flash onto my keyboard to fix the problem. After flashing that firmware, the keyboard ceased to work, and I can't find the correct firmware in order to fix my problem.
Let me know what can be done :) Thank you guys.

<details> not displaying properly in beta.docs

I updated the handwire guide (https://github.com/qmk/qmk_firmware/blob/master/docs/hand_wire.md) and it displays great in regular https://docs.qmk.fm/#/hand_wire but does not display properly in https://beta.docs.qmk.fm/for-makers-and-modders/hand_wire

The areas that do not display correctly are within <details> tags

Include Proton C damage warning in temporary page and in final docs

Some of the PCBs compatible with Pro Micro have VCC and RAW pins conected (shorted) on the pcb (found one when converting Gherkin keyboard). Using the Proton C will short 5V power from USB and regulated 3.3V which is connected directly to MCU. Shorting those pins will likely damage the MCU on Proton C.

Please include the warning and information about leaving 5V pin of Proton C unconnected if a pcb has shorted those pins on the temporary page regarding Proton C. Please include this in the final documentation also.

Iqunix F96 keyboard is missing

Information

• None of the other issue templates apply

Description

Hi!
i want to try the program but the template for my keyboard is missing. I have a Iqunix F96, which is a ISO 96 layout keyboard. there is even a ANSI version of this keyboard. please report when keyboard added!

System76 Launch keyboard use QMK by default

Information

• None of the other issue templates apply

Description

The System76 Launch Keyboard https://system76.com/accessories/launch uses QMK by default and it says on the website to file an issue if a keyboard uses QMK by default to get listed.

[Bug] loading of keyboard_list.json fails with CERT_DATE_INVALID response

Describe the Bug

When trying to access the config.qmk.fm/#/ webpage, the initial fetch of the keyboard lists JSON fails.

Additional Context?

Have tried numerous times over the day to access and tried to access from different machines, as well. Same result.

Add the idobao montex as a Powered by QMK keyboard

Hello:
I'd be interested in having the montex as one of the keyboards that's supported by QMK.

Help with keymapping RK61 Keyboard

New to coding, so got a starter mechanical keyboard, however a lot of the keys I need to use are either really poorly placed or don't exist on the keyboard (backslash for example).

I would LOVE to remap smoother features and a full key set, if it wasn't for the poor software that comes with the RK61 (That doesn't work for my non-RGB version) then this keyboard would be a perfect startup keyboard!

Could anyone help me with this so I can make full use of QMK? Thanks!

ID67 missing from the list

On IDOBAO website it states that it is QMK compatibile but I can't find qmk.fm for it.
https://www.idobao.net/products/idobao-id67-65-hot-swappable-mechanical-keyboard-kit-1

Design flaw in Let's Split SVG

There are a couple of design flaws in the SVG and other issues that I list here:

1. The standoff cutouts from the top and bottom plates are not aligned. I tested this both in the design itself and also on an actual print and the holes definitely are off by a few millimeters. See attached image (I highlighted two but this applies for all of them).
   

2. The elements on the top plate are not properly centered. See how the margin on the left is narrower than the margin on the right. See attached image
   

3. The standoff cutouts, in the file, are defined as paths and not as ellipses. More than a necessity, it's really for convenience that they should be actual objects and not paths, just like every other element in the design (the switch cutouts, the plates, etc.)

4. This is where I don't know where to go. I've been banging my head against the wall trying to export this thing to .DXF using Inkscape to get the case laser cut in the local shop but every time the exported file would only show the standoff cutouts and not the rest of the design. This is because Inkscape (and probably every other SVG to DXF export tool?) only exports paths and not objects. So there is a step in between which is to select everything on Inkscape and convert all the objects to paths. We could then either:

   • make the SVG ready with paths so that people only have to export to DXF (not a great idea since if we are to accept contributions, modifying paths is way harder than modifying objects)
   • make a short mention on the docs to convert everything to paths before exporting to DXF
   • include the DXF file already in the project, the SVG being the source and the DXF being the compiled version for the convenience of everybody.

5. There is a layer leftover from the Ponoko template called DELETE bird before uploading which doesn't bring any value since it ain't doing anything. It's just noice. It would be nice to get rid of it.

missing 0.01 z62

I would love to see firmware for 0.01 z62 keyboard.

Turns out the manufacture's webpage no longer works, so getting software requires grepping redit and discord channel :(

Automated Cleanup of depreciated firmware images

Right now, the commands that push everything over from Travis doesn't check old files. So keyboards that have been moved, renamed, or the like still have their old firmware images in the compiled folder.

This isn't an issue usually, unless there is a case change of the name (and only a case change).

Also, it would help to keep the repo size down, in the long run.

404-s under kc60

I was trying to access keymaps from here: http://qmk.fm/keyboards/kc60/ :

• default -> 404
• sgoodwin -> 404
• workman-dead -> 404
• wiggunoi -> OK
• stanleylai -> OK
• ws2812 -> OK

KBD19X in QMK Toolbox

Hi, i can't find the KBD19X in QMK Toolbox

怎样定制minila配列的固件?

你好，这上边的都是编译好的，我想定制一个minila配列的，请问怎样修改 layout 呢?

QMK Support

Dear Sir:
I am sales director from Westberry, an chip maker company.
We want to support QMK and contribute our code like STM32F103/303
Could you help to tell me what's steps in detail.

           BR

           Lee Wang

[Feature Request] K617 fizz

Description

would there be any future support for BYK916 (a rebranded of Sinowealth SH68F90) chip? I saw someone on reddit said that the problem with this chip is that there is no data sheet for it but I found one in a Chinese site. would this help you support keyboards with this chip? i belive its 8bit with 64k storage

Links to other documentation are broken

For instance, the link to the basic keycodes under "Going beyond the keycodes" is broken. This is because it is a relative link to a file that only exists in the qmk_firmware GH repo.

Proposed solutions:

1. The markdown and text contents of the doc folder from the qmk_firmware repo should be mirrored here and converted to HTML in the scripts.
2. The scripts should change all of the relative links to absolute links that point to the original files in the qmk_firmware repo.

Option 1 would seem to be better. If we go that route, keycode.txt should probably be upgraded to a markdown file to make a pretty HTML page.

Generate translated versions of qmk.fm/keyboards/

Because the file that is used to build https://qmk.fm/keyboards/ is auto-generated, this page exists only in the English version of qmk.fm.

We should investigate whether it is viable to auto-generate a version of this page for each translation.

• Template File: https://github.com/qmk/qmk.fm/blob/gh-pages/_util/keyboards_template.md
• Generation Scripts
  I'm not actually sure which one builds the final file.
  • https://github.com/qmk/qmk.fm/blob/gh-pages/_util/generate_keyboard_page.py
  • https://github.com/qmk/qmk.fm/blob/gh-pages/_util/generate_keyboard_page.sh
• Generated File: https://github.com/qmk/qmk.fm/blob/gh-pages/_i18n/en/keyboards.md

Translate to pt-BR (Brazilian Portuguese)

Create Brazilian Portuguese translation (pt-BR).