OpenRGB Pixel Screen Plugin
Render custom scrolling text, clock, sensors and pixel art on OpenRGB matrices
Description
OpenRGB Pixel Screen Plugin
Render custom scrolling text, clock, hardware sensors and pixel art on OpenRGB matrices.
🛠️ Download
OpenRGB 1.0 and 1.0+ (Plugin API Version 5)
Gitlab
GitHub
OpenRGB 1.0 RC - 1.0 RC3 (Plugin API Version 4)
Gitlab
GitHub
⚙️ Settings
🕔 Time / Clock formats
The configuration accepts standard date/time format tokens like hh:mm:ss aa.
| Format | Description | Example |
| d | Date | 1 |
| dd | Date with leading zero | 01 |
| ddd | Short day name abbreviation (Sun to Sat) | Tue |
| dddd | Complete weekday name (Sunday to Saturday) | Tuesday |
| M | Month | 3 |
| MM | Month with leading zero | 03 |
| MMM | Short month name abbreviation (Jan to Dec) | Mar |
| MMMM | Full month name (January to December) | March |
| yy | 2-digits year | 24 |
| yyyy | full year | 2024 |
| h | 12-hour | 8 |
| hh | 12-hour with leading zero | 08 |
| H | 24-hour | 20 |
| HH | 24-hour with leading zero | 20 |
| m | Minute | 5 |
| mm | Minute with leading zero | 05 |
| s | Second | 3 |
| ss | Second with leading zero | 03 |
| t or a | A/P | P |
| tt or aa | AM/PM | PM |
🍄 Pixel Art
Pixel Art is an Array of ones and zeroes in an Array, One represents light on and Zero represents light off. Each group of Ones and Zeroes is equals to each row on your Matrix.
For example: Dino on my 16x16 Matrix
[
[0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 1, 1, 1, 1, 1],
[0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1],
[0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1],
[0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0],
[1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0],
[1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0],
[1, 1, 1, 0, 0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0],
[0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0],
[0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 0, 0],
[0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 1, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 1, 1, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 1, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
]
Another example: On Air on my 32x8 Matrix
[
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 1, 1, 1, 1, 1, 0, 0, 1, 0, 0, 0, 0, 1, 0.5, 0, 0, 1, 1, 1, 1, 0, 0, 1, 0.5, 0, 1, 1, 1, 1, 1, 1],
[1, 0.5, 0.5, 0.5, 0.5, 0.5, 1, 0, 1, 1, 0, 0, 0, 1, 0.5, 0, 1, 0.5, 0.5, 0.5, 0.5, 1, 0, 1, 0.5, 0, 1, 0.5, 0.5, 0.5, 0.5, 1],
[1, 0.5, 0, 0, 0, 0, 1, 0, 1, 0.5, 1, 0, 0, 1, 0.5, 0, 1, 0.5, 0, 0, 0, 1, 0, 1, 0.5, 0, 1, 0.5, 0, 0, 0, 1],
[1, 0.5, 0, 0, 0, 0, 1, 0, 1, 0.5, 0.5, 1, 0, 1, 0.5, 0, 1, 0.5, 0, 0, 0, 1, 0, 1, 0.5, 0, 1, 1, 1, 1, 1, 1],
[1, 0.5, 0, 0, 0, 0, 1, 0, 1, 0.5, 0, 0.5, 1, 1, 0.5, 0, 1, 1, 1, 1, 1, 1, 0, 1, 0.5, 0, 1, 0.5, 0.5, 0.5, 1, 0],
[0, 1, 1, 1, 1, 1, 0, 0, 1, 0.5, 0, 0, 0.5, 1, 0.5, 0, 1, 0.5, 0, 0, 0, 1, 0, 1, 0.5, 0, 1, 0.5, 0, 0, 0, 1],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
]
I made a simple html page to create pixel art: https://pixelart.nolliergb.com/
⏲ Sensor Data
Requires Libre Hardware Monitor and with Remote Web Server running.
Add your sensors from the Sensor list into Sensor Format, you can combine with normal text and Sensors for example:
CPU: [11th Gen Intel Core i5-11400\Load\CPU Total] [11th Gen Intel Core i5-11400\Temperatures\Core Average]
GPU: [NVIDIA GeForce GTX 1660 SUPER\Load\GPU Core] [NVIDIA GeForce GTX 1660 SUPER\Temperatures\GPU Core]
🔨 Build yourself
This repository contains two plugin variants, each built against a different OpenRGB plugin API:
API5/— for OpenRGB 0.9+ / Pipeline / Next (Plugin API 5)API4/— for OpenRGB 1.0 RC / older builds (Plugin API 4)
Use the matching folder for the OpenRGB version you plan to run.
Prerequisites
Before building, install:
- Git
- A Qt development environment with
qmake - A C++17-capable compiler
- The OpenRGB source code included in this repo under each API folder (
API4/OpenRGBorAPI5/OpenRGB)
Recommended Qt versions:
- OpenRGB 0.9+ / API 5: Qt 6.8.x
- OpenRGB 1.0 RC / API 4: Qt 5.15.x
Windows
- Install Qt with the MSVC toolchain and
qmake - Install the Visual Studio C++ build tools or a compatible compiler
- Open a Qt-enabled shell (for example, Qt 6 x64 Native Tools Command Prompt or Qt Creator)
Linux
Install the usual Qt build dependencies, for example:
Debian/Ubuntu:
sudo apt install git build-essential qtcreator qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools libusb-1.0-0-dev libhidapi-dev pkgconf libmbedtls-dev qttools5-dev-toolsFedora:
sudo dnf install automake gcc-c++ git hidapi-devel libusbx-devel mbedtls-devel pkgconf qt5-qtbase-devel qt5-linguist
For Qt 6-based builds, use the matching Qt 6 development packages instead of the Qt 5 ones.
Build with Qt Creator (recommended)
- Clone the repo with submodules:
git clone --recurse-submodules https://github.com/qiangqiang101/OpenRGBPixelScreenPlugin.git - Open the matching project file in Qt Creator:
API5/PixelScreenPlugin.pro- or
API4/PixelScreenPlugin.pro
- Select the correct Qt kit and compiler for your target.
- Run
qmakeand then build the project. - The plugin output will be generated in the build output directory for that kit.
Build from the command line
API 5 build example
cd API5
qmake PixelScreenPlugin.pro
make -j$(nproc)
API 4 build example
cd API4
qmake PixelScreenPlugin.pro
make -j$(nproc)
Windows (MSVC)
cd API5
qmake PixelScreenPlugin.pro
nmake
or:
cd API4
qmake PixelScreenPlugin.pro
nmake
Install / use the plugin
After building, copy the generated plugin library into your OpenRGB plugins directory or use the plugin manager in OpenRGB to load it.
For Linux, the project is set up for installation into a standard OpenRGB plugin path when using make install with an appropriate PREFIX value:
make install PREFIX=/usr
On Windows, the plugin is typically loaded from the build output folder or copied into the OpenRGB plugin directory used by your installed OpenRGB build.
Notes
- The project files automatically generate metadata such as version info and API version at build time.
- The plugin source uses the bundled OpenRGB SDK in the
OpenRGB/folder inside each API directory, so you should build the matching API folder for the OpenRGB version you want to target. - If you are unsure which API to use, choose
API5for newer OpenRGB builds andAPI4for older/RC builds.
Prerequisites
Releases & Changelogs 1
Download (11 files)
- Fixed API5 startup deadlock
- Fixed API5 live editing deadlock
OpenRGB 1.0 download API5
OpenRGB 1.0 RC1-RC3 download API4
Details
Comments 0
No comments yet. Be the first!
Add a YouTube video
Made a showcase or tutorial for this mod? Send the link. It appears in the gallery once it has been approved.
More in OpenRGB