rgb-engine

An RGB effect engine for Wooting 60HE (and other keyboards).

Other Wooting keyboards may also work, but expect undefined behaviour since I only have 60HE. Especially with DeltaWatcher! (Analog and reactive effects such as ripple) DeltaWatcher has some hardcoded translation values from scan codes to positions based on my layout. (Please let me know if you know a better solution. Open an issue or something.)

If you want support for another keyboard you'll have to help with creating the layout translations. In the future I might do a more convenient config-based approach to solve the problem, but not right now. I'm kind of done messing with the effects.

One possibility could also be to create it based on your Wooting config which would be really convenient, but I don't know how that would go at all.

Installing

Add the following to your dependencies in Cargo.toml:

rgb-engine = { git = "https://github.com/LuuppiChan/rgb-engine.git" }

Examples

Examples can be found inside examples directory and can be run using the cargo feature cargo run --example [EXAMPLE NAME] replace [EXAMPLE NAME] with the name of the example you want to run.

Simple RGB Wave

Here's also a simple wave example built from ground up (should work on any Wooting keyboard):

You can also find this in the examples. Run it using cargo run --example rgb_wave

use std::time::Duration;

use rgb_engine::{
    Effect,
    keyboard::get_matrix,
    re_exports::{
        nalgebra::Vector2,
        palette::{Hsv, IntoColor, Srgb},
    },
    runtime::{Process, Runtime},
};

fn main() {
    let mut runtime = Runtime::new(false);
    runtime.run(&mut WaveProcess::new(Wave::new(-0.2, 0.4)));
}

struct Wave {
    speed: f64,
    scale: f64,
}

impl Wave {
    fn new(speed: f64, scale: f64) -> Self {
        Self { speed, scale }
    }
}

impl Effect for Wave {
    fn color(&self, time: f64, pos_norm: Vector2<f64>) -> Srgb<f64> {
        let hue = (pos_norm.x * self.scale + time * self.speed).sin() * 360.0;
        Hsv::new(hue, 1.0, 1.0).into_color()
    }
}

struct WaveProcess {
    effect: Wave,
}

impl WaveProcess {
    fn new(effect: Wave) -> Self {
        Self { effect }
    }
}

impl Process for WaveProcess {
    type Owner = Runtime<Self>;

    fn init(&mut self, runtime: &mut Self::Owner) {
        runtime.create_layer(0, get_matrix());
    }

    fn process(&mut self, runtime: &mut Self::Owner, _delta: Duration) {
        let elapsed = runtime.start.elapsed().as_secs_f64();
        for key in runtime.get_layer(0).as_flattened_mut() {
            key.color = self.effect.color(elapsed, key.pos_norm);
        }

        runtime.update_keyboard();
    }
}

Pink Ripple (Ripple doesn't work correctly on other than 60HE)

cargo run --example flappy_bird

Flappy Bird

• Space: Jump
• Esc: Reset/Exit

How to run: cargo run --example flappy_bird

keyboard-flappy-bird.mp4

Info

This is a hobby project and as such I don't currently have any plans on supporting any other keyboards fully since I don't have them ¯\(ツ)/¯. However with a bit of tinkering it could likely be done (And most effects should work on them as of now). But for a first time hobby project this is enough tinkering for me for now.

Also this assumes my custom fn layout if you're going to use any key events. Check my config out: 045a0673980efcf95b5f5b6c959eb63b0f9f

Lastly I'm obligated to mention that I love Rust.