keyboards/crkbd/keymaps/kidbrazil/README.md

   1 # KidBrazil's custom CRKBD Layout
   2
   3 ![Crkbd](https://user-images.githubusercontent.com/736191/40575636-6fba63a4-6123-11e8-9ca0-3f990f1f9f4c.jpg)
   4
   5 This is a simple layout that I use for both programming and gaming. It is very
   6 closely based on the original CRKBD layout with some modifications to the
   7 position of CTRL and SHIFT.
   8
   9 ## Layers
  10 This keymap includes a total of 4 Layers:
  11 - QWERTY
  12 - NUMBERS
  13 - SYMBOLS
  14 - GAMING
  15 - WEAPONS
  16
  17 The first three layers are pretty self explanatory and follow closely the
  18 default keymap for this keyboard. The magic really starts to happen with the
  19 gaming layer.
  20
  21 ### Gaming Layer
  22 The gaming layer can be toggled on/off from the SYMBOLS layer. Once on the
  23 gaming layer it will stay there until you toggle it off again. The gaming layer
  24 includes normal WASD and most of the keys FPS games use on the left hand. On the
  25 right hand we have F1-F12 and a few other special keys for games that require
  26 it.
  27
  28 ### Weapon
  29 The weapon layer is a momentary layer that can only be reached from the gaming
  30 layer. This layer preserves the left hand almost unchanged, except for when the
  31 layer is activated the top row becomes NUM 1 - 6 for wepon selection. The right
  32 hand is KC_TRNS the whole way so basically it is still the gaming layer.
  33
  34 ## Custom Font
  35 This keymap includes a custom font for my LooseTransistor logo. It is fine if
  36 you want to use it I certainly don't mind but if you want your own, just replace
  37 the glcdfont file here and you should be fine.
  38
  39 Alternatively you could remove the font config line from the config.h file so it
  40 will use the default QMK one.
  41
  42 ## OLED
  43 This Keymap is setup to use the newer OLED API. Some work has been done to
  44 customize this with showing layer and USB information. I also tried my best to
  45 get a dormant / sleep state going but it is hit or miss and often only works on
  46 the master hand.
  47
  48 ### TODO
  49 - Fix OLED and Backlight so they turn off when the computer sleeps, currently
  50   only the left hand does that and the LEDs still stay on.
  51 - Wait for Spit_common to be implemented in CRKBD and revisit the special color
  52   layers and animations