Skip to content

Latest commit

 

History

History
371 lines (266 loc) · 13.5 KB

index.md

File metadata and controls

371 lines (266 loc) · 13.5 KB
Raw
layout permalink navigation about devices download instructions apps links footer
base
/
label icon href
Features
fa fa-star
#features
label icon href
Devices
fa fa-keyboard
#devices
label icon href
Download
fa fa-download
#download
label icon href
Apps
fa fa-puzzle-piece
#apps
label icon href
Links
fa-brands fa-github
#project
title description items
What is OpenRazer?
A community-led effort to support Razer peripherals on Linux. It consists of:
title icon description
Linux Kernel Module
fa-brands fa-linux
Written in C and configured to rebuild on kernel updates using DKMS
title icon description
Daemon
fa fa-gears
Adding persistence support, battery notifications and turning off brightness on screensaver
title icon description
Python Library
fa-brands fa-python
For integration with scripts and [applications ↓](#apps)
title description items footnotes
Features
OpenRazer enables Razer-specific capabilities of the hardware, such as:
title icon description
Hardware Effects
fa-brands fa-usb
Exposing what's supported on the firmware. Devices retain settings across power cycles*
title icon description
Device Functions
fa fa-computer-mouse
Such as brightness, DPI** and polling rate
title icon description
Addressable RGB
fa-regular fa-lightbulb
Enable custom lighting via software
* Not supported by all hardware. Using the device on a computer running Razer Synapse will reset this state.
** Most mice DPI hardware buttons are not intercepted and continue to use default behaviour/range.
intro keyboard mice mousemat keypads headset other
Originally written for the BlackWidow Chroma, the driver is now compatible with 123 Razer peripherals.
A third party application is required for key rebinding, such as [input-remapper](https://github.com/sezanzeb/input-remapper/).
Only lighting features are supported. OpenRazer doesn't provide additional audio features.
Webcams with no lighting features are not supported. Try [cameractrls](https://github.com/soyersoyer/cameractrls) to enable HDR and related functionality.
Before installing the driver, you'll need to install a kernel headers package that matches your kernel version. This is because the driver is "out-of-tree" and needs to be compiled for the kernel (using DKMS). For example, Arch has `linux-headers` and `linux-lts-headers`. Other distros like Ubuntu/Debian may install them automatically, as the packaging system "recommends" the necessary package. Before using OpenRazer, you'll need to add your user to the `plugdev` group. In most distributions, this is: sudo gpasswd -a $USER plugdev After following the instructions for your distribution below, a **system reboot** is essential so the driver and user group permissions take effect. **Secure boot** may need to be disabled due to the nature of the driver being unsigned. After successful installation, reboot the computer and [pick an application](#apps) to interact with the driver.
title summary distros
Officially Supported
We provide packages for these distros.
name id logo instructions
Debian
debian
/img/distros/debian.svg
Starting with Debian 10, OpenRazer is available from the [official repositories](https://packages.debian.org/search?keywords=openrazer). However, you may need to install our package if your device was added in a newer version. Instructions and downloadable builds for Debian are [available from the openSUSE Build Service.](https://software.opensuse.org/download.html?project=hardware%3Arazer&package=openrazer-meta)
name id logo instructions
Fedora
fedora
/img/distros/fedora.svg
Due to a bug in Fedora, the wrong kernel headers (`kernel-debug-devel`) may be installed and cause OpenRazer to fail installation. To fix this, you must install `kernel-devel` explictly before installing OpenRazer: sudo dnf install kernel-devel For Fedora 41 (and later), run the following: sudo dnf config-manager addrepo --from-repofile=https://openrazer.github.io/hardware:razer.repo sudo dnf install openrazer-meta For Fedora Rawhide, run the following: sudo dnf config-manager addrepo --from-repofile=https://download.opensuse.org/repositories/hardware:/razer/Fedora_Rawhide/hardware:razer.repo sudo dnf install openrazer-meta For Fedora 40 (and earlier), run the following: sudo dnf config-manager --add-repo https://openrazer.github.io/hardware:razer.repo sudo dnf install openrazer-meta
name id logo instructions
Mageia
mageia
/img/distros/mageia.svg
Instructions and downloadable builds for Mageia are [available on openSUSE Build Service.](https://software.opensuse.org/download.html?project=hardware%3Arazer&package=openrazer-meta)
name id logo instructions
openSUSE
opensuse
/img/distros/opensuse.svg
Instructions and downloadable builds for openSUSE are [available on openSUSE Build Service.](https://software.opensuse.org/download.html?project=hardware%3Arazer&package=openrazer-meta)
name id logo instructions
Ubuntu / Linux Mint / elementaryOS / Pop!_OS / Zorin OS
ubuntu
/img/distros/ubuntu.svg
Starting with 20.04, OpenRazer is available from the [official repositories](https://packages.ubuntu.com/search?keywords=openrazer). However, you may need to install our package if your device was added in a newer version. elementaryOS users need to install a prerequisite first: sudo apt install software-properties-gtk To install the latest release, add this PPA: sudo add-apt-repository ppa:openrazer/stable Or for latest development builds: sudo add-apt-repository ppa:openrazer/daily After adding the PPA, install the packages: sudo apt update sudo apt install openrazer-meta If you get dependency errors when trying to install the driver packages, please make sure that you have enabled the "universe" repository in **Software & Updates**.
title summary distros
Community Supported
Packaged and supported by the wider community.
name id logo instructions
Alpine Linux
alpine
/img/distros/alpine.svg
Packages are available from the [community repositories](https://pkgs.alpinelinux.org/packages?name=openrazer). doas apk add openrazer openrazer-src The kernel modules are built via [akms](https://github.com/jirutka/akms).
name id logo instructions
Arch Linux / Manjaro
arch
/img/distros/arch.svg
Packages are available from the [official repos](https://archlinux.org/packages/?q=openrazer). sudo pacman -S openrazer-daemon If you need the latest development builds, install [openrazer-meta-git](https://aur.archlinux.org/packages/openrazer-meta-git/) package from the AUR.
name id logo instructions
Gentoo
gentoo
/img/distros/gentoo.svg
An ebuild is available, to install: emerge -av --autounmask sys-apps/openrazer
name id logo instructions
NixOS
nixos
/img/distros/nixos.svg
To enable the OpenRazer module in NixOS, add this snippet to your `configuration.nix`: hardware.openrazer.enable = true; In order to run the openrazer-daemon service, your user needs to be part of the `openrazer` group. hardware.openrazer.users = ["<name>?"]; Rebuild your NixOS configuration: sudo nixos-rebuild switch Alternately, use `nix-shell`: nix-shell -p openrazer-daemon
name id logo instructions
SteamOS
steamos
/img/distros/steamos.svg
While SteamOS is based on Arch Linux, SteamOS is built differently and is more involved. Due to the immutable filesystem, you may need to reinstall OpenRazer after a system update. We can't help you with any issues, but a member of the community aims to keep these instructions up-to-date: <a href="https://daniele.tech/2022/12/how-to-get-openrazer-working-easily-on-steam-deck/" rel="external nofollow">https://daniele.tech/2022/12/how-to-get-openrazer-working-easily-on-steam-deck/</a> <p class="legal">Steam and the Steam logo are trademarks and/or registered trademarks of Valve Corporation in the U.S. and/or other countries.</p>
name id logo instructions
Solus
solus
/img/distros/solus.svg
An eopkg is available, to install: sudo eopkg install openrazer
name id logo instructions
Slackware
slackware
/img/distros/slackware.svg
Packages are available at the following URLs: * <https://www.slackbuilds.org/repository/15.0/system/openrazer-kernel/> * <https://www.slackbuilds.org/repository/15.0/system/openrazer-daemon/> For details on how to install, see the [SlackBuilds.org FAQ](https://www.slackbuilds.org/howto/).
name id logo instructions
Void Linux
voidlinux
/img/distros/voidlinux.svg
intro featured
These projects integrate with OpenRazer:
name url logo technologies
Polychromatic
/img/apps/polychromatic.svg
Python, Qt 6
Tray Applet
name url logo technologies
RazerGenie
/img/logo.svg
Qt 5
name url logo technologies
Snake
/img/apps/snake.png
Java
name url logo technologies
razerCommander
/img/apps/razerCommander.png
GTK
name url logo technologies
razer-cli
fa fa-terminal
Python
label icon url
View Source
fa-brands fa-github
label icon url
Troubleshoot
fa-regular fa-question-circle
label icon url
Issues
fa fa-exclamation-circle
label icon url
Wiki
fa fa-book-open
label icon url
Contributors
fa fa-users
legal credits social
This project is licensed under the [GPLv2](https://github.com/openrazer/openrazer/blob/master/LICENSES/GPL-2.0-or-later.txt). It is <em>not affiliated</em> with [Razer Inc](https://www.razerzone.com/).
Brought to you by [Luca Weiss](https://github.com/z3ntu), plus the help of many [contributors](https://github.com/openrazer/openrazer/graphs/contributors) and testers.
tooltip icon url
@OpenRazer on GitHub
github
tooltip icon url
OpenRazer Telegram Group
telegram
tooltip icon url
@OpenRazer on Mastodon
mastodon
tooltip icon url
#openrazer:matrix.org
/img/social/matrix.svg