README.md

System 76 Keyboard Color Shifter

Create a floating rainbow effect that moves across your keyboard!

Installation (for debian/pop-os/ubuntu)

1. Download the latest and greatest deb file
2. Install the deb file
3. Configure it sudo nano /etc/keyboard-colors.json
4. Start it up sudo systemctl restart keyboard-colors
5. Profit!

Installation (other distributions)

1. Download the manual.tgz file from the releases
2. Copy the keyboard-colors.service to systemd
3. Copy settings.json to /etc/keyboard-colors.json
4. Copy keyboard-colors to /usr/bin/keyboard-color
5. Start it up sudo systemctl restart keyboard-colors
6. Profit!

Colors for monitor

• Blue: Ice cold (~0)
• Green: Moderate usage
• Yellow: Heavy usage
• Red: Extreme usage

Upgrading

Same as installation, should be smooth.

Contributing

The service is written in CSharp. You can do the following:

1. Create color filters (such as Hearbeat) that can post-process on whatever mode is chosen.
2. Create "sides" that operate on a single Led group independently.
3. Create monitors to operate on a specific input.
4. Keyboards tie everything together into a configuration.

Ideas

1. Change colors based on local weather and a filter for time of day.
2. Use filters to change color if ssh'd into a specific machine (say, production?).
3. Use filters to alert on emails, or other notifications.
4. Make this more pluggable.