strodgers / epomaker-controller

35 stars 3 forks source link

Add a supported devices table. #37

Open cskau opened 1 month ago

cskau commented 1 month ago

It'd be really helpful to have a list, or perhaps table, of supported devices/features. Perhaps something along the line of:

Keyboard          cycle-light-modes    send-cpu  ...
--------------------------------------------------------------
Epomaker RT100    TRUE                 TRUE
Epomaker TH80     TRUE                 TRUE
Epomaker EP64     TRUE                 FALSE
Gamakay TK68-HE   TRUE                 FALSE
...

I know this repo is originally specifically for RT100, but seeing how it also works with other Epomaker - and even non-Epomaker - models, I think it'd be great to document compatibility.

In fact I suspect there is a large number of keyboards out there that this code will work for in some capacity, as several clues point to "ROYUAN" ("rongyuan"?) being the OEM for all these rebranded keyboards:

For anyone curious some of the company names in the list are: acer, AJAZZ, akko, AttackShark, DELUX, DURGOD, EPOMAKER, FEKER, gamakay2, ikbc, IQUNIX, Keychron, Keydous, MonsGeek, MotoSpeed, NOPPOO, QwertyKeyRomania, RedThunder, rongyuan, Skyloong, ... (and like 200+ more)

(And while we're at it there are also references to QMK..)

strodgers commented 1 month ago

This can definitely be done and should prove useful!

The original intention of this project was essentially just to provide a way to interact with the little screen on the RT00 specifically, since that kind of functionality doesn't exist in other open source keyboard controller software like OpenRGB (at least not without doing lots of work on UI stuff, which I really don't want to do).

I would imagine it might be easier for anyone interested in controlling any other RGB keyboard (that does not have a quirky feature like a little screen) to contribute to OpenRGB instead, since they already have support for a lot of keyboards (including some very similar Epomaker models, which I have referenced for some code in this repo). That being said, there's no reason why this project can't be used for other keyboards too if people find it easier in some way.

strodgers commented 1 month ago

I'm going to add this in once the package officially supports more than one keyboard, eg more than one config in configs/keymaps