mirror of
https://github.com/qmk/qmk_userspace.git
synced 2025-11-03 18:30:07 -05:00
remove rgb
This commit is contained in:
Pablo Ontiveros
parent
b88b76d292
commit
76da743115
3 changed files with 103 additions and 53 deletions
102
CLAUDE.md
Normal file
102
CLAUDE.md
Normal file
|
|
@ -0,0 +1,102 @@
|
|||
# CLAUDE.md
|
||||
|
||||
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||
|
||||
## Overview
|
||||
|
||||
This is a QMK userspace repository for custom keyboard keymaps. It contains configurations for multiple keyboards including the Corne (crkbd) and YMDK YMD40 Air40, each with personalized keymaps and features.
|
||||
|
||||
## Build Commands
|
||||
|
||||
### Basic compilation
|
||||
```bash
|
||||
# Compile a specific keymap
|
||||
qmk compile -kb your_keyboard -km your_keymap
|
||||
|
||||
# Using make syntax
|
||||
make your_keyboard:your_keymap
|
||||
|
||||
# Compile all configured userspace targets
|
||||
qmk userspace-compile
|
||||
```
|
||||
|
||||
### Configuration commands
|
||||
```bash
|
||||
# Add a keymap to build targets
|
||||
qmk userspace-add -kb <keyboard> -km <keymap>
|
||||
|
||||
# Remove a keymap from build targets
|
||||
qmk userspace-remove -kb <keyboard> -km <keymap>
|
||||
|
||||
# List current build targets
|
||||
qmk userspace-list
|
||||
|
||||
# Set global userspace path (run from userspace directory)
|
||||
qmk config user.overlay_dir="$(realpath .)"
|
||||
```
|
||||
|
||||
### Current Build Targets
|
||||
Based on `qmk.json`, the currently configured build target is:
|
||||
- `crkbd/rev1:pones`
|
||||
|
||||
## Repository Structure
|
||||
|
||||
### Keyboard Configurations
|
||||
- `keyboards/crkbd/rev1/keymaps/` - Corne keyboard keymaps
|
||||
- `pones/` - Main active keymap with home row mods, layers for symbols/numbers/navigation
|
||||
- `pones-old/` - Previous version keymap
|
||||
- `vial/` - Vial-compatible keymap with visual configuration support
|
||||
- `keyboards/ymdk/ymd40/air40/keymaps/` - YMD40 Air40 keymaps
|
||||
- `pones/` - Current keymap
|
||||
- `pones_old/` - Previous version
|
||||
|
||||
### Key Files
|
||||
- `qmk.json` - Userspace configuration and build targets
|
||||
- `Makefile` - Forwards make commands to QMK firmware with proper userspace path
|
||||
- `*.hex` - Compiled firmware files ready for flashing
|
||||
|
||||
## Keymap Architecture
|
||||
|
||||
The main keymap (`keyboards/crkbd/rev1/keymaps/pones/`) uses a sophisticated layer system:
|
||||
|
||||
### Layers
|
||||
- `_QWERTY` - Base QWERTY layout with home row modifiers
|
||||
- `_NUMBER` - Number pad and arithmetic operators
|
||||
- `_SYMBOL` - Symbol keys and brackets
|
||||
- `_SYMBOL2` - Additional symbols (@, #, $, %, etc.)
|
||||
- `_NAV` - Navigation keys (arrows, page up/down, word movement)
|
||||
- `_DEV` - Development shortcuts (VS Code terminal, debugging, navigation)
|
||||
- `_FUNC` - Function keys (F1-F12)
|
||||
- `_MEDIA` - Media controls and mouse keys
|
||||
- `_UTIL` - RGB lighting controls
|
||||
|
||||
### Home Row Modifiers
|
||||
The keymap implements home row mods for efficient modifier access:
|
||||
- Left hand: GUI(A), Alt(S), Ctrl(D), Shift(F)
|
||||
- Right hand: Shift(J), Ctrl(K), Alt(L), GUI(;)
|
||||
|
||||
### Layer Access
|
||||
Layers are accessed via layer-tap keys on thumbs and specific positions:
|
||||
- Space → Numbers layer
|
||||
- Tab → Symbols layer
|
||||
- Escape → Symbols2 layer
|
||||
- Enter → Development layer
|
||||
- Backspace → Function keys layer
|
||||
- Delete → Media layer
|
||||
- Z → Navigation layer
|
||||
- Quote → Utilities layer
|
||||
|
||||
### Custom Features
|
||||
- OLED display support with layer and modifier status
|
||||
- RGB Matrix with selective animations enabled
|
||||
- Custom macros for development workflows (VS Code shortcuts)
|
||||
- Mouse key integration
|
||||
- Configurable tapping term (220ms)
|
||||
|
||||
## Development Notes
|
||||
|
||||
- The keymap is heavily customized for programming workflows with VS Code shortcuts
|
||||
- Uses split keyboard features extensively (OLED, RGB, etc.)
|
||||
- Master hand is configured as left side
|
||||
- Custom font included for OLED display
|
||||
- RGB animations are selectively enabled to save firmware space
|
||||
|
|
@ -15,55 +15,3 @@
|
|||
# define OLED_TIMEOUT 30000
|
||||
#endif
|
||||
|
||||
#ifdef RGB_MATRIX_ENABLE
|
||||
# define RGB_MATRIX_KEYPRESSES // reacts to keypresses
|
||||
// # define RGB_MATRIX_KEYRELEASES // reacts to keyreleases (instead of keypresses)
|
||||
# define RGB_DISABLE_WHEN_USB_SUSPENDED // turn off effects when suspended
|
||||
# define RGB_MATRIX_FRAMEBUFFER_EFFECTS
|
||||
# define RGB_MATRIX_LED_PROCESS_LIMIT (RGB_MATRIX_LED_COUNT + 4) / 5 // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness)
|
||||
# define RGB_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)
|
||||
# define RGB_MATRIX_MAXIMUM_BRIGHTNESS 150 // limits maximum brightness of LEDs to 150 out of 255. Higher may cause the controller to crash.
|
||||
# define RGB_MATRIX_HUE_STEP 8
|
||||
# define RGB_MATRIX_SAT_STEP 8
|
||||
# define RGB_MATRIX_VAL_STEP 8
|
||||
# define RGB_MATRIX_SPD_STEP 10
|
||||
|
||||
/* Disable the animations you don't want/need. You will need to disable a good number of these *
|
||||
* because they take up a lot of space. Disable until you can successfully compile your firmware. */
|
||||
# undef ENABLE_RGB_MATRIX_ALPHAS_MODS
|
||||
# undef ENABLE_RGB_MATRIX_GRADIENT_UP_DOWN
|
||||
# undef ENABLE_RGB_MATRIX_BREATHING
|
||||
# undef ENABLE_RGB_MATRIX_BAND_SAT
|
||||
# undef ENABLE_RGB_MATRIX_BAND_VAL
|
||||
# undef ENABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
|
||||
# undef ENABLE_RGB_MATRIX_BAND_PINWHEEL_VAL
|
||||
# undef ENABLE_RGB_MATRIX_BAND_SPIRAL_SAT
|
||||
# undef ENABLE_RGB_MATRIX_BAND_SPIRAL_VAL
|
||||
# undef ENABLE_RGB_MATRIX_CYCLE_ALL
|
||||
# undef ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
|
||||
# undef ENABLE_RGB_MATRIX_CYCLE_UP_DOWN
|
||||
# undef ENABLE_RGB_MATRIX_CYCLE_OUT_IN
|
||||
# undef ENABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
|
||||
# define ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
|
||||
# undef ENABLE_RGB_MATRIX_DUAL_BEACON
|
||||
# undef ENABLE_RGB_MATRIX_CYCLE_PINWHEEL
|
||||
# undef ENABLE_RGB_MATRIX_CYCLE_SPIRAL
|
||||
# undef ENABLE_RGB_MATRIX_RAINBOW_BEACON
|
||||
# undef ENABLE_RGB_MATRIX_RAINBOW_PINWHEELS
|
||||
# undef ENABLE_RGB_MATRIX_RAINDROPS
|
||||
# undef ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
|
||||
# undef ENABLE_RGB_MATRIX_TYPING_HEATMAP
|
||||
# define ENABLE_RGB_MATRIX_DIGITAL_RAIN
|
||||
# undef ENABLE_RGB_MATRIX_SOLID_REACTIVE
|
||||
# undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
|
||||
# undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
|
||||
# undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
|
||||
# undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
|
||||
# undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
|
||||
# undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
|
||||
# undef ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
|
||||
# undef ENABLE_RGB_MATRIX_SPLASH
|
||||
# define ENABLE_RGB_MATRIX_MULTISPLASH
|
||||
# undef ENABLE_RGB_MATRIX_SOLID_SPLASH
|
||||
# undef ENABLE_RGB_MATRIX_SOLID_MULTISPLASH
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ CAPS_WORD_ENABLE = no
|
|||
VIA_ENABLE = no
|
||||
DYNAMIC_TAPPING_TERM_ENABLE = yes
|
||||
RGBLIGHT_ENABLE = no
|
||||
RGB_MATRIX_ENABLE = yes
|
||||
RGB_MATRIX_ENABLE = no
|
||||
OLED_ENABLE = yes
|
||||
CONSOLE_ENABLE = no
|
||||
COMMAND_ENABLE = no
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue