QMK + SRGB Support - reddit post found here
We're happy to help, please either create an (Issue), or reach out on our Discord.
Need help and cannot be bothered to read anything below this? Join this Discord then puruse the channels provided for QMK. No support for any of these files will be provided by official email tech support. Only Discord & Github issues.
QMK Firmware that is supported by SignalRGB (includes protocol information for direct ARGB mode), compiled for your convenience and ready to install!
If you wish to compile your own yourself the directions can be found here.
These binaries may include releases from different "playground(s)" and QMK repositories. stability is not guaranteed, but Naitoshedo will definitely attempt to help you as well as our other moderators & occasionaly staff.
QMK Mainline + SignalRGB Protocol, SonixQMK + SignalRGB Protocol & Keychron + SignalRGB Protocol & Others.
Additionally see the following directory, these are the files (with comments) for hand patching SignalRGB Protocol support into 3rd party QMK forks.
Thanks to the VIA Userspace , SonixQMK , QMK , VIA , GloriousThrall , jonylee1986 , Keychron , Vial and many more communities for providing source code, all original code is completely theirs and thanks to them for providing the code for us and everyone else!
Source forks for all QMK modified source can be found here.
Licenses include: SonixQMK , QMK , VIA , GloriousThrall , jonylee1986 , Keychron , and Vial.
This firmware is not "officially" supported by SignalRGB, QMK or any other software development team but by the moderator team of SignalRGB. Support can be provided either on the Github repository (Issues) here or the QMK channels of this Discord (Discord will be faster in most cases), after joining this specific Discord go #QMK channels, This will allow you to interact with the QMK group / support mods of the server.
Please keep support requests to either of those locations only, thanks!
If you notice something missing (keyboard or variation of a keyboard) or have any issues with these binaries please contact Naitoshedo on the above Discord server, or with (Issues) of course.
QMK + VIA builds (unless you have issues with GMMK look to the next section about this!) these are the most recommended builds and may help narrow things down (don't skip directly but keep reading please), but there are several QMK builds listed, always start with the most recent version VIA builds listed and then work your way down the links from here.
If you cannot find your keyboard above in VIA it might be found in the Default builds and failing that check the SonixQMK builds.
VIA JSON Definitions these files are for loading into VIA if the definition file is reported missing (newer keyboards than what are included in VIA).
Issues? Please contact Naitoshedo on the Discord server in the #QMK channel(s) or with (Issues) of course.
Start Here when in doubt mainline is the most reliable! (Not to mention the customization provided by VIA is helpful.)
Please explore here as there are many builds that you may find helpful!
One thing of note if you are attempting to use VIA or Vial to configure your keyboard you may need to quit SignalRGB before running either software this is a limitation of the raw_hid_send that both VIA & SignalRGB use to talk to your keyboard!
-
0.32.13 is the new QMK Mainline github development branch, currently being pulled and fixes to boards are applied and uploaded. (SRGBP¹ 1.0.6)
-
GMMK Users due to recent changes after QMK Mainline 0.29.2, some GMMK users may have issues with the latest builds and if so use these builds instead.
-
Archived feel free to check the archived builds as they may be outdated but could include support for your keyboard.
¹SRGBP refers to SignalRGB Protocol Version
- 0.20.7 These are specifically hfdkb based boards (monsgeek, top40, acr87, akko) if you cannot find these in mainline first then use these. (SRGBP* 1.0.4)
- 0.14.29 is Keychron's wireless_playground, playground and bluetooth_playground. When connected to USB (wired mode) ARGB is controllable. (Bluetooth & Wireless is not supported by SignalRGB currently).
If you cannot find your keep above it might be found in the Default builds and failing that check the SonixQMK builds.
- sn32_develop is for Sonix based keyboards only and is currently under construction from SonixQMK's sn32_develop branch.
- 0.15.12-sonix is for Sonix based keyboards only and comes from an older SonixQMK repo.
- 0.7.101-sonix is for Sonix based keyboards only and comes from an older SonixQMK repo.
- 0.7.101-sonix-develop is for Sonix based keyboards only and comes from an older SonixQMK repo.
One thing of note if you are attempting to use VIA or Vial to configure your keyboard you must quit SignalRGB before running either software this is a limitation of the raw_hid_send that both VIA & SignalRGB use to talk to your keyboard!
- 10_12_25 is the latest dev Vial QMK Branch, currently being pulled and fixes to boards are applied and uploaded.
Please note: Default builds are now deprecated, as VIA, VIAL, or XAP builds will replace all except for speciality builds.
- 0.32.11 is from QMK Mainline github, last default version to be compiled (This is default without VIA support). (SRGBP¹ 1.0.6)
- Archived feel free to check the archived builds as they may be outdated but could include support for your keyboard.
- GMMK Users due to recent changes after QMK Mainline 0.29.2, the most recent builds for the majority of usesrs can be found here, please check the link below as some GMMK builds continue to work, if not available there use these builds!
- sn32_develop is for Sonix based keyboards only and is currently under construction from SonixQMK's sn32_develop branch. (This is default without VIA support). (SRGBP¹ 1.0.6)
- 0.15.12-sonix is for Sonix based keyboards only and comes from an older SonixQMK repo.
¹SRGBP refers to SignalRGB Protocol Version
If you are using VIA or Vial currently, you should save your current mappings (layout) e.g. back it up before flashing that way you can restore it once the flash is complete!
To use these files you may find QMK Toolbox helpful. Make sure to go to the Tools menu -> and Install Drivers!
If a Sonix based firmware these directions should help.
Or if a Massdrop keyboard these directions should help.
You will also need to follow the directions from your Keyboard manufacturer to put your device in bootloader mode in order to use QMK Toolbox / Sonix Flasher. (Google is your friend!) (Check their website for directions, you should honestly check there anyways for firmware in case you to need to factory restore as well.)
After flashing your firmware you will need a user plugin in SignalRGB in order for SignalRGB to talk to your keyboard. First see if your keyboard works immediately on launching SignalRGB, if that fails check our user submitted plugins
And finally here are the directions for creating your own user plugin.
- VIA Archived VIA builds (Old QMK Mainline VIA+SignalRGB Support).
- Vial Archived Vial builds (Old QMK Mainline VIA+Vial+SignalRGB Support).
- Default Archived Default builds (Old QMK Mainline Default+SignalRGB Support)
We now provide a userspace community module for folks that wish to compile their own firmware without having to move files around and edit pre-existing quantum/ files.
Keep in mind this is a Work In Progress (WIP) and will get updated as we continute to update it (make sure to git pull frequently)!
To manually add the SignalRGB Protocol 1.0.6 to almost any qmk fork please see the following files. To manually add the SignalRGB Protocol 1.0.5 to almost any qmk fork please see the following files.
The above code changes have been applied to vanilla / playground repos for each fork(s) for the binaries provided.
If and when possible specific forks for supporting specific keyboards will be merged to QMK mainline release (cp -rp specificfork/keyboards/<keyboard_brand/maybe_a_child> ~/qmk/mainline/keyboards) and compiled against it.
(The above may include backporting RGB_Matrix to that specific board and the source is available in the QMK mainline and can be provided upon request keeping track of all these gets a bit tricky but I will definitely try.)
We're happy to help, please either create an (Issue), reach out on our Discord or email us directly.