repository·master·Indexed 21 days ago
https://github.com/flozz/rivalcfgA Python-based tool and CLI utility for configuring SteelSeries gaming mice, including Rival, Sensei, Aerox, and Prime series, on Linux, macOS, and Windows. It provides functionality for mapping mouse buttons to keyboard keys or multimedia actions, configuring DPI sensitivity presets, and managing RGB lighting, including hexadecimal colors, named colors, and RGB gradients.
Rivalcfg is a Python library and a CLI utility program designed to configure SteelSeries gaming mice. It supports a wide range of devices including the Rival, Sensei, Aerox, and Prime series.
Supported Platforms:
Disclaimer: This is unofficial software created via reverse engineering. It is not supported or approved by SteelSeries.
rivalcfg project supports a wide range of SteelSeries gaming mice. Before attempting to configure a device, ensure it is listed in the supported devices documentation. Supported models include various versions of the Aerox, Kanav, Kinzu, Prime, Rival, Sensei, and more (both wired and wireless variants).The SteelSeries Rival 3 Wireless Gen 2 is supported under the rival3_wireless_gen2 device family.
Currently unsupported features:
The Aerox 5 supports color customization and an onboard rainbow light effect.
Important: On newer SteelSeries mice, color settings are not saved to the onboard memory; you must configure the 'Default Lighting' settings to ensure colors persist.
Note: Enabling the onboard rainbow light effect will reset any custom color settings.
In rivalcfg, handlers are used to manage different types of settings within a device profile. Each handler is associated with a specific value_type. A handler module is responsible for two primary tasks:
process_value function.add_cli_option function.Common handler types include none, choice, range, rgbcolor, and various specialized RGB or DPI handlers.
The Aerox 5 Wireless supports color customization and an onboard rainbow light effect.
Key Considerations:
Default Lighting settings to ensure colors persist.The Aerox 9 Wireless supports color settings and a rainbow light effect.
Important Notes:
Default Lighting settings to ensure behavior persists.The SteelSeries Prime Mini supports color configuration.
Important Note: On newer SteelSeries mice, color settings are no longer saved in the onboard memory. You should refer to the 'Default Lighting' settings to manage how colors behave.
The Prime Wireless supports color configuration.
Important: On newer SteelSeries mice, color settings are no longer saved in the onboard memory. You should check the Default Lighting settings to ensure colors persist as expected.
rgbgradientv2 handler is a specialized variation of the standard rgbgradient handler. It is designed to support specific SteelSeries devices that require this implementation, such as the Rival 700 and Rival 710. Use this handler when configuring RGB gradients on these specific models.The Aerox 3 supports color customization and a built-in rainbow light effect.
Important: On newer SteelSeries mice, color settings are no longer saved to the onboard memory; you must configure the 'Default Lighting' to ensure settings persist or behave as expected.
Rainbow Effect: The Aerox 3 has an onboard rainbow effect, but enabling or changing colors will reset this effect.