KeyRush KeyRush
IT EN

Documentation

Welcome! This guide will walk you through the first steps with your KeyRush keypad, from initial setup to integration with your favorite software.

Getting started is simple

Your KeyRush keypad is designed to be immediately operational: the firmware is already preinstalled and configured with a functional base keymap. No additional drivers are required for most operating systems (Windows, macOS, Linux), as the device is recognized as a standard HID keyboard.

To get started, simply connect the keypad to a USB port on your computer. Once connected, the integrated LED will light up to confirm proper power delivery. The operating system will automatically detect the device within a few seconds and it will be ready to use.

If you want to verify that the keypad has been recognized correctly, you can check the list of connected USB devices from your operating system's control panel. On Windows, go to "Device Manager"; on macOS, open "System Information" > "USB"; on Linux, use the lsusb command in the terminal.

To take full advantage of your keypad and customize keymaps, layers, macros and advanced settings, we recommend using one of the supported configuration tools: QMK for firmware-level code changes, or Vial for live, intuitive configuration through a graphical interface.

In the following sections you will find all the information needed to set up your development environment and start customizing the keypad to your workflow.

Firmware and configuration support

QMK Support

QMK (Quantum Mechanical Keyboard) is an extremely powerful and flexible open-source firmware, used by thousands of custom keyboards worldwide. With QMK you can modify your keypad's behavior at the source code level, implementing advanced features like tap dance, combos, complex layers, and much more.

The KeyRush keypad is fully compatible with QMK: you can compile your custom firmware, modify keymaps, add custom functions, and flash the device with your configurations.

Official resources

Nota: To compile and flash QMK firmware you need to set up the development environment following the official guide.

Vial Support

Vial is an open-source desktop application that allows you to configure keyboards and keypads in real time, without needing to recompile or flash the firmware. With Vial you can modify keymaps, create multiple layers, program complex macros, and customize every aspect of your device through an intuitive graphical interface.

Changes are applied instantly and saved to the keypad's memory, allowing you to experiment with different configurations quickly and safely.

⚠️ Custom Version Required

To use all advanced features of the KeyRush keypad, you need to install the custom version (fork) of Vial developed specifically for this device. The official version of Vial does not include some specific features, such as the additional control panel for managing advanced keypad settings.

Official and custom resources

Compatibilità: The custom fork maintains full compatibility with the basic functions of the official Vial version and is constantly updated to include the latest features and bugfixes.

Ready to get started?

Now that you have set up your keypad, explore ready-to-use templates and discover how to optimize your workflow with personalized shortcuts.

Explore templates Back to documentation