readme.md (1745B)
1 # Voyager 2 3 A next-gen split, ergonomic keyboard with an active left side, USB type C, and low profile switches. 4 5 * Keyboard Maintainer: [drashna](https://github.com/drashna), [ZSA](https://github.com/zsa/) 6 * Hardware Supported: Voyager (STM32F303xC) 7 * Hardware Availability: [ZSA Store](https://zsa.io/voyager/) 8 9 Make example for this keyboard (after setting up your build environment): 10 11 make zsa/voyager:default 12 13 Flashing example for this keyboard: 14 15 make zsa/voyager:default:flash 16 17 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). 18 19 20 ## Voyager Customization 21 22 ### Indicator LEDs 23 24 There are 4 functions for enabling and disabling the LEDs on the top of the boards. The functions are `STATUS_LED_1(bool)` through `STATUS_LED_4(bool)`, with the first LED being the top most LED on the left hand, and the fourth LED being the bottom most LED on the right side. 25 26 By default, the Indicator LEDs are used to indicate the layer state for the keyboard. If you wish to change this (and indicate caps/num/scroll lock status instead), then define `VOYAGER_USER_LEDS` in your `config.h` file. 27 28 ### Detecting split / Gaming mode 29 30 To make it extra gaming friendly, you can configure what happens when you disconnect the right half. This is especially useful when using gaming unfriendly layers or layouts (e.g. home row mods, dvorak, colemak). 31 32 Example for enabling a specific layer while right side is disconnected: 33 34 ```c 35 void housekeeping_task_user(void) { 36 if (!is_transport_connected()) { 37 // set layer 38 } 39 } 40 ```