8000 GitHub - irfanjmdn/r65 at vialrgb
[go: up one dir, main page]
Skip to content

irfanjmdn/r65

BranchesTags
 
 

Repository files navigation

🧪 Royal Kludge R65 with Vial / VialRGB

Royal Kludge R65 Keyboard

Select your branch:

Branch Features Description Link
🔨 Master QMK, VIA The main branch (with optional Snap Tap feature12). Go to branch
💡 SignalRGB QMK, VIA + SignalRGB Stable branch with VIA and SignalRGB support. Go to branch
🧪 VialRGB QMK, VIA, Vial /+ SignalRGB Experimental branch with Vial and Vial+SignalRGB. You are here

Important

This branch only contains files for the wired ANSI-layout version of the Royal Kludge R65. DO NOT flash this firmware if your keyboard has wireless capabilities. DO NOT flash this firmware if you're unsure of your keyboard's variant/don't know much about keyboard modification. Please review the full disclaimer before using the files provided in this repository.

  • ⌨ 🔌 For the wired ISO variant of the keyboard, especially for South American users, visit NieblaDev's ISO Firmware Repo.
  • ⌨ 🛠 For a more customized version of the firmware for the R65, visit iamdanielv's R65 Custom Firmware Repo.
  • ⌨ 🔌 For all other Royal Kludge keyboard variants, visit sdk66’s QMK Firmware Repo.

To developers who would want to contribute, any and all help would be greatly appreciated! Feel free to submit improvements, fixes, or suggestions.

❓ VIA, Vial, and VialRGB: What's the Difference?

  • VIA: An easy-to-use, popular, but closed-source GUI for keyboard layout customization. VIA only supports basic remapping, RGB, and default layers.
  • Vial: An open-source fork of VIA with more features.3 Vial includes features like Tap Dance, combos, and key overrides. 👨‍🏫 Guide for noobs
  • VialRGB: Includes all the features mentioned above, but has SignalRGB support. ⚠ Known Issues

Warning

Known Issues

Using SignalRGB & Vial simultaneously

SignalRGB and Vial cannot run simultaneously. To avoid conflicts:

  • Close Vial or its browser tab before running SignalRGB.
  • Alternatively, close SignalRGB before using Vial. The issue arises because both use the raw_hid_receive solution, causing interference.

Firmware Options

Tip

Make sure to read the guide before proceeding.

Option Command Vial SignalRGB SOCD1 Download prebuilt firmware
Vial Only make rk/r65:vial ✅ ⬜ ⬜ ⏬Download
Vial with SOCD make rk/r65:vial-socd ✅ ⬜ ✅ ⏬Download
VialRGB ⚠ Known Issues make rk/r65:vialrgb ✅ ✅ ⬜ ⏬Download
VialRGB with SOCD ⚠ Known Issues make rk/r65:vialrgb-socd ✅ ✅ ✅ ⏬Download

Guide

> 🏗 Building the Firmware

For more information, visit SignalRGB/building-firmware-from-source.

🧪 For Vial Only Firmware

  1. Install QMK MSYS
    Download and install QMK MSYS.

  2. Set Up QMK MSYS for Vial
    Open QMK MSYS and run these commands:

    mkdir Vial
cd Vial
git clone https://github.com/vial-kb/vial-qmk
cd vial-qmk

    A folder will be installed at C:/Users/%USERNAME%/Vial/vial-qmk.

  3. Add Keyboard Files
    Download this repository and move the rk/r65 folder into your vial-qmk/keyboards/ folder.

  4. Compile the Firmware
    Run the following command in QMK MSYS:

    make rk/r65:vial

    (Available options: default/vial/vial-socd).

  5. Locate the Firmware File
    Find the compiled .bin or .hex file in the root of the vial-qmk folder.

🧪💡 For VialRGB (Vial + SignalRGB) Firmware

  1. Install QMK MSYS
    Download and install QMK MSYS.

  2. Set Up QMK MSYS
    Open QMK MSYS and run these commands:

    mkdir VialRGB
cd VialRGB
git clone https://github.com/SRGBmods/VialQMK
cd VialQMK

    A folder will be installed at C:/Users/%USERNAME%/Vial/VialQMK.

  3. Add Keyboard Files
    Download this repository and move the rk/r65 folder into your VialQMK/keyboards/ folder.

  4. Compile the Firmware
    Run the following command in QMK MSYS:

    make rk/r65:vialrgb

    (Available options: vialrgb/vialrgb-socd).

  5. Locate the Firmware File
    Find the compiled .bin or .hex file in the root of the VialQMK folder.

> ⚡ Flashing/Installing the Firmware

  1. Install QMK Toolbox
    Download and install QMK Toolbox.

  2. Load the Firmware File
    Open QMK Toolbox and load the .bin or .hex file.

  3. Enter Bootloader Mode
    Reset the keyboard into bootloader mode.

  4. Flash the Firmware
    Click 'Flash', then 'Exit DFU' once the flashing process is complete.

> 🧪 Using Vial

  1. Close any instance of VIA/SignalRGB.

  2. Open Vial Go to https://vial.rocks and connect your keyboard.

  3. Use Vial Use Vial and enjoy.

> ⚒ Setting up SignalRGB

  1. Close any instance of Vial.

  2. Install SignalRGB
    Download and install the SignalRGB software.

  3. Move Plugin File
    After installing, copy SignalRGB-for-RK-R65.js to %userprofile%/Documents/WhirlwindFX/plugins.

  4. Restart SignalRGB
    Restart SignalRGB and enjoy.

> 🔓 Entering Bootloader Mode

  • Option 1: Hold the Reset switch on the PCB while connecting the USB cable.
  • Option 2: Hold the Escape key while connecting the USB cable (this will also erase settings).
  • Option 3: Press Fn+Shift+Esc.

Footnotes

  1. Snap Tap/SOCD is a feature that prioritizes the latest input between two selected keys without the need to release the previous one, allowing for faster directional changes. This can enhance gameplay in FPS games by enabling quicker counter-strafing and more responsive movements. ↩ ↩2

  2. The Snap Tap/SOCD feature is available in every branch of the repository. ↩

  3. You should use Vial if you have experience with QMK/VIA. If you are new to modifying keyboards, I recommend you use VIA instead. ↩

About

Files for the RK65 / Royal Kludge R65 (ANSI, WIRED-ONLY)

Topics

via qmk-firmware vial socd vial-kb signalrgb royal-kludge snap-tap rk65

Resources

Readme
Activity

Stars

52 stars

Watchers

3 watching

Forks

8 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

Languages
0