Skip to content
master
Switch branches/tags
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Python RGB Keyboards Library

GPL License

This is a project that aims to create a universal RGB keyboard control library in Python. Using the varous SDKs available and by creating wrappers around them, this library allows you to control the RGB k eyboards of multiple brands in a universal manner with the same function structure and arguments passed.

Keyboards

Please check the BACKENDS.md file for more information on what keyboards are supported by the various included back-ends in this library. Most back-ends have additional dependencies that might not be free software on depend on non-free software.

License

Python RGB Keyboards
Copyright (C) 2017 RedFantom

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Goals

The goal of this project is to provide a universal interface for all RGB Keyboards for Python programmers with a consistent function structure. I would like to include as many keyboards in the library as possible, but I can only test the code for the Cooler MasterKeys SDK. If you experience any issues, please report them in the issues section. Also,

Contribute

If you would like to contribute to the project, by either reporting issues or writing code, that would be great! You can either fork the repository, or you can send me an e-mail on redfantom@outlook.com so I can add you as a contributer to the project.

Credits

  • 10se1ucgo and JiFish for creating the cue_sdk Python wrapper which is used in this project (Apache 2.0 License)