Package: rivalcfg
Rivalcfg is aPython libraryand aCLI utility programthat allows you
to configure SteelSeries gaming mice on Linux and Windows (probably works on
BSD and Mac OS too, but not tested).I first created this program to configure my Rival 100 and the original Rival
mice, then I added support for other Rival devices thanks to contributors.
Today this project aims to support any SteelSeries gaming mice (Rival,
Sensei,…).IMPORTANT:This is an unofficial software. It was made by reverse
engineering devices and is not supported nor approved by SteelSeries.If you have any trouble running this software, please open an issue on Github:https://github.com/flozz/rivalcfg/issuesDocumentationMain topics:RequirementsInstalling RivalcfgDocumentation of supported devicesFAQContributing(please read before opening issues and PRs 😀️)… and more at:https://flozz.github.io/rivalcfg/Supported DevicesSteelSeries Aerox 3SteelSeries Aerox 31038:1836SteelSeries Aerox 3 WirelessSteelSeries Aerox 3 Wireless (wired mode)1038:183aSteelSeries Aerox 3 Wireless (2.4 GHz wireless mode)1038:1838SteelSeries Aerox 5 WirelessSteelSeries Aerox 5 Wireless (wired mode)1038:1854SteelSeries Aerox 5 Wireless Destiny 2 Edition (wired mode)1038:185eSteelSeries Aerox 5 Wireless Diablo IV Edition (wired mode)1038:1862SteelSeries Aerox 5 Wireless (2.4 GHz wireless mode)1038:1852SteelSeries Aerox 5 Wireless Destiny 2 Edition (2.4 GHz wireless mode)1038:185cSteelSeries Aerox 5 Wireless Diablo IV Edition (2.4 GHz wireless mode)1038:1860SteelSeries Aerox 9 WirelessSteelSeries Aerox 9 Wireless (wired mode)1038:185aSteelSeries Aerox 9 Wireless (2.4 GHz wireless mode)1038:1858SteelSeries Kana v2SteelSeries Kana v21038:137aSteelSeries Kinzu v2SteelSeries Kinzu v21038:1366SteelSeries Kinzu v21038:1378SteelSeries PrimeSteelSeries Prime1038:182eSteelSeries Prime Rainbow 6 Siege Black Ice Edition1038:182aSteelSeries Prime CS:GO Neo Noir Edition1038:1856SteelSeries Prime MiniSteelSeries Prime Mini1038:184dSteelSeries Prime WirelessSteelSeries Prime Wireless (wired mode)1038:1842SteelSeries Prime Mini Wireless (wired mode)1038:184aSteelSeries Prime Wireless (2.4 GHz wireless mode)1038:1840SteelSeries Prime Mini Wireless (2.4 GHz wireless mode)1038:1848SteelSeries Rival 100 / SteelSeries Rival 105SteelSeries Rival 1001038:1702SteelSeries Rival 100 (Dell China)1038:170aSteelSeries Rival 100 Dota 2 Edition (retail)1038:170bSteelSeries Rival 100 Dota 2 Edition (Lenovo)1038:170cSteelSeries Rival 1051038:1814SteelSeries Rival 110 / SteelSeries Rival 106SteelSeries Rival 1101038:1729SteelSeries Rival 1061038:1816SteelSeries Rival 3SteelSeries Rival 31038:1824SteelSeries Rival 3 (firmware v0.37.0.0)1038:184cSteelSeries Rival 300 / SteelSeries RivalSteelSeries Rival1038:1384SteelSeries Rival Dota 2 Edition1038:1392SteelSeries Rival 3001038:1710SteelSeries Rival 300 Fallout 4 Edition1038:1712SteelSeries Rival 300 Evil Geniuses Edition1038:171cSteelSeries Rival 300 CS:GO Fade Edition1038:1394SteelSeries Rival 300 CS:GO Hyper Beast Edition1038:171aSteelSeries Rival 300 CS:GO Fade Edition (stm32)1038:1716SteelSeries Rival 300 Acer Predator Edition1038:1714SteelSeries Rival 300 HP OMEN Edition1038:1718SteelSeries Rival 300SSteelSeries Rival 300S1038:1810SteelSeries Rival 310SteelSeries Rival 3101038:1720SteelSeries Rival 310 CS:GO Howl Edition1038:171eSteelSeries Rival 310 PUBG Edition1038:1736SteelSeries Rival 3 WirelessSteelSeries Rival 3 Wireless (2.4 GHz mode)1038:1830SteelSeries Rival 500SteelSeries Rival 5001038:170eSteelSeries Rival 600SteelSeries Rival 6001038:1724SteelSeries Rival 600 Dota 2 Edition1038:172eSteelSeries Rival 650 WirelessSteelSeries Rival 650 Wireless (wired mode)1038:172bSteelSeries Rival 650 Wireless (2.4 GHz wireless mode)1038:1726SteelSeries Rival 700 / SteelSeries Rival 710SteelSeries Rival 7001038:1700SteelSeries Rival 7101038:1730SteelSeries Rival 95 / SteelSeries Rival 100 PC BangSteelSeries Rival 951038:1706SteelSeries Rival 95 MSI Edition1038:1707SteelSeries Rival 95 PC Bang1038:1704SteelSeries Rival 100 PC Bang1038:1708SteelSeries Sensei 310SteelSeries Sensei 3101038:1722SteelSeries Sensei [RAW]SteelSeries Sensei [RAW]1038:1369SteelSeries Sensei [RAW] Diablo III Edition1038:1362SteelSeries Sensei [RAW] Guild Wars 2 Edition1038:136dSteelSeries Sensei [RAW] CoD Black Ops II Edition1038:136fSteelSeries Sensei [RAW] World of Tanks Edition1038:1380SteelSeries Sensei [RAW] Heroes of the Storm Edition1038:1390SteelSeries Sensei TENSteelSeries Sensei TEN1038:1832SteelSeries Sensei TEN CS:GO Neon Rider Edition1038:1834Supporting this projectWanna support this project?☕️ Buy me a coffee,❤️ sponsor me on Github,💵️ or give me a tip on PayPal.Changelog[NEXT](changes onmasterthat have not been released yet):Nothing yet ;)v4.11.0:feat: Added Prime Mini support (@flozz, @NextWork123, #227)chore: Added Python 3.12 supportchore!: Dropped Python 3.7 supportv4.10.0:Added Prime Mini Wireless support (@intersectRaven, #210, #207)Code quality: more robust type comparison (@flozz)v4.9.1:Improved device profile generation (@airblast-dev, #211)Fixed battery level reported at 630% when the mouse is off
(@LennardKittner, #187, #212)Unrecognized arguments error when no device is found (@LennardKittner,
#213, #214)v4.9.0:Added Aerox 5 Wireless Destiny 2 Editon support (@flozz, #205)Added Aerox 5 Wireless Diablo IV Edition support (@flozz, #206)Updated HIDAPI to v0.14 to fix a macOS Ventura issue (@flozz, #200)Removed the default lighting option for the Prime mouse (reported not
working and not needed on this device) (@flozz, #196)v4.8.0:Improved CLI startup time (@gryzus24, #194)Added default lighting setting to following devices (@flozz, #191, #195):Aerox 3Aerox 3 WirelessAerox 5 WirelessAerox 9 WirelessPrimePrime WirelessAdded Python 3.11 support (@flozz)4.7.0:Add initial Aerox 9 Wireless support (#188)Add Aerox 5 Wireless support (#184)Fix inverted firmware version minor and major digitsFix crash when reading battry level of a device in sleep modeImprove udev rules reloadingRival 100: Rivalcfg is now able to read the firmware version of this device
(#179, @staticssleever668)4.6.0:Add support for the Prime Wireless mouse (#172)Aerox 3 Wireless support improved:Sleep timer support implementedDim timer support implementedBrightness removed to support Dim timer (it is still possible to dim the
LED by setting darker colors)Fix a crash when printing debug information with udev rules not installedRemove Python 2.7 compatibility code4.5.0:Do not try to open devices when not needed (#170)Add support for SteelSeries Prime Rainbow 6 Siege Black Ice Edition
(1038:182A)Add support for SteelSeries Prime CS:GO Neo Noir Edition (1038:1856)Add initial support for the Rival 3 Wireless mouse (#146)Add initial support for the Rival 650 mouse (#112)4.4.0:Add Prime support (#169, @sephiroth99)Add Aerox 3 (non wireless version) support (#156)Add Aerox 3 Wireless support (#167)Save devices settings on diskAdd Black (code formatter)Drop Python 3.5 supportWARNING:This version will be the last one to support Python 2.74.3.0:Fixes Sensei TEN default config (#158)Adds the--print-udevto generate udev rules and print them tostdout(#157)CLI: Displays a usage message when no argument was given (#152)CLI: Write udev warning message tostderrinstead ofstdoutAdds a--print-debugoption to display various informationAdds a--firmware-versionoption to display the firmware version of some devicesRivalcfg can now read the firmware version of the following devices:Rival 3Rival 300Rival 310Rival 500Rival 700 / 710Sensei 310Sensei TEN4.2.0:Rival 3: support of firmware v0.37.0.0 (#147)Support of the Sensei TEN (1038:1832)Support of the Sensei TEN CS:GO Neon Rider Edition (1038:1834)Rival 500:Handles color shiftHandles button mapping4.1.0:Support of the Rival 300SRival 310 support improved:Support of button mappingSensei 310 support improved:Support of button mappingRival 3 support improved:Colors can now be defined separatelyButton mapping support implementedLight effects support implemented4.0.0:Full rewrite of most parts of the softwareMice are now grouped by families to reduce code duplicationImproved udev support on Linux:Dynamically generate udev rules instead of maintaining a static fileAutomatically check that the rules file is up to dateAdds a command to update udev rulesImproved testing:Better coverageTest the device output to avoid regressionsImproved documentation:A Sphinx documentation was added instead of stacking everything in the
READMEEach device family now have its own documentation page to make it easier
to understandPython APIs are now documentedA document was added to help contributeInstallation instructions were updated to recommend using Python 3New devices support was added:Support of the Rival 100 Dota 2 Edition (retail version) (#17)Support of the Rival 300 Fallout 4 Edition (#44)Support of the Rival 310 CS:GO Howl Edition (#113)Support of the Rival 3 (#111)Support of the Rival 300 Evil Geniuses EditionSupport of the Rival 95 MSI EditionSupport of the Rival 95 PC BangSupport of the Rival 100 PC BangSupport of the Rival 100 (Dell China)Support of the Rival 600 Dota 2 EditionSupport of the Rival 106 (#84, @SethDusek)Some devices gained a better support:Rival 300 / Original Rival familySupport of buttons mappingRival 700 / 710Support of gradients / Color shift (#129, @nixtux)A generic support of mouse buttons mapping was added (rewriting of what was
originally done for the Sensei [RAW]). The following devices now support
it:Rival 300 / Original Rival familySensei [RAW] familyRegressions:The following things were removed for this release:Sensei Ten: this mouse needs more work to be added back.Colorshift of the Rival 500: this feature needs more work to be added back.Older changelog entries were moved to theCHANGELOG.rstfile.