Effects Plugin

pipeline status

What is this?

This is a plugin for OpenRGB that provides various effects that can be synced across devices.

Experimental (Master)

• Windows 64
• Linux 64
• Bookworm 64
• MacOS ARM64
• MacOS Intel

Stable (0.9)

• Windows 64
• Linux 64
• MacOS ARM64
• MacOS Intel

You can get older releases here.

How do I install it?

• Download and extract the correct files depending on your system
• Launch OpenRGB
• From the Settings -> Plugins menu, click the "Install plugin" button

Linux

You need libopenal and pipewire installed.

Fedora

You need openal-soft installed.

sudo dnf install openal-soft

OSX

Install openal-soft

brew install openal-soft

What Effects do you have?

├── Ambient
├── AudioParty
├── AudioSine
├── AudioStar
├── AudioSync
├── AudioVisualizer
├── Bloom
├── BouncingBall
├── Breathing
├── BreathingCircle
├── Bubbles
├── ColorWheelEffect
├── Comet
├── CrossingBeams
├── CustomGradientWave
├── CustomMarquee
├── DoubleRotatingRainbow
├── Fill
├── FractalMotion
├── GifPlayer
├── GradientWave
├── Hypnotoad
├── Layers
├── Lightning
├── Marquee
├── Mask
├── Mosaic
├── MotionPoint
├── MotionPoints
├── MovingPanes
├── NoiseMap
├── RadialRainbow
├── Rain
├── RainbowWave
├── RotatingBeam
├── RotatingRainbow
├── Sequence
├── Shaders
├── SmoothBlink
├── SpectrumCycling
├── Spiral
├── Stack
├── StarryNight
├── Sunrise
├── Swap
├── SwirlCircles
├── SwirlCirclesAudio
├── Visor
└── Wavy

SDK support

This plugin is supported by the OpenRGB SDK, see SDK docs for more details.

Common Issues

OpenRGB does not start with the plugin

OpenRGB and EffectsPLugin are under heavy development, make sure to run latest pipeline from both.

My CPU usage is really high

There are a few effects that cause this:

• Audio effects
• Ambient

Both of the audio effects will spike in CPU usage when opening an S/PDIF device for reasons we still don't know. This can be fixed by switching off of the spdif device or stopping the effect.

The very nature of ambient is to do massive calulation to get the average or most common color on screen. Scaling uses a lot of CPU so once you have selected your portion of the screen it is recommended that you hide the preview.

Contributing

Please read the contributing guide if you want to add effects or bring new features.