Vim-iCUE

Vim-iCUE is a vim and neovim plugin that links your Corsair RGB keyboard with to vim/neovim! Make your experience better with keyboard RGB themes that change automatically as you pass from Insert to Normal to Command mode.

WARNING!

ARCHIVE: I'm not willing to continue the development of this project anymore since I'm fully switched to linux since the release of this plugin. I'm therefore archiving this project.

UPDATE: I'm currently working on a new project that uses OpenRGB instead of iCUE for better integration. I will make the repo public as soon as a working version is available.

At the moment, I'm testing Vim-iCUE on my own keyboard which is a Corsair Strafe and only supports red color.

Vim-iCUE is only tested on Windows 10. It should work with any Windows or MacOS version that supports iCUE, but I'm not sure about that. Let me know if it works visiting me on the official NDD Discord server.

Unfortunatly, it will not work on Linux, as iCUE is still not supported yet.

DISCLAIMER!

This IS NOT an OFFICIAL Corsair project. I'm not responsible for any damage to your Corsair device as this code comes with no warranty.

DEMO

Installation

Requirements

• iCUE
• Neovim or Vim
• Python >= 3.10 (maybe 3.7 is enough)
• A Corsair keyboard

Plugging-in

Using Vim-plug:

call plug#begin()
" ... other plugins, if any
Plug 'begbaj/vim-icue'
" .. other plugins, if any
call plug#end()

Now you're ready to go! Vim-iCUE will automatically start after installation is complete.

Themes

By default, Vim-iCUE uses the begbaj-default-red theme. To change theme just edit your init.vim as follows:

let g:vimicue_theme_name = '<theme-name>'

To use a theme you either need to create one or download one.

Create a new theme

• Windows users: open ~/AppData/Local/nvim/plugged/vim-icue/themes and create a json file named as your theme.

• MacOS users: open ~/.vim/plugged/vim-icue/themes and create a json file named as your theme.

How to write a theme

You have to define the behavior of each single key's LED. All the other keys will take on the color defined by the 'default' keyname.

Here's an example of a theme:

example.json:

{
  "normal":{
      "K_Escape": [255,255,255],
      "default": [255,0,0]
   },
   "insert":
   {
      "letters": [0,0,255],
      "numbers": [0,255,0]
   }
   "groupings":
   {
      "letters":[ "K_Q", "K_W", "K_E", "K_R", "K_T", "K_Y", "K_U", "K_I", "K_O", "K_P", "K_A", "K_S", "K_D", "K_F", "K_G",
                  "K_H", "K_J", "K_K", "K_L", "K_Z", "K_X", "K_C", "K_V", "K_B", "K_N", "K_M"],
      "numbers": ["K_1", "K_2", "K_3", "K_4", "K_5", "K_6", "K_7", "K_8", "K_9", "K_0"],
      "function_keys": ["K_F1","K_F2","K_F3","K_F4","K_F5","K_F6","K_F7","K_F8","K_F9","K_F10","K_F11","K_F12"]
   },
   "default":{
      "K_Escape": [255,0,0]
      "default":[255,255,255]
   }
}

behavior:

1. normal mode: Esc will be white and all other keys will be red.
2. insert mode: Esc will be red, all keys in letters group will be blue while those in numbers will be green and all other keys will be white.
3. Other modes: Esc will be red and all other keys will be white.

Entries

Each entry should be in this format:

RGB entries:

{"keyname" : [R, G, B]}

Non-RGB entries:

{"keyname": [0,Brightness]}

Where:

• Keyname is a String value that identifies the key.
• [R,G,B] and [0, Brightness] are lists of 3 and 2 integer values from 0 to 255.

Keyname examples:

Keyname for H: K_H
Keyname for J: K_J
Keyname for K: K_K
Keyname for L: K_L
and so on...

Here is a List of all Keyname values.

Modes

Neovim provides a ton of different modes, and each mode is usually identified by a char sequence:

{
  "c"  : "command",
  "i"  : "insert",
  "ic" : "insert_compl",
  "ix" : "insert_compl",
  "multi" : "multi",
  "n"  : "normal",
  "ni" : "insert",
  "no" : "op_pending",
  "R"  : "replace",
  "Rv" : "v_replace",
  "s"  : "select",
  "S"  : "s_line",
  "t"  : "terminal",
  "v"  : "visual",
  "V"  : "v_line"
}

Note: Map is inspired to vim-airline Dictonary values correspond to available theme modes.

References

• CUE SDK Docs

TODO:

• Faster layout update
• Keyname grouping (like: numbers, letters, ...)
• Command tree integration
• Keyboard effects
• Mouse support