mirror of
https://github.com/DarthAffe/RGB.NET.git
synced 2025-12-12 09:38:31 +00:00
Added readmes to projects
This commit is contained in:
parent
01e671ddeb
commit
46fdd29735
36
RGB.NET.Core/README.md
Normal file
36
RGB.NET.Core/README.md
Normal file
@ -0,0 +1,36 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Core-Package.
|
||||
|
||||
Required to use RGB.NET
|
||||
|
||||
## Getting Started
|
||||
```csharp
|
||||
// Create a surface - this is where all devices belongs too
|
||||
RGBSurface surface = new RGBSurface();
|
||||
|
||||
// Load your devices - check out the RGB.NET.Devices-packages for more information
|
||||
// TODO: Load device-providers
|
||||
|
||||
// Automatically align devices to not overlap - you can ofc also move them by hand
|
||||
surface.AlignDevices();
|
||||
|
||||
// Register an update-trigger
|
||||
surface.RegisterUpdateTrigger(new TimerUpdateTrigger());
|
||||
```
|
||||
|
||||
## Basis Rendering
|
||||
```csharp
|
||||
// Create a led-group containing all leds on the surface
|
||||
ILedGroup allLeds = new ListLedGroup(surface, surface.Leds);
|
||||
|
||||
// Create a rainbow gradient
|
||||
RainbowGradient rainbow = new RainbowGradient();
|
||||
|
||||
// Animate the gradient to steadily move
|
||||
rainbow.AddDecorator(new MoveGradientDecorator(surface));
|
||||
|
||||
// Create a texture rendering that gradient
|
||||
ITexture texture = new ConicalGradientTexture(new Size(10, 10), rainbow);
|
||||
|
||||
// Create a brush rendering the texture and assign it to the group
|
||||
allLeds.Brush = new TextureBrush(texture);
|
||||
```
|
||||
13
RGB.NET.Devices.Asus/README.md
Normal file
13
RGB.NET.Devices.Asus/README.md
Normal file
@ -0,0 +1,13 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Device-Provider-Package for Asus-Devices.
|
||||
|
||||
## Usage
|
||||
This provider follows the default pattern and does not require additional setup.
|
||||
|
||||
```csharp
|
||||
surface.Load(AsusDeviceProvider.Instance);
|
||||
```
|
||||
|
||||
# Required SDK
|
||||
This providers requires the `Interop.AuraServiceLib.dll` to be present on the system. Normally this dll is installed with ASUS Aura and registered in the GAC.
|
||||
There are some known issue with this dll missing and it's recommended to pack it with your application. You can get it from your Aura-Installation or get a copy from [https://redist.arge.be/Asus/Interop.AuraServiceLib.dll](https://redist.arge.be/Asus/Interop.AuraServiceLib.dll).
|
||||
If packed it has to be located in a spot that your application is loading runtime dlls from.
|
||||
24
RGB.NET.Devices.CoolerMaster/README.md
Normal file
24
RGB.NET.Devices.CoolerMaster/README.md
Normal file
@ -0,0 +1,24 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Device-Provider-Package for Cooler Master-Devices.
|
||||
|
||||
## Usage
|
||||
This provider follows the default pattern and does not require additional setup.
|
||||
|
||||
```csharp
|
||||
surface.Load(CoolerMasterDeviceProvider.Instance);
|
||||
```
|
||||
|
||||
# Required SDK
|
||||
This providers requires native SDK-dlls.
|
||||
You can get them directly from Cooler Master at [https://templates.coolermaster.com/](https://templates.coolermaster.com/) (Direct Link: [https://templates.coolermaster.com/assets/sdk/coolermaster-sdk.zip](https://templates.coolermaster.com/assets/sdk/coolermaster-sdk.zip))
|
||||
|
||||
Since the SDK-dlls are native it's important to use the correct architecture you're building your application for. (If in doubt you can always include both.)
|
||||
|
||||
### x64
|
||||
`Src\SDK\x64\SDKDLL.dll` from the SDK-zip needs to be distributed as `<application-directory>\x64\CMSDK.dll`
|
||||
|
||||
You can use other, custom paths by adding them to `CoolerMasterDeviceProvider.PossibleX64NativePaths`.
|
||||
|
||||
### x86
|
||||
`Src\SDK\x86\SDKDLL.dll` from the SDK-zip needs to be distributed as `<application-directory>\x86\CMSDK.dll`
|
||||
|
||||
You can use other, custom paths by adding them to `CoolerMasterDeviceProvider.PossibleX86NativePaths`.
|
||||
24
RGB.NET.Devices.Corsair/README.md
Normal file
24
RGB.NET.Devices.Corsair/README.md
Normal file
@ -0,0 +1,24 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Device-Provider-Package for Corsair-Devices.
|
||||
|
||||
## Usage
|
||||
This provider follows the default pattern and does not require additional setup.
|
||||
|
||||
```csharp
|
||||
surface.Load(CorsairDeviceProvider.Instance);
|
||||
```
|
||||
|
||||
# Required SDK
|
||||
This providers requires native SDK-dlls.
|
||||
You can get them directly from Corsair at [https://github.com/CorsairOfficial/cue-sdk/releases](https://github.com/CorsairOfficial/cue-sdk/releases)
|
||||
|
||||
Since the SDK-dlls are native it's important to use the correct architecture you're building your application for. (If in doubt you can always include both.)
|
||||
|
||||
### x64
|
||||
`redist\x64\CUESDK.x64_2019.dll` from the SDK-zip needs to be distributed as `<application-directory>\x64\CUESDK.x64_2019.dll` (or simply named `CUESDK.dll`)
|
||||
|
||||
You can use other, custom paths by adding them to `CorsairDeviceProvider.PossibleX64NativePaths`.
|
||||
|
||||
### x86
|
||||
`redist\i386\CUESDK_2019.dll` from the SDK-zip needs to be distributed as `<application-directory>\x86\CUESDK_2019.dll` (or simply named `CUESDK.dll`)
|
||||
|
||||
You can use other, custom paths by adding them to `CorsairDeviceProvider.PossibleX86NativePaths`.
|
||||
16
RGB.NET.Devices.DMX/README.md
Normal file
16
RGB.NET.Devices.DMX/README.md
Normal file
@ -0,0 +1,16 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Device-Provider-Package for E1.31 DMX-Devices.
|
||||
|
||||
## Usage
|
||||
This provider does not load anything by default and requires additional configuration to work.
|
||||
|
||||
```csharp
|
||||
// Add as many DMX devices as you like
|
||||
DMXDeviceProvider.Instance.AddDeviceDefinition(new E131DMXDeviceDefinition("<hostname>"));
|
||||
|
||||
surface.Load(DMXDeviceProvider.Instance);
|
||||
```
|
||||
|
||||
You can also configure additional things like device names, custom ports, heartbeats and so on in the DeviceDefinition.
|
||||
|
||||
# Required SDK
|
||||
This provider does not require an additional SDK.
|
||||
16
RGB.NET.Devices.Debug/README.md
Normal file
16
RGB.NET.Devices.Debug/README.md
Normal file
@ -0,0 +1,16 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Device-Provider-Package for Debug-Devices.
|
||||
|
||||
> This provider is only for debug purposes!
|
||||
|
||||
## Usage
|
||||
This provider does not load anything by default and requires additional configuration to work.
|
||||
|
||||
```csharp
|
||||
// Add as many debug devices as you like
|
||||
DebugDeviceProvider.Instance.AddFakeDeviceDefinition(DeviceLayout.Load("<Path to layout-file>"));
|
||||
|
||||
surface.Load(DebugDeviceProvider.Instance);
|
||||
```
|
||||
|
||||
# Required SDK
|
||||
This provider does not require an additional SDK.
|
||||
27
RGB.NET.Devices.Logitech/README.md
Normal file
27
RGB.NET.Devices.Logitech/README.md
Normal file
@ -0,0 +1,27 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Device-Provider-Package for Logitech-Devices.
|
||||
|
||||
## Usage
|
||||
This provider follows the default pattern and does not require additional setup.
|
||||
|
||||
```csharp
|
||||
surface.Load(LogitechDeviceProvider.Instance);
|
||||
```
|
||||
|
||||
Since the logitech SDK does not provide device information only known devices will work.
|
||||
You can add detection for additional devices by adding entires for them to the respective static `DeviceDefinitions` on the `LogitechDeviceProvider`.
|
||||
|
||||
# Required SDK
|
||||
This providers requires native SDK-dlls.
|
||||
You can get them directly from Logitech at [https://www.logitechg.com/en-us/innovation/developer-lab.html](https://www.logitechg.com/en-us/innovation/developer-lab.html) (Direct Link: [https://www.logitechg.com/sdk/LED_SDK_9.00.zip](https://www.logitechg.com/sdk/LED_SDK_9.00.zip))
|
||||
|
||||
Since the SDK-dlls are native it's important to use the correct architecture you're building your application for. (If in doubt you can always include both.)
|
||||
|
||||
### x64
|
||||
`Lib\LogitechLedEnginesWrapper\x64\LogitechLedEnginesWrapper.dll` from the SDK-zip needs to be distributed as `<application-directory>\x64\LogitechLedEnginesWrapper.dll`
|
||||
|
||||
You can use other, custom paths by adding them to `LogitechDeviceProvider.PossibleX64NativePaths`.
|
||||
|
||||
### x86
|
||||
`Lib\LogitechLedEnginesWrapper\x86\LogitechLedEnginesWrapper.dll` from the SDK-zip needs to be distributed as `<application-directory>\x86\LogitechLedEnginesWrapper.dll`
|
||||
|
||||
You can use other, custom paths by adding them to `LogitechDeviceProvider.PossibleX86NativePaths`.
|
||||
24
RGB.NET.Devices.Msi/README.md
Normal file
24
RGB.NET.Devices.Msi/README.md
Normal file
@ -0,0 +1,24 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Device-Provider-Package for msi-Devices.
|
||||
|
||||
## Usage
|
||||
This provider follows the default pattern and does not require additional setup.
|
||||
|
||||
```csharp
|
||||
surface.Load(MsiDeviceProvider.Instance);
|
||||
```
|
||||
|
||||
# Required SDK
|
||||
This providers requires native SDK-dlls.
|
||||
You can get them directly from Msi at [https://de.msi.com/Landing/mystic-light-rgb-gaming-pc/download](https://de.msi.com/Landing/mystic-light-rgb-gaming-pc/download) (Direct Link: [https://download.msi.com/uti_exe/Mystic_light_SDK.zip](https://download.msi.com/uti_exe/Mystic_light_SDK.zip))
|
||||
|
||||
Since the SDK-dlls are native it's important to use the correct architecture you're building your application for. (If in doubt you can always include both.)
|
||||
|
||||
### x64
|
||||
`MysticLight_SDK_x64.dll` from the SDK-zip needs to be distributed as `<application-directory>\x64\MysticLight_SDK.dll`
|
||||
|
||||
You can use other, custom paths by adding them to `MsiDeviceProvider.PossibleX64NativePaths`.
|
||||
|
||||
### x86
|
||||
`MysticLight_SDK.dll` from the SDK-zip needs to be distributed as `<application-directory>\x86\MysticLight_SDK.dll`
|
||||
|
||||
You can use other, custom paths by adding them to `MsiDeviceProvider.PossibleX86NativePaths`.
|
||||
11
RGB.NET.Devices.Novation/README.md
Normal file
11
RGB.NET.Devices.Novation/README.md
Normal file
@ -0,0 +1,11 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Device-Provider-Package for Novation-Devices.
|
||||
|
||||
## Usage
|
||||
This provider follows the default pattern and does not require additional setup.
|
||||
|
||||
```csharp
|
||||
surface.Load(NovationDeviceProvider.Instance);
|
||||
```
|
||||
|
||||
# Required SDK
|
||||
This provider does not require an additional SDK.
|
||||
16
RGB.NET.Devices.OpenRGB/README.md
Normal file
16
RGB.NET.Devices.OpenRGB/README.md
Normal file
@ -0,0 +1,16 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Device-Provider-Package for E1.31 DMX-Devices.
|
||||
|
||||
## Usage
|
||||
This provider does not load anything by default and requires additional configuration to work.
|
||||
|
||||
```csharp
|
||||
// Add as many OpenRGB-instances as you like
|
||||
OpenRGBDeviceProvider.Instance.AddDeviceDefinition(new OpenRGBServerDefinition());
|
||||
|
||||
surface.Attach(OpenRGBDeviceProvider.Instance.Devices);
|
||||
```
|
||||
|
||||
You can also configure additional things like IP and Port in the ServerDefinition.
|
||||
|
||||
# Required SDK
|
||||
This provider does not require an additional SDK.
|
||||
@ -1 +1,13 @@
|
||||
Check https://github.com/DarthAffe/RGB.NET-PicoPi for the required firmware.
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Device-Provider-Package for RGB.NET-Devices based on the Raspi Pi Pico.
|
||||
|
||||
To create your own Raspberry PI Pico based controller check the RGB.NET Firmware at [https://github.com/DarthAffe/RGB.NET-PicoPi](https://github.com/DarthAffe/RGB.NET-PicoPi)
|
||||
|
||||
## Usage
|
||||
This provider follows the default pattern and does not require additional setup.
|
||||
|
||||
```csharp
|
||||
surface.Load(PicoPiDeviceProvider.Instance);
|
||||
```
|
||||
|
||||
# Required SDK
|
||||
This provider does not require an additional SDK.
|
||||
|
||||
14
RGB.NET.Devices.Razer/README.md
Normal file
14
RGB.NET.Devices.Razer/README.md
Normal file
@ -0,0 +1,14 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Device-Provider-Package for Razer-Devices.
|
||||
|
||||
## Usage
|
||||
This provider follows the default pattern and does not require additional setup.
|
||||
|
||||
```csharp
|
||||
surface.Load(RazerDeviceProvider.Instance);
|
||||
```
|
||||
|
||||
Since the Razer SDK does not provide device information only known devices will work.
|
||||
You can add detection for additional devices by adding entires for them to the respective static `DeviceDefinitions` on the `RazerDeviceProvider`.
|
||||
|
||||
# Required SDK
|
||||
The SDK needs to be installed inside Synapse by the user and is not redistributed.
|
||||
14
RGB.NET.Devices.SteelSeries/README.md
Normal file
14
RGB.NET.Devices.SteelSeries/README.md
Normal file
@ -0,0 +1,14 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Device-Provider-Package for Steel Series-Devices.
|
||||
|
||||
## Usage
|
||||
This provider follows the default pattern and does not require additional setup.
|
||||
|
||||
```csharp
|
||||
surface.Load(SteelSeriesDeviceProvider.Instance);
|
||||
```
|
||||
|
||||
Since the Steel Series SDK does not provide device information only known devices will work.
|
||||
You can add detection for additional devices by adding entires for them to the respective static `DeviceDefinitions` on the `SteelSeriesDeviceProvider`.
|
||||
|
||||
# Required SDK
|
||||
This provider does not require an additional SDK.
|
||||
20
RGB.NET.Devices.WS281X/README.md
Normal file
20
RGB.NET.Devices.WS281X/README.md
Normal file
@ -0,0 +1,20 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Device-Provider-Package for RGB.NET-Devices based on Aurdion or ESP8266.
|
||||
|
||||
To create your own Aurdion/ESP8266 based controller check the Sketches at [https://github.com/DarthAffe/RGB.NET/tree/master/RGB.NET.Devices.WS281X/Sketches](https://github.com/DarthAffe/RGB.NET/tree/master/RGB.NET.Devices.WS281X/Sketches)
|
||||
|
||||
> If you start a new project it's recommended to use the Raspberry Pi Pico due to it's better performance and lower cost. Check the `RGB.NET.Devices.PicoPi`-package.
|
||||
|
||||
> This provider does not work with WLED. If you want to use that check the `RGB.NET.Devices.DMX`-package.
|
||||
|
||||
## Usage
|
||||
This provider does not load anything by default and requires additional configuration to work.
|
||||
|
||||
```csharp
|
||||
// Add as many Arduino or NodeMCU devices as you like
|
||||
WS281XDeviceProvider.Instance.AddDeviceDefinition(new ArduinoWS281XDeviceDefinition("COM3"));
|
||||
|
||||
surface.Load(WS281XDeviceProvider.Instance);
|
||||
```
|
||||
|
||||
# Required SDK
|
||||
This provider does not require an additional SDK.
|
||||
24
RGB.NET.Devices.Wooting/README.md
Normal file
24
RGB.NET.Devices.Wooting/README.md
Normal file
@ -0,0 +1,24 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Device-Provider-Package for Wooting-Devices.
|
||||
|
||||
## Usage
|
||||
This provider follows the default pattern and does not require additional setup.
|
||||
|
||||
```csharp
|
||||
surface.Load(WootingDeviceProvider.Instance);
|
||||
```
|
||||
|
||||
# Required SDK
|
||||
This providers requires native SDK-dlls.
|
||||
You can get them directly from Wooting at [https://github.com/WootingKb/wooting-rgb-sdk/releases](https://github.com/WootingKb/wooting-rgb-sdk/releases)
|
||||
|
||||
Since the SDK-dlls are native it's important to use the correct architecture you're building your application for. (If in doubt you can always include both.)
|
||||
|
||||
### x64
|
||||
`wooting-rgb-sdk.dll` from the x64-zip needs to be distributed as `<application-directory>\x64\wooting-rgb-sdk.dll`
|
||||
|
||||
You can use other, custom paths by adding them to `WootingDeviceProvider.PossibleX64NativePaths`.
|
||||
|
||||
### x86
|
||||
`wooting-rgb-sdk.dll` from the x86-zip needs to be distributed as `<application-directory>\x86\wooting-rgb-sdk.dll`
|
||||
|
||||
You can use other, custom paths by adding them to `WootingDeviceProvider.PossibleX86NativePaths`.
|
||||
3
RGB.NET.HID/README.md
Normal file
3
RGB.NET.HID/README.md
Normal file
@ -0,0 +1,3 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) HID-Package.
|
||||
|
||||
Abstraction for device-providers that require HID-functionality.
|
||||
3
RGB.NET.Layout/README.md
Normal file
3
RGB.NET.Layout/README.md
Normal file
@ -0,0 +1,3 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Layout-Package.
|
||||
|
||||
Required to use the RGB.NET-Layout-System.
|
||||
3
RGB.NET.Presets/README.md
Normal file
3
RGB.NET.Presets/README.md
Normal file
@ -0,0 +1,3 @@
|
||||
[RGB.NET](https://github.com/DarthAffe/RGB.NET) Presets-Package.
|
||||
|
||||
Contains a mix of Groups, Textures, Decorators and more.
|
||||
Loading…
x
Reference in New Issue
Block a user