Skip to content

Commit ddd77c6

Browse files
committed
updated README
1 parent b6b2b6b commit ddd77c6

File tree

7 files changed

+8
-7
lines changed

7 files changed

+8
-7
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,13 @@ Add [OpenRGB](https://gitlab.com/CalcProgrammer1/OpenRGB) support to [RemoteLigh
1313
3. [Download OpenRGB](https://gitlab.com/CalcProgrammer1/OpenRGB) and [set it up](https://gitlab.com/CalcProgrammer1/OpenRGB/-/wikis/OpenRGB-Windows-Setup-and-Usage)
1414
4. Create a virtual output in RemoteLight
1515
![Create Virtual output](images/add-virtual-output.png)
16-
5. Go to `Tools > OpenRGB Plugin` and add a new OpenRGB device
16+
5. Go to `Tools > OpenRGB Plugin`, set up OpenRGB connection and add a new OpenRGB device group
1717
![Add OpenRGB device](images/add-openrgb-device.png)
18-
6. Start OpenRGB SDK Server
18+
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)
19+
![Setup OpenRGB device](images/setup-openrgb-device.png)
20+
![OpenRGB device id](images/openrgb-device-index.png)
21+
7. Run OpenRGB and start the SDK Server
1922
![Start SDK server](images/start-openrgb-server.png)
20-
7. Setup OpenRGB connection data and select the previously created virtual output
21-
![Setup OpenRGB device](images/setup-openrgb-device.png)
2223
8. Go back to the Output panel and activate the virtual output
2324
9. Client should be connected
2425
![Client connected](images/connected-openrgb.png)
@@ -27,8 +28,8 @@ Add [OpenRGB](https://gitlab.com/CalcProgrammer1/OpenRGB) support to [RemoteLigh
2728
### Why do I need to create a virtual output?
2829
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.
2930

30-
### Can I use multiple OpenRGB devices with the same virtual output?
31-
Yes, but also 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**. To be able to use them simultaneously, you can use for example a Chain or Multi output.
31+
### Can I use multiple OpenRGB device groups with the same virtual output?
32+
No, he 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.
3233

3334
### Do I have to keep OpenRGB running?
3435
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.

images/add-openrgb-device.png

2.49 KB
Loading

images/add-virtual-output.png

370 Bytes
Loading

images/connected-openrgb.png

325 Bytes
Loading

images/openrgb-device-index.png

32.1 KB
Loading

images/setup-openrgb-device.png

2.29 KB
Loading

openrgb-plugin/src/main/java/de/lars/openrgbplugin/ui/DeviceGroupsPanel.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ public void setupSettingsPanel() {
6464
panelSettings.removeAll();
6565
JLabel lblServerIp = new JLabel("OpenRGB Server IP:");
6666
lblServerIp.setForeground(Style.textColor);
67-
JLabel lblServerPort = new JLabel("Port:");
67+
JLabel lblServerPort = new JLabel("OpenRGB Port:");
6868
lblServerPort.setForeground(Style.textColor);
6969

7070
JTextField fieldServerIp = new JTextField();

0 commit comments

Comments
 (0)