You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
+ Refomatted and expanded the "Installing OpenRGB" on Linux section
+ Added link to new automated UDEV rules file `60-openrgb.rules`
+ Removed reference to `chmod` for SMBus access to resolve #2343
@@ -35,17 +35,27 @@ There have been two instances of hardware damage in OpenRGB's development and we
35
35
* The Mystic Light motherboard code bricked the RGB controller of some MSI motherboards. The code was disabled and reworked. We have been re-adding these motherboards to the support list as we verify that the new code works with them. Affected boards can be unbricked with a Nuvoton Nu-Link adapter.
36
36
* There were reports of bricked Gigabyte Aorus Z390 motherboards caused by dumping SMBus address 0x68 in an attempt to reverse engineer the RGB. Due to this, the SMBus Tools page on OpenRGB is hidden by default now as it has no real use to non-developers.
* Pre-built binaries are available under the Releases section on GitLab.
43
-
- You will need the **Microsoft Visual 2019 C++ runtime** installed. You can get it [here](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads)
44
-
* If you wish to build the application yourself:
42
+
* You will need the **Microsoft Visual 2019 C++ runtime** installed. You can get it [here](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads)
43
+
* Pre-built Release binaries are available for Windows 10 / 11 64bit under the [Releases section](https://gitlab.com/CalcProgrammer1/OpenRGB/-/releases/permalink/latest#Windows-64-bit) on GitLab.
44
+
* If you want to test the latest (potentially unstable) code you can also get the Windows package from [the pipeline builds](https://gitlab.com/CalcProgrammer1/OpenRGB/-/jobs/artifacts/master/download?job=Windows+64).
45
+
46
+
<details>
47
+
<summary><h5>Compiling</h5></summary>
48
+
49
+
* To build the application yourself on Windows:
45
50
1. Download the latest Visual Studio Community Edition and Qt Creator.
46
51
2. Open the OpenRGB.pro project in Qt Creator.
47
52
3. Use the MSVC compiler kit, either 32- or 64-bit, to build the application.
48
53
4. Run the project from Qt Creator. If you want to use your custom build standalone, download the latest matching Release package and replace the OpenRGB.exe in it with your new build.
54
+
55
+
</details>
56
+
57
+
----
58
+
49
59
### SMBus Access
50
60
***You must run the application as Administrator the first time to allow WinRing0 to set up. It can be run as a normal user afterwards**
51
61
* Early versions of OpenRGB used InpOut32. This is no longer needed and should be removed to avoid warnings by some anti-cheat software. You can uninstall Inpout32 by following the instructions [here](https://gitlab.com/CalcProgrammer1/OpenRGB/-/issues/669#note_461054255).
@@ -56,59 +66,139 @@ There have been two instances of hardware damage in OpenRGB's development and we
56
66
57
67
## Linux
58
68
59
-
* Pre-built binaries in AppImage format are available under the Releases section on GitLab.
60
-
* You can build the project using Qt Creator or on the command line.
* You can also build a Debian package (.deb) from this source code with dpkg-buildpackage -us -B
72
-
- Building a Debian package requires `debhelper` to be installed: `sudo apt install debhelper`
69
+
* Pre-built binaries in AppImage format are available under the [Releases](https://gitlab.com/CalcProgrammer1/OpenRGB/-/releases/permalink/latest#Linux-64-bit) section on GitLab.
70
+
* There is also a unofficial universal Flatpak build [available on Flathub](https://flathub.org/apps/details/org.openrgb.OpenRGB). Note: To ensure you have device permissions please [install the latest UDEV rules](#installing-udev-rules-manually).
71
+
72
+
<details>
73
+
<summary><h5>Arch</h5></summary>
74
+
75
+
##### Binaries
76
+
77
+
* OpenRGB is available in the AUR for both the [release](https://aur.archlinux.org/packages/openrgb/) and [pipeline](https://aur.archlinux.org/packages/openrgb-git/) builds
78
+
79
+
</details>
80
+
<details>
81
+
<summary><h5>Debian / Ubuntu</h5></summary>
82
+
83
+
##### Binaries
84
+
85
+
* OpenRGB builds an official Debian package for Bullseye and Ubuntu 21.04 onwards for both the 64bit [release](https://gitlab.com/CalcProgrammer1/OpenRGB/-/releases/permalink/latest#Debian-Bullseye-amd64) and [pipeline](https://gitlab.com/CalcProgrammer1/OpenRGB/-/jobs/artifacts/master/download?job=Linux+64+.deb+%28Debian+Bullseye%29) builds
86
+
* There is also a legacy package for Debian 64bit Buster and it's derivatives (Ubuntu prior to 21.04) with [release](https://gitlab.com/CalcProgrammer1/OpenRGB/-/releases/permalink/latest#Debian-Buster-amd64) and [pipeline](https://gitlab.com/CalcProgrammer1/OpenRGB/-/jobs/artifacts/master/download?job=Linux+64+.deb+%28Debian+Buster%29) builds
6. You can then run the application from the compile directory with `./openrgb` or install with `make install`
97
+
7. You will also need to [install the latest UDEV rules](#installing-udev-rules-manually).
98
+
99
+
##### Packaging
100
+
101
+
* You can also build a Debian package (.deb) from this source code with `dpkg-buildpackage -us -B`
102
+
- Building a Debian package requires `debhelper` to be installed: `sudo apt install debhelper`
103
+
104
+
</details>
105
+
<details>
106
+
<summary><h5>Fedora</h5></summary>
107
+
108
+
##### Binaries
109
+
110
+
* OpenRGB builds an official Fedora 35 and 36 package for both the [release](https://gitlab.com/CalcProgrammer1/OpenRGB/-/releases/permalink/latest#Linux-64-bit) and [pipeline](https://gitlab.com/CalcProgrammer1/OpenRGB/-/jobs/artifacts/master/download?job=Linux+64+rpm) builds
6. You can then run the application from the compile directory with `./openrgb` or install with `make install`
121
+
7. You will also need to [install the latest UDEV rules](#installing-udev-rules-manually).
122
+
123
+
</details>
73
124
125
+
----
126
+
74
127
### SMBus Access
75
128
76
-
* SMBus access is necessary for controlling RGB RAM and certain motherboard on-board LEDs.
77
-
* If you are not trying to use OpenRGB to control RGB RAM or motherboard LEDs, you may skip this section.
78
-
* ASUS and ASRock motherboards have their RGB controller on an SMBus interface that is not accessible by an unmodified Linux kernel (for now). I am working on getting patches submitted upstream, but for now you must patch your kernel with the provided OpenRGB.patch file.
79
-
* Allowing access to SMBus:
80
-
1. Load the i2c-dev module: `sudo modprobe i2c-dev`
- Unmodified kernel will have one interface, patched kernel will have two. The first at 0x0B00 and the second at 0x0B20. The 0x0B20 interface is for motherboard LEDs.
- If you want to check if the kernel was loaded with this option you can execute this command from the terminal once you've rebooted.
97
-
```
98
-
cat /proc/cmdline
99
-
```
129
+
* SMBus access is necessary for controlling RGB RAM and certain motherboard on-board LEDs.
130
+
* If you are not trying to use OpenRGB to control RGB RAM or motherboard LEDs, you may skip this section.
131
+
* ASUS and ASRock motherboards have their RGB controller on a secondary SMBus interface and requires a Linux kernel > 5.7 <sup>[commit](https://github.com/torvalds/linux/commit/f27237c174fd9653033330e4e532cd9d153ce824)</sup>
132
+
* Allowing access to SMBus:
133
+
1. Load the i2c-dev module: `sudo modprobe i2c-dev`
* Unmodified kernel will have one interface, patched kernel will have two. The first at 0x0B00 and the second at 0x0B20. The 0x0B20 interface is for motherboard LEDs.
147
+
148
+
</details>
149
+
150
+
----
151
+
100
152
* You'll have to enable user access to your SMBus if you don't run as root.
101
153
- List all SMBus controllers: `sudo i2cdetect -l`
102
154
- Note the number for PIIX4, I801, and NCT6775 controllers.
103
-
- Give user access to those controllers, for instance: `sudo chmod 777 /dev/i2c-0`
155
+
- Give user access to those controllers. If you have not installed OpenRGB from a package (e.g. deb, RPM or from the AUR) then most likely you need to [install the UDEV rules](#installing-udev-rules-manually).
156
+
* The i2c-nct6775 kernel module requires patching, please refer to [instructions here](https://gitlab.com/CalcProgrammer1/OpenRGB/-/wikis/OpenRGB-Kernel-Patch)
157
+
* Some Gigabyte/Aorus motherboards have an ACPI conflict with the SMBus controller. Please [add a kernel parameter](#kernel-parameters) to resolve this conflict.
104
158
105
159
### USB Access
106
160
107
-
* USB devices require udev rules to access as a normal user.
108
-
* You can run OpenRGB as root to detect all USB devices.
109
-
* Udev rules are included in this repo:
110
-
- Copy the 60-openrgb.rules file to /etc/udev/rules.d/
111
-
- Reload rules with `sudo udevadm control --reload-rules && sudo udevadm trigger`
161
+
* USB devices require [udev rules](#installing-udev-rules-manually) to access as a normal user.
162
+
* Alternatively you can run OpenRGB as root to detect all USB devices. (Not recommended)
163
+
* USB based Gigabyte AORUS motherboards may also have an ACPI conflict. Please [add a kernel parameter](#kernel-parameters) to resolve this conflict.
164
+
165
+
### Installing UDEV rules manually
166
+
167
+
* If you have installed OpenRGB from a package then latest UDEV rules are installed locally at `/usr/lib/udev/rules.d/60-openrgb.rules`
168
+
* Flatpak and Appimage "packages" will need to install this file manually.
169
+
* Udev rules are built from the source at compile time. When building locally they are installed with the `make install` step to `/usr/lib/udev/rules.d/60-openrgb.rules`
170
+
* If you need to install the UDEV rules file manually you can also download the [latest compiled udev rules](https://gitlab.com/CalcProgrammer1/OpenRGB/-/jobs/artifacts/master/raw/60-openrgb.rules?job=Linux+64+AppImage&inline=false) from Gitlab.
171
+
- Copy this 60-openrgb.rules file to `/usr/lib/udev/rules.d/`
172
+
- Then reload rules with `sudo udevadm control --reload-rules && sudo udevadm trigger`
173
+
174
+
### Kernel Parameters
175
+
176
+
* To resolve an ACPI conflict add the `acpi_enforce_resources=lax` kernel parameter.
177
+
* If you want to check if the kernel was loaded with this option you can execute this command from the terminal once you've rebooted.
178
+
*`cat /proc/cmdline`
179
+
180
+
<details>
181
+
<summary><h5>Arch</h5></summary>
182
+
183
+
* Please see [the Arch wiki](https://wiki.archlinux.org/title/kernel_parameters) for details on how to update your bootloader.
184
+
185
+
</details>
186
+
<details>
187
+
<summary><h5>Debian / Ubuntu</h5></summary>
188
+
189
+
* Please see [the Ubuntu Documentation](https://wiki.ubuntu.com/Kernel/KernelBootParameters) for Kernel Parameters for more information on updating your boot parameters.
190
+
191
+
</details>
192
+
<details>
193
+
<summary><h5>Fedora</h5></summary>
194
+
195
+
* On Fedora, install `grubby` and then following command:
* For more information please refer to the Fedora docs for [grubby](https://docs.fedoraproject.org/en-US/fedora/latest/system-administrators-guide/kernel-module-driver-configuration/Working_with_the_GRUB_2_Boot_Loader/#sec-Making_Persistent_Changes_to_a_GRUB_2_Menu_Using_the_grubby_Tool).
0 commit comments