OpenRGB: Difference between revisions

imported>SIGSTKFLT
add install instructions
Layer-09 (talk | contribs)
Changed the layout, added more information
(One intermediate revision by one other user not shown)
Line 1: Line 1:
[https://openrgb.org/ OpenRGB] is a powerful open-source software for controlling RGB lighting on various computer components and peripherals. It provides a unified interface for managing RGB devices from different manufacturers, eliminating the need for multiple proprietary software solutions. With OpenRGB, users can <strong>customize</strong> their PC's lighting effects, <strong>synchronize</strong> colors across devices, and create <strong>dynamic</strong> lighting profiles. This tool is particularly useful for users who want to maintain full control over their system's RGB lighting without relying on closed-source applications.
== Installation ==
== Installation ==
<div style="border: 1px solid #D33; background: #FFEBEB; padding: 30px; border-radius: 5px; margin: 10px 0px; display: flex; align-items: center;">
    <div style="color: #D33; font-size: 40px; margin-right: 15px; background: #FFEBEB; display: flex; line-height: 0;  align-items: center;">⚠</div>
    <div style="color: #D33; font-size: 15px; font-style: normal; font-weight: 400; line-height: normal; text-align: left;">Please do note that installing this package by itself will lead to udev rules not being set up correctly. It is recommended to have both services.hardware.openrgb.enable = true; and the package installed (either openrgb or openrgb-with-all-plugins)</div>
</div>
==== Using nix-shell ====
<syntaxhighlight lang="bash" start="3">
nix-shell -p openrgb
</syntaxhighlight>


add to <code>/etc/nixos/configuration.nix</code>:
==== Using Global Configuration ====
<syntaxhighlight lang="text">
environment.systemPackages = [
  pkgs.openrgb
];
</syntaxhighlight>After modifying your configuration, apply the changes by running:<syntaxhighlight lang="bash">
sudo nixos-rebuild switch
</syntaxhighlight>
 
==== Using Home Configuration ====
<syntaxhighlight lang="text">
home.packages = [
  pkgs.openrgb
];
</syntaxhighlight>After updating your configuration, apply the changes by running:<syntaxhighlight lang="bash">
home-manager switch
</syntaxhighlight>
 
== Configuration ==
==== Basic ====
<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix">
services.hardware.openrgb.enable = true;
services.hardware.openrgb.enable = true;  
</syntaxhighlight>
</syntaxhighlight>
No need to add OpenRGB to systemPackages.


== Turn off RGB ==
==== Advanced ====
<syntaxhighlight lang="nix">
services.hardware.openrgb = {
  enable = true;
  package = pkgs.openrgb-with-all-plugins;
  motherboard = "amd";
  server = {
    port = 6742;
    autoStart = true;
  };
};
</syntaxhighlight>
 
== Tips and Tricks ==
==== Location of Options ====
The global options are listed on [https://mynixos.com/search?q=openrgb MyNixOS].
 
==== Turn off RGB ====


If you'd like to turn off all RGB devices supported by OpenRGB, consider something like:
If you'd like to turn off all RGB devices supported by OpenRGB, consider something like:
Line 39: Line 85:
}
}
</syntaxhighlight>
</syntaxhighlight>
== Troubleshooting ==
== References ==
* https://openrgb.org/
* https://mynixos.com/search?q=openrgb