Step-By-Step Guide To Configuring Your GMMK PRO Using QMK

Glorious HQ

July 28, 2021

QMK, or Quantum Mechanical Keyboard, is an open-source, community-centered configuration tool for keyboards and other input devices. The GMMK PRO supports QMK for remapping its keymap, allowing users to customize their board. QMK software is handy for creating layers, moving around specific keys, adding functions, etc.

QMK requires a simple setup process that can seem daunting at first, but we've designed this handy guide to make it quick and easy - getting you up and running with little hassle. Follow each step closely as we help you create your keymap, load it into QMK's toolbox configurator tool, and finally flash, or load, it onto your GMMK PRO.

The GMMK PRO also utilizes the Glorious Core software, so we will teach you how to revert your keyboard back to being able to utilize this proprietary tool.

A reminder that QMK Firmware on GMMK Pro will not be compatible with Glorious Core.

Once loaded, you will need to flash it back before you can take advantage of Glorious Core’s features.

Creating your keymap

1. Get your firmware by navigating to https://config.qmk.fm/#/ in your browser of choice.

2. Go up to the “KEYBOARD” dropdown box and select “gmmk/pro”

3. Use the tabs at the bottom to configure your keyboard layout.
a. ANSI contains your standard key functions for ANSI board layouts.
b. ISO contains your standard key functions for ISO board layouts.
c. Quantum contains the functions needed to access your board’s layers. In this tab, you will find the invaluable “MO” function that allows you to quickly swap between layers. For more information about working with layers in QMK, check out this handy video.
d. Keyboard Settings contains backlighting and RGB controls. Disclaimer: Currently, RGB lighting does not work on the GMMK PRO when utilizing QMK. We are working to address this issue as soon as possible.
e. App, Media, and Mouse holds assignable mouse, multimedia and application controls.

4. Define your keymap by dragging and dropping keymaps into their desired locations.

a. You can also click on an empty slot, then click on the keymap you want to be placed there.

5. To save this keymap you created for future changes, click the “Export Keymap” button. This will save the keymap as a .json file that can be imported later using the “Import Keymap” button.

6. Once you are satisfied with your keymap, compile your firmware using the “Compile” button. Once compilation is complete, the green button to “Download Firmware” will be available to click.

Loading your Keymap into qmk tool

1. Now that you have firmware ready to use, now you will want to flash that firmware onto your GMMK Pro. To do that first download the QMK Toolbox here: https://github.com/qmk/qmk_toolbox/releases

2. For Windows users, download the file: qmk_toolbox.exe. Mac users download the file: QMK_Toolbox.pkg. Make sure to download the latest version.

3. Navigate to where you downloaded the QMK toolbox and open the file.

a. For some users, Windows will warn you when attempting to open this file. Check your antivirus and open using administrator access if necessary.

4. (Windows Only) When opening the QMK toolbox for the first time, you will be prompted to install drivers. If there is not a prompt to do so, right click at the bottom of the window and click “Install Drivers…”
a. This should only be done once unless there is an error downloading the drivers.
b.It is recommended you restart your computer after installing these drivers.

5. Launch the QMK toolbox again, and press the open button. Select the QMK keymap file you created in the “Creating Your Keymap” section. Press the open button once selected.

Note: Choosing the wrong keymap file here will cause your GMMK PRO to stop functioning, so be sure it is the correct file. Correcting this is as simple as opening up the correct firmware file.

6. Leave the “MCU (AVR) Only” dropdown at its default value - no need to change it.

Flashing your Keymap

1. To put your GMMK PRO into bootloader mode, you must first unplug it. Before plugging it back in, hold the SPACEBAR and B at the same time while plugging the cable back in.

a. You should see a message in the QMK Toolbox that indicates that your board is in STM DFU Bootloader Mode.

2. Click the “Flash” button to flash the keymap onto your board.

3. You can now close QMK Toolbox. Your new keymap is now successfully flashed to your GMMK PRO.

a. More detailed instructions and alternate ways of flashing are located here on this page in the QMK official docs: https://docs.qmk.fm/#/newbs_flashing

(Alternative method) Hard Bootloader mode

1. Unscrew all the base plate screws on the backside of your GMMK PRO. Keep your screws in a safe place or on a piece of tape so you do not lose them.

2. Lightly tug on the base plate and lift the base plate 1-2 inches from the PCB board. Do this lightly and slowly as there is a 2-3 inch cable that is attached to the base plate and the PCB board.

3. You should see a button on the PCB board that is visible through the foam padding.

4. Simply hold this button down and plug the GMMK PRO back into the PC.

5. You are now in STM DFU bootloader mode.

6. Refer to Step 2 of Flashing Your Keyboard to continue with the flashing process.

FLASHING GLORIOUS CORE BACK ONTO YOUR GMMK PRO

1. Download the Glorious Core .bin file located here.

2. Launch the QMK Toolbox and press the open button once again under the Local File text box.

3. Leave the “MCU (AVR) Only” dropdown at its default value - no need to change it.

4. To put your GMMK PRO into bootloader mode, you must first unplug it. Before plugging it back in, hold "FN" + "/" for ANSI models and "FN" + "Backspace" for ISO at the same time while plugging the cable back in.

Note: These are the default key combinations for activating bootloader mode, and if they do not work, please reference your QMK keymap.

5. You should see a message in the QMK Toolbox that indicates that your board is in STM DFU Bootloader Mode.

6. Click the “Flash” button to flash the keymap onto your board.

7. You should now be able to close the QMK Toolbox if the file was successfully flashed onto the board. Your GMMK PRO should have full Glorious Core functionality once again.  

FAQ

Q: Can I use Glorious Core after flashing my new keymap using the QMK toolbox?
A: No, you will need to flash the Glorious Firmware .bin file back onto the GMMK PRO to regain Core functionality.


Q: I chose the wrong keymap file, and now my GMMK PRO is not working properly. How do I fix this?
A: No need to worry, simply open up the file explorer in the QMK toolbox and reselect the proper keymap file.


Q: Do I need to choose an “MCU (AVR) Only” from the dropdown menu in the QMK toolbox?
A: No, the GMMK PRO does not require you to do so.


Q: How do I put my GMMK PRO in bootloader mode?
A: Unplug your GMMK PRO, hold the SPACEBAR and B simultaneously, and finally plug it back in. The GMMK PRO also has a physical button to initiate bootloader mode, and this required disassembly of the board. Please refer to “(Alternative Method) Hard Bootloader Mode” for more information on that.

Comments

DCamron Dunlap :

Can I use this same method on the gmmk 1 compact?

December 03, 2021

Bobheim:

Anyone talk me through making a “send_string” macro and where I would put it in the keymap file?

December 01, 2021

Harry:

Thank you Alexey and Johan!

Got my rotary knob to work on windows:
For my ISO board I had to edit following file: \keyboards\gmmk\pro\iso\iso.c
Than I compiled it with: qmk compile -c <Path to json-File from https://config.qmk.fm>
Than I flashed it with qmk_toolbox.exe (.bin location: .build\xxxx.bin)

Just insert at the end of iso.c:
bool encoder_update_user(uint8_t index, bool clockwise) {
if (clockwise) {
tap_code(KC_VOLU);
} else {
tap_code(KC_VOLD);
}
return true;
}

November 19, 2021

Snowman:

RGB is now working with qmk flashing!!! Thank you for fixing it!

October 13, 2021

Sunny:

Thanks, Alexey! I confirmed that building the firmware following https://beta.docs.qmk.fm/tutorial/newbs_building_firmware, the volume control by the rotary knob is working.

September 16, 2021

Christopher Semyonov:

does this work with gmmk compact, theres so little info about this keyboard on internet

September 13, 2021

Yanni:

Thank you Alexey. I’ve used QMK MSYS to configure my GMMK Pro while keeping the rotary encoder KC_VOLU/KC_VOLD working.

September 07, 2021

Chenjieshan:

Please add RGB support to the via firmware.

August 31, 2021

Jacob:

I got back into bootloader mode the second time (first time held SPACE + “B”) by holding does ESC while unplugged and replugging in. This worked to go from QMK back to the Glorious Core firmware.

August 27, 2021

Hawkhandler:

so, it’s not clear to me. is the RGB toggle fixed yet? if so what key in QMK do i want to map it to becuase it appears tha RGB toggle isn’t working

August 18, 2021

kolby:

it wont let me flash in the glorious firmware again im stuck in qmk

August 09, 2021

Alex:

Looks like qmk rgb is working for anyone waiting https://www.reddit.com/r/MechanicalKeyboards/comments/oh8nq4/working_gmmk_pro_rgb/

July 12, 2021

Johan:

Getting volume support for the rotary knob on MacOS:

1. Install the QMK CLI environment (see https://docs.qmk.fm/#/newbs_getting_started)
2. Add the following to the end of the file `qmk_firmware/keyboards/gmmk/pro/pro.c`

bool encoder_update_user(uint8_t index, bool clockwise) {
if (clockwise) {
tap_code(KC_VOLU);
} else {
tap_code(KC_VOLD);
}
return true;
}

3. Create a layout using the QMK Configurator and save the JSON file somewhere. Make sure to map “Quantum/Reset” – it’ll make your your life easier.
4. Compile your layout with `qmk compile -c ./gmmk_pro_layout_mine.json`
5. Flash the resulting `gmmk_pro_gmmk_pro_layout_mine.bin` to your keyboard

July 12, 2021

Randy:

After flashing QMK and back to stock firmware ((QMK)GMMK _PRO_US_2021_04_07_V0035_DFU_FW.bin), I also lost RGB functionality.

July 12, 2021

James K:

is there a fix to the rgb problem that this installation creates? I am really wanting to have my rgbs work on my keyboard again.

July 06, 2021

AG:

For folks looking for updates regarding Glorious Core, QMK, or VIA updates, you can review the Development Roadmap here: https://www.pcgamingrace.com/pages/development-roadmap

RGB support is in progress and you can follow the PR on github here: https://github.com/qmk/qmk_firmware/pull/13173

July 06, 2021

Alexey:

I was able to update and flash the firmware with QMK MSYS on Windows using their command line package and retain the rotary encoder volume functionality. Here is a link for anyone who is interested: https://msys.qmk.fm/

The instructions can be found here: https://beta.docs.qmk.fm/tutorial/newbs_getting_started

You can also flash the firmware directly through CLI, no need to use the QMK Toolbox.

The main reason this works is that the CLI version retains a few lines of code in the keymap file to keep the volume functionality (you could also remap it to a mouse scroll wheel for example). The code is this snippet:

bool encoder_update_user(uint8_t index, bool clockwise) {
if (clockwise) {
tap_code(KC_VOLU);
} else {
tap_code(KC_VOLD);
}
return true;
}

July 01, 2021

DJ:

Backstory: I always use the lower left modifier key as my Fn key (mac style), and the Caps Lock key as my left Ctrl. When I discovered the Glorious Core software wouldn’t let me assign Fn to any key besides the default Fn key, I was left with no choice but to use QMK.

My keys are now all working great, but the tradeoff is that I have no RGB (and no volume control with the rotary knob, but I prefer using hotkeys for volume control anyway.)

Glorious, if you’re listening, if you could just add the ability to remap other keys to Fn in the Glorious Core software, I would be a happy customer! Or add RGB control to QMK (polling rate control and rotary knob control would also be nice, I guess). Either would suffice.

June 28, 2021

vincent:

please add rgb lights to qmk :(

June 24, 2021

Mark:

Still waiting for proper QMK support. It’s been months and features that were promised at release are still missing. The lack of RGB and encoder customization in QMK is extremely disappointing. And the lack of any replies from your side doesn’t help the situation.

June 24, 2021

Jake:

Sooooo the encoder knob is a huge letdown. I just want to scroll left and right but apparently, that is too much to ask for?

June 23, 2021

Sasha:

For those wondering how to get the keyboard into bootloader mode again (without disassembly) in QMK Toolbox after the first flash (after which unplug, “space + b”, plug in, stops working), it looks like the default keyboard map you flash from QMK already has “Reset” mapped to "Fn + \ ". As long as you didn’t change this you can use this from the QMK Toolbox terminal to get the board into bootloader mode and ready to flash again (you can see what your keymap is by uploading your .json file to QMK Configurator, and click through the layers, mine was on the Fn layer (1)). I made a mistake in my first keymap and didn’t want to take the whole dang thing apart again to hit a reset button on the PCB, so hope this helps someone else out. Also thanks Glorious for this guide, it was very helpful for someone like myself who is new to QMK. You might want to add what I’m saying to the document though because it’s natural to assume first time QMK users are going to make a mistake on their first flash!

June 21, 2021

Dani:

I got this because I wanted a rotary encoder back. Sucks to know it’s a just glorified knob. Glorious’ community management is pretty sad though. At least acknowledge the issue and give some impetus to it. Otherwise, I hesitate to ever trust their intentions to become a truly community-focused company.

Just another wannabe, glorious?

June 21, 2021

Cosmin:

Glorious, how about you fix the QMK compatibility as you promised in the advertisement? Give us the RGB, give us the backlight, give us the rotary encoder properly working in the default firmware off the QMK Configurator website, give us the VIA compatiblity.

I’m unsure who will buy your board in the future, because as an enthusiast I sure as hell not touching Glorious products ever again, I’d rather pay twice for a true custom keyboard whose designers and manufacturers respect their customers.

June 15, 2021

Mark:

The GMMK pro has terrible input lag with the stock glorious firmware making it unuseable for competitive gaming, it is also impossible to set to 1000hz, I have tried many times with the Glorious Core software, reinstalling restarting etc. I flashed QMK and I thiinkj it sorted the input lag problem, but there is no RGB support with QMK.. Is it the software or the leds used on the pcb causing the input lag? Surely there should have been more testing done on this.. And is basic RGB support with QMK ever going to be released?? It has been three months since the original release..

June 15, 2021

anonymous:

Why does this have a problem with RGB in QMK that is not able to fixed by the community?

June 14, 2021

Sylar:

I still cannot use the RGB function, whats the update with that?

June 11, 2021

Greg:

When will we be able to remap the function of the rotation of the rotary encoder? This is something that was advertised as a feature for the board and still isn’t available (without jumping through undocumented/unsupported hoops) yet, to my knowledge.

June 09, 2021

gabe:

I am having the same issue as chemnitzel where I cant use the rotary knob while using QMK configurator and the rgb stopped working after the first time I flashed it

June 03, 2021

Ken:

Why doesn’t QMK work with RGB? Will glorious even comment on this message?

June 01, 2021

Leave a comment!