diff options
Diffstat (limited to 'keyboards/v60_type_r/readme.md')
| -rw-r--r-- | keyboards/v60_type_r/readme.md | 27 |
1 files changed, 21 insertions, 6 deletions
diff --git a/keyboards/v60_type_r/readme.md b/keyboards/v60_type_r/readme.md index c6be29091..5065ca106 100644 --- a/keyboards/v60_type_r/readme.md +++ b/keyboards/v60_type_r/readme.md @@ -1,19 +1,30 @@ -KBParadise V60 Type R +KBParadise V60 Type R ====================== -Released in 2017, the KBP V60 Type R is KB Paradise's first foray into the world of fully programmable keyboards. It utilizes an atmega32u4, Cherry MX switches, standard layout plate, Cherry style stabilizers, and plastic 60% case. +Released in 2017, the KBP V60 Type R is KB Paradise's first foray into the world of fully programmable keyboards. It utilizes an atmega32u4, Cherry MX switches, standard layout plate, Cherry style stabilizers, and plastic 60% case. The keyboard comes in two flavors: 1. V60 Type R 2. V60 Type R Polestar -The Polestar comes with both in switch and underglow lighting, while the regular Type R has neither. +The Polestar comes with both in switch and underglow lighting, while the regular Type R has neither. -Please note that other variants of the KBP V60 are not fully programmable. +Please note that other variants of the KBP V60 are not fully programmable. -In switch and underglow lighting is currently not supported, but the hex file generated by QMK can still be used for either type r board. +Backlight and RGB Underglow are both supported. -The KB Paradise preferred way of creating the hex file is by using https://tkg.io/, selecting Fantastic60 and then defining your keymap. +To use the backlight and/or RGB underglow: +* Create a new keymap +* Create a rules.mk file in the keymap +* Add RGBLIGHT_ENABLE = yes and/or BACKLIGHT_ENABLE = yes to the rules.mk +* Setup your keymap to your preference. Use [the `vimouse` keymap](keymaps/vimouse/keymap.c) as a starting point +* Some extra keys are defined to allow you to set the red, green and blue values of the underglow directly, rather than using the HSV spectrum. These are RGB_RI, RGB_RD, RGB_GI, RGB_GD, RGB_BI, RGB_BD for increase and decrease of the red, green and blue channels respectively. + +The provided `default` keymap pretty closely matches the default V60 Type R keymap, minus the backlight and underglow control keys. The `vimouse` keymap is completely customised and makes use of many of the possibilities, including mouse keys, backlighting, RGB underglow, etc. + +Note for those customising: The configuration used in the `vimouse` keymap results in about 93% of the available flash being utilised. Keep that in mind if you're adding functionality. + +Note: By default the V60 Type R uses TMK. You should know what you're doing and none of this is guaranteed to work. If you want to stick with the TMK default, then the KB Paradise preferred way of creating the hex file is by using https://tkg.io/, selecting Fantastic60 and then defining your keymap. You will then have to use tkg-toolkit to finish the flashing @@ -25,6 +36,10 @@ Make example for this keyboard (after setting up your build environment): make v60_type_r:default +or + + make v60_type_r:vimouse + See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. |