From 1cc41bb4cd95d1e368ad765232dc09dc368474d4 Mon Sep 17 00:00:00 2001 From: Adam Honse Date: Thu, 9 Jan 2025 11:48:26 -0600 Subject: [PATCH] Clean up README.md --- README.md | 60 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 31 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index f0d6ba49..d214a82d 100644 --- a/README.md +++ b/README.md @@ -86,47 +86,49 @@ This project interacts directly with hardware using reverse engineered protocols * OpenRGB provides a network interface for controlling supported RGB devices from other software. These projects implement the OpenRGB SDK and provide additional ways for you to control your lighting setup. - * OpenRGB Python Client (by bahorn): https://github.com/bahorn/OpenRGB-PyClient - * OpenRGB Python Client (by jath03): https://github.com/jath03/openrgb-python - * OpenRGB Node.js Client (by vlakreeh): https://github.com/vlakreeh/openrgb - * D-Bus Connector for OpenRGB (by Vinno97): https://github.com/Vinno97/OpenRGB-DBus-Connector - * OpenRGB.NET - C# OpenRGB Client (by diogotr7): https://github.com/diogotr7/OpenRGB.NET - * OpenRGB-Client - Java Client (by morg): https://gitlab.com/mguimard/openrgb-client - * OpenRGB-SDK - NodeJS client (by Mola19): https://www.npmjs.com/package/openrgb-sdk - * OpenRGB-cppSDK - C++ client (by Youda008): https://github.com/Youda008/OpenRGB-cppSDK - * openrgb-rs - Rust client (by nicoulaj): https://github.com/nicoulaj/openrgb-rs + * [OpenRGB Python Client](https://github.com/jath03/openrgb-python) (by jath03) + * [OpenRGB Python Client (deprecated)](https://github.com/bahorn/OpenRGB-PyClient) (by bahorn) + * [OpenRGB Node.js Client](https://github.com/vlakreeh/openrgb) (by vlakreeh) + * [D-Bus Connector for OpenRGB](https://github.com/Vinno97/OpenRGB-DBus-Connector) (by Vinno97) + * [OpenRGB.NET - C# OpenRGB Client](https://github.com/diogotr7/OpenRGB.NET) (by diogotr7) + * [OpenRGB-Client - Java Client](https://gitlab.com/mguimard/openrgb-client) (by morg) + * [OpenRGB-SDK - NodeJS client](https://www.npmjs.com/package/openrgb-sdk) (by Mola19) + * [OpenRGB-cppSDK - C++ client](https://github.com/Youda008/OpenRGB-cppSDK) (by Youda008) + * [openrgb-rs - Rust client](https://github.com/nicoulaj/openrgb-rs) (by nicoulaj) ## Applications Supporting OpenRGB SDK * While OpenRGB itself only provides control over the lighting effects built into hardware, several open source applications can use the OpenRGB SDK to provide synchronized lighting effects for your devices. - * Keyboard Visualizer (by me): https://gitlab.com/CalcProgrammer1/KeyboardVisualizer - * OpenRGB E1.31 Receiver (by me): https://gitlab.com/CalcProgrammer1/OpenRGBE131Receiver - * Project Aurora (support added by diogotr7): https://github.com/Aurora-RGB/Aurora - * Artemis 2 (support added by diogotr7 as a plugin): https://github.com/Artemis-RGB/Artemis - * RemoteLight (by Drumber, need OpenRGB plugin): https://github.com/Drumber/RemoteLight - * OpenRGB-python-FX (by herosilas12): https://github.com/herosilas12/OpenRGB-python-FX - * AllMyLights (by sparten11740): https://github.com/sparten11740/allmylights - * OpenRGBRemote (by morg): https://gitlab.com/mguimard/openrgbremote - * PiLED (by PolisanTheEasyNick): https://github.com/PolisanTheEasyNick/PiLED + * [Keyboard Visualizer](https://gitlab.com/CalcProgrammer1/KeyboardVisualizer) (by CalcProgrammer1) + * [OpenRGB E1.31 Receiver](https://gitlab.com/CalcProgrammer1/OpenRGBE131Receiver) (by me) + * [Aurora](https://github.com/Aurora-RGB/Aurora) (OpenRGB support added by diogotr7) + * [Artemis](https://github.com/Artemis-RGB/Artemis) (OpenRGB support added by diogotr7) + * [RemoteLight](https://github.com/Drumber/RemoteLight) (by Drumber, requires OpenRGB plugin) + * [OpenRGB-python-FX](https://github.com/herosilas12/OpenRGB-python-FX) (by herosilas12) + * [AllMyLights](https://github.com/sparten11740/allmylights) (by sparten11740) + * [OpenRGBRemote](https://gitlab.com/mguimard/openrgbremote) (by morg) + * [PiLED](https://github.com/PolisanTheEasyNick/PiLED) (by PolisanTheEasyNick) ## OpenRGB Plugins * OpenRGB provides a plugin interface for adding features to the OpenRGB application. The following projects provide additional functionality in the form of plugins. - * OpenRGB E1.31 Receiver Plugin (by me): https://gitlab.com/OpenRGBDevelopers/OpenRGBE131ReceiverPlugin - * Effects Engine Plugin (by herosilas12, morg): https://gitlab.com/OpenRGBDevelopers/OpenRGBEffectsPlugin - * OpenRGB Visual Map Plugin (by morg): https://gitlab.com/OpenRGBDevelopers/OpenRGBVisualMapPlugin - * Scheduler Plugin (by morg): https://gitlab.com/OpenRGBDevelopers/OpenRGBSchedulerPlugin - * Skin Plugin (by morg): https://gitlab.com/OpenRGBDevelopers/openrgbskinplugin - * Hardware Sync Plugin (by morg): https://gitlab.com/OpenRGBDevelopers/OpenRGBHardwareSyncPlugin - * Http Hook Plugin (by morg): https://gitlab.com/OpenRGBDevelopers/OpenRGBHttpHookPlugin - * Razer extras Plugin (by morg): https://gitlab.com/OpenRGBDevelopers/OpenRGBRazerExtrasPlugin - * Fan Hardware Sync Plugin (by Shady): https://gitlab.com/ShadyNawara/openrgbfansyncplugin - * OpenRGB Ambient Plugin (by krojew): https://github.com/krojew/OpenRGB-Ambient + * [OpenRGB Effects Plugin](https://gitlab.com/OpenRGBDevelopers/OpenRGBEffectsPlugin) (by herosilas12, morg) + * [OpenRGB Visual Map Plugin](https://gitlab.com/OpenRGBDevelopers/OpenRGBVisualMapPlugin) (by morg) + * [OpenRGB E1.31 Receiver Plugin](https://gitlab.com/OpenRGBDevelopers/OpenRGBE131ReceiverPlugin) (by CalcProgrammer1) + * [OpenRGB Scheduler Plugin](https://gitlab.com/OpenRGBDevelopers/OpenRGBSchedulerPlugin) (by morg) + * [OpenRGB Skin Plugin](https://gitlab.com/OpenRGBDevelopers/openrgbskinplugin) (by morg) + * [OpenRGB Hardware Sync Plugin](https://gitlab.com/OpenRGBDevelopers/OpenRGBHardwareSyncPlugin) (by morg) + * [OpenRGB Http Hook Plugin](https://gitlab.com/OpenRGBDevelopers/OpenRGBHttpHookPlugin) (by morg) + * [OpenRGB Razer Extras Plugin](https://gitlab.com/OpenRGBDevelopers/OpenRGBRazerExtrasPlugin) (by morg) + * [OpenRGB Fan Hardware Sync Plugin](https://gitlab.com/OpenRGBDevelopers/OpenRGBFanSyncPlugin) (by Shady) + * [OpenRGB Ambient Plugin](https://github.com/krojew/OpenRGB-Ambient) (by krojew) ## Projects Used +* OpenRGB directly relies upon these projects. + * WinRing0: https://openlibsys.org/ * libusb: https://github.com/libusb/libusb * hidapi: https://github.com/libusb/hidapi @@ -141,7 +143,7 @@ This project interacts directly with hardware using reverse engineered protocols ## Projects Researched -While no code from these projects directly made its way into OpenRGB, these projects have been invaluable resources for protocol information. +* While no code from these projects directly made its way into OpenRGB, these projects have been invaluable resources for protocol information. * OpenRazer: https://github.com/openrazer/openrazer * OpenRazer-Win32: https://github.com/CalcProgrammer1/openrazer-win32