siriusfox/qmk_userspace
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat: Add sunaku bilateral combinations

Browse source 
See https://sunaku.github.io/home-row-mods.html
Needs to be compiled with a compatible QMK version, like the one
available here: https://github.com/Tyosa/qmk_firmware
This commit is contained in:
Maël Villerbu 2024-03-27 20:31:04 +01:00
parent af7dc2d307
commit 53d635ec40
4 changed files with 18 additions and 66 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/build_binaries.yaml vendored
View file

@ -10,7 +10,7 @@ jobs:
name: 'QMK Userspace Build'
uses: qmk/.github/.github/workflows/qmk_userspace_build.yml@main
with:
qmk_repo: qmk/qmk_firmware
qmk_repo: Tyosa/qmk_firmware
qmk_ref: master
publish:

56
README.md
View file

@ -1,58 +1,4 @@
# QMK Userspace
This is a template repository which allows for an external set of QMK keymaps to be defined and compiled. This is useful for users who want to maintain their own keymaps without having to fork the main QMK repository.
This is my personal userspace for QMK. The keyboard I am currently using is a Kyria Rev 3, with a Colemak-DH layout with heavy [Miryoku](https://github.com/manna-harbour/miryoku) inspiration.
## Howto configure your build targets
1. Run the normal `qmk setup` procedure if you haven't already done so -- see [QMK Docs](https://docs.qmk.fm/#/newbs) for details.
1. Fork this repository
1. Clone your fork to your local machine
1. Add a new keymap for your board using `qmk new-keymap`
* This will create a new keymap in the `keyboards` directory, in the same location that would normally be used in the main QMK repository. For example, if you wanted to add a keymap for the Planck, it will be created in `keyboards/planck/keymaps/<your keymap name>`
* You can also create a new keymap using `qmk new-keymap -kb <your_keyboard> -km <your_keymap>`
* Alternatively, add your keymap manually by placing it in the location specified above.
* `layouts/<layout name>/<your keymap name>/keymap.*` is also supported if you prefer the layout system
1. Add your keymap(s) to the build by running `qmk userspace-add -kb <your_keyboard> -km <your_keymap>`
* This will automatically update your `qmk.json` file
* Corresponding `qmk userspace-remove -kb <your_keyboard> -km <your_keymap>` will delete it
* Listing the build targets can be done with with `qmk userspace-list`
1. Commit your changes
## Howto build with GitHub
1. In the GitHub Actions tab, enable workflows
1. Push your changes above to your forked GitHub repository
1. Look at the GitHub Actions for a new actions run
1. Wait for the actions run to complete
1. Inspect the Releases tab on your repository for the latest firmware build
## Howto build locally
1. Run the normal `qmk setup` procedure if you haven't already done so -- see [QMK Docs](https://docs.qmk.fm/#/newbs) for details.
1. Fork this repository
1. Clone your fork to your local machine
1. `cd` into this repository's clone directory
1. Set global userspace path: `qmk config user.overlay_dir="$(realpath .)"` -- you MUST be located in the cloned userspace location for this to work correctly
* This will be automatically detected if you've `cd`ed into your userspace repository, but the above makes your userspace available regardless of your shell location.
1. Compile normally: `qmk compile -kb your_keyboard -km your_keymap` or `make your_keyboard:your_keymap`
Alternatively, if you configured your build targets above, you can use `qmk userspace-compile` to build all of your userspace targets at once.
## Extra info
If you wish to point GitHub actions to a different repository, a different branch, or even a different keymap name, you can modify `.github/workflows/build_binaries.yml` to suit your needs.
To override the `build` job, you can change the following parameters to use a different QMK repository or branch:
```
with:
qmk_repo: qmk/qmk_firmware
qmk_ref: master
```
If you wish to manually manage `qmk_firmware` using git within the userspace repository, you can add `qmk_firmware` as a submodule in the userspace directory instead. GitHub Actions will automatically use the submodule at the pinned revision if it exists, otherwise it will use the default latest revision of `qmk_firmware` from the main repository.
This can also be used to control which fork is used, though only upstream `qmk_firmware` will have support for external userspace until other manufacturers update their forks.
1. (First time only) `git submodule add https://github.com/qmk/qmk_firmware.git`
1. (To update) `git submodule update --init --recursive`
1. Commit your changes to your userspace repository

12
keyboards/splitkb/kyria/keymaps/tyosa/config.h
View file

@ -20,13 +20,19 @@
#define SPLIT_ACTIVITY_ENABLE
#define TAPPING_TERM 180
#define QUICK_TAP_TERM 0
#define PERMISSIVE_HOLD
#define TAPPING_TERM_PER_KEY
#define SPLIT_TRANSACTION_IDS_USER USER_SYNC_LUNA
#define SPLIT_LED_STATE_ENABLE
// Bilateral combinations, following https://sunaku.github.io/home-row-mods.html
#define BILATERAL_COMBINATIONS
#define BILATERAL_COMBINATIONS_ALLOW_SAMESIDED_AFTER 500 /*ms*/
#define BILATERAL_COMBINATIONS_ALLOW_CROSSOVER_AFTER 75 /*ms*/
#define BILATERAL_COMBINATIONS_DELAY_MODS_THAT_MATCH (MOD_MASK_GUI) /*Delay GUI HRM*/
#define BILATERAL_COMBINATIONS_DELAY_MATCHED_MODS_BY 120 /* ms */
#define BILATERAL_COMBINATIONS_TYPING_STREAK_TIMEOUT 160
#define BILATERAL_COMBINATIONS_TYPING_STREAK_MODMASK (~MOD_MASK_SHIFT)
// Space optimizations
#define LAYER_STATE_8BIT

14
keyboards/splitkb/kyria/keymaps/tyosa/rules.mk
View file

@ -1,22 +1,22 @@
BOOTLOADER=caterina
OLED_ENABLE = yes
ENCODER_ENABLE = yes # Enables the use of one or more encoders
ENCODER_ENABLE = yes
EXTRAFLAGS += -flto
MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
LTO_ENABLE = yes
WPM_ENABLE = yes
TAP_DANCE_ENABLE = yes
REPEAT_KEY_ENABLE = yes
DEFERRED_EXEC_ENABLE = yes
# AVR optimizations
RGB_MATRIX_ENABLE = no # Disable keyboard RGB matrix, as it is enabled by default on rev3
RGB_MATRIX_ENABLE = no
CONSOLE_ENABLE = no
SPACE_CADET_ENABLE = no
GRAVE_ESC_ENABLE = no
MAGIC_ENABLE = no
RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
UNICODE_ENABLE = no# Unicode
COMMAND_ENABLE = no # Commands for debug and configuration
RGBLIGHT_ENABLE = no
UNICODE_ENABLE = no
COMMAND_ENABLE = no
LEADER_ENABLE = no
MUSIC_ENABLE = no