OpenRGB-Plugin

Add OpenRGB support to RemoteLight and control your whole RGB setup!

Features

• control any RGB hardware supported by OpenRGB (supported devices)
• create as many output devices as you want/need
• all RemoteLight effects/animations can be used
• acts like a normal RemoteLight output

Usage

1. Download RemoteLight (minimum version v0.2.5-beta, available for download from this page or directly from the GitLab-CI pipeline).
2. Download OpenRGB-Plugin and place it in the plugins folder %userprofile%/.RemoteLight/plugins
3. Download OpenRGB and set it up
4. Create a virtual output in RemoteLight
   
5. Go to Tools > OpenRGB Plugin, set up OpenRGB connection and add a new OpenRGB device group
   
6. Define a name, select the previously created virtual output and add your OpenRGB devices. The Device ID corresponds to the index of the device (starting at 0) in the list in OpenRGB (see picture below)
   
   
7. Run OpenRGB and start the SDK Server
   
8. Go back to the Output panel and activate the virtual output
9. Client should be connected
   

FAQ

Why do I need to create a virtual output?

The OpenRGB plugin uses the virtual output to get the LED color data from RemoteLight. It also allows OpenRGB devices to be used together with other regular RemoteLight output devices. With the Chain and Multi outputs, it is also possible to control multiple devices simultaneously.

Can I use multiple OpenRGB device groups with the same virtual output?

No, the plugin overwrites the pixel number of the configured virtual output with the number of LEDs received from OpenRGB. If the OpenRGB devices have different amount of LEDs, they will try to overwrite the pixel number of the virtual output and interfere with each other. To be safe that everything works, just create a separate virtual output for each OpenRGB device group. To be able to use them simultaneously, you can use for example a Chain or Multi output.

Do I have to keep OpenRGB running?

Yes, the plugin only sends the color data generated by RemoteLight to the OpenRGB SDK server. OpenRGB does the controlling of the hardware and must therefore of course keep running.

I have a problem with OpenRGB, so can you help me?

I am not involved in the development of OpenRGB and therefore have no idea about the program structure. The plugin just uses the SDK interface provided by OpenRGB. If you have problems or questions regarding OpenRGB, you can get help on the OpenRGB repository. Please contact me only if the bug is related to the plugin itself.

Can I use the Java OpenRGB wrapper as a library for my own project?

Yes, the Maven project is divided into 2 modules: openrgb-wrapper and openrgb-plugin. To use the OpenRGB interface you only need to add the openrgb-wrapper module as a dependency to your project.
Easy to use with JitPack:

	<dependency>
	    <groupId>com.github.RemoteLight.OpenRGB-Plugin</groupId>
	    <artifactId>openrgb-wrapper</artifactId>
	    <version>Tag</version>
	</dependency>

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

How to use JitPack with Multi-module projects

A short hint: The project uses some Kotlin features, so Kotlin is also needed as dependency.