Skip to content
forked from flozz/rivalcfg

Configure the SteelSeries Rival gaming mice

License

Notifications You must be signed in to change notification settings

spkrka/rivalcfg

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rivalcfg: Configure SteelSeries Rival gaming mice

PYPI Version License

rivalcfg is a small CLI utility program that allows you to configure SteelSeries Rival gaming mice on Linux.

Supported mice:

  • SteelSeries Rival
  • SteelSeries Rival 100
  • SteelSeries Rival 300

If you have trouble running this software, please open an issue on Github:

Requirement

  • Any Linux distribution that use udev (Debian, Ubuntu, ArchLinux, Fedora,...)
  • pyudev

Installation

From PYPI

Run the following command (as root):

pip install rivalcfg

From sources

Clone the repositiory:

git clone https://github.com/flozz/rivalcfg.git
cd rivalcfg

Install rivalcfg (as root):

pip install .

NOTE: udev rules should be automatically installed, but if setup fails, you should copy the rules manually: cp rivalcfg/data/99-steelseries-rival.rules /etc/udev/rules.d/ and then run the udevadm trigger command.

CLI

Usage: rivalcfg [options]

Main Options:

--version           show program's version number and exit
-h, --help          show this help message and exit
-l, --list          print compatible mice and exit

SteelSeries Rival and Rival 300 Options:

-c LOGO_COLOR, --logo-color=LOGO_COLOR
                    Set the logo backlight color (e.g. red, #ff0000,
                    ff0000, #f00, f00, default: #FF1800)
-e LOGO_LIGHT_EFFECT, --logo-light-effect=LOGO_LIGHT_EFFECT
                    Set the logo light effect (values: 1, 2, 3, 4, breath,
                    steady, default: steady)
-p POLLING_RATE, --polling-rate=POLLING_RATE
                    Set polling rate in Hz (values: 125, 250, 500, 1000,
                    default: 1000)
-s SENSITIVITY1, --sensitivity1=SENSITIVITY1
                    Set sensitivity preset 1 (from 50 to 6500 in
                    increments of 50, default: 800)
-S SENSITIVITY2, --sensitivity2=SENSITIVITY2
                    Set sensitivity preset 2 (from 50 to 6500 in
                    increments of 50, default: 1600)
-C WHEEL_COLOR, --wheel-color=WHEEL_COLOR
                    Set the wheel backlight color (e.g. red, #ff0000,
                    ff0000, #f00, f00, default: #FF1800)
-E WHEEL_LIGHT_EFFECT, --wheel-light-effect=WHEEL_LIGHT_EFFECT
                    Set the wheel light effect (values: 1, 2, 3, 4,
                    breath, steady, default: steady)
-r, --reset         Reset all options to their factory values

SteelSeries Rival 100 Options:

-b BTN6_ACTION, --btn6-action=BTN6_ACTION
                    Set the action of the button under the wheel (values:
                    default, os, default: default)
-c COLOR, --color=COLOR
                    Set the mouse backlight color (e.g. red, #ff0000,
                    ff0000, #f00, f00, default: #00FFFF)
-e LIGHT_EFFECT, --light-effect=LIGHT_EFFECT
                    Set the light effect (values: 1, 2, 3, 4, breath,
                    steady, default: steady)
-p POLLING_RATE, --polling-rate=POLLING_RATE
                    Set polling rate in Hz (values: 125, 250, 500, 1000,
                    default: 1000)
-s SENSITIVITY1, --sensitivity1=SENSITIVITY1
                    Set sensitivity preset 1 (values: 250, 500, 1000,
                    1250, 1500, 1750, 2000, 4000, default: 1000)
-S SENSITIVITY2, --sensitivity2=SENSITIVITY2
                    Set sensitivity preset 2 (values: 250, 500, 1000,
                    1250, 1500, 1750, 2000, 4000, default: 2000)
-r, --reset         Reset all options to their factory values

Debug

  • DEBUG_DRY=true: Dry run (simulate commands, do not write anything to the device).
  • DEBUG_MOUSE=<VendorID>:<ProductId>: Force to load the corresponding profile.

Example:

DEBUG_DRY=true DEBUG_MOUSE=1038:1384 rivalcfg -c ff3300

Result:

[DEBUG] Debugging rivalcfg 2.0.0...
[DEBUG] Dry run enabled
[DEBUG] Debugging mouse profile 1038:1384
[DEBUG] Mouse profile found: SteelSeries Rival
[DEBUG] _device_write: 08 01 FF 33 00
[DEBUG] _device_write: 09 00

Changelog

  • 2.4.0: Python 3 support (#4)
  • 2.3.0:
    • Rival and Rival 300 support is no more experimental
    • Improves the device listing (--list)
    • Fixes bug with color parsing in CLI (#1)
    • Fixes unrecognized devices path on old kernel (#2)
  • 2.2.0: Experimental Rival 300 support
  • 2.1.1: Includes udev rules in the package and automatically install the rules (if possible)
  • 2.1.0: Experimental Original Rival support
  • 2.0.0: Refactored to support multiple mice
  • 1.0.1: Fixes the pypi package
  • 1.0.0: Initial release

About

Configure the SteelSeries Rival gaming mice

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%