Removal of user keymaps from QMK

[manna-harbour]

QMK have introduced a breaking change that removes user keymaps, including Miryoku QMK. See the announcement for details.

As a result, Miyoku QMK is not longer present in QMK master, and references to QMK master in the Miryoku QMK documentation are now out of date. In particular, Miryoku QMK can't be built directly from QMK master, and the miryoku branch can no longer be merged with QMK master. Miryoku QMK can still be built directly from the miryoku branch, where a more recent version of QMK is not required.

As a temporary work around, the last commit still containing user keymaps in QMK can be used as a substitute for QMK master. That commit is at tag user-keymaps-still-present, and has been made available as a branch for merging at https://github.com/manna-harbour/qmk_firmware/tree/user-keymaps-still-present. That branch can be used in place of QMK master in the Miryoku QMK documentation to build from directly, or merge with Miryoku QMK, if a more recent version of QMK than is present in the miryoku branch is required. For merging using workflow builds, use manna-harbour/qmk_firmware/user-keymaps-still-present with the workflow merge option.

To update for changes introduced to QMK after that commit, such as new keyboards, files will need to be copied manually between branches. To add Miryoku QMK to QMK, copy the contents of https://github.com/manna-harbour/miryoku_qmk/tree/miryoku/users/manna-harbour_miryoku plus the required keyboard (e.g. https://github.com/manna-harbour/miryoku_qmk/tree/miryoku/keyboards/a_dux/keymaps/manna-harbour_miryoku) or community layout (e.g. https://github.com/manna-harbour/miryoku_qmk/tree/miryoku/layouts/community/split_3x5_3/manna-harbour_miryoku) keymaps from your Miryoku QMK clone to the corresponding locations in your QMK clone. To add individual keyboard support from QMK to Miryoku QMK, copy the required keyboard directory from your QMK clone to the corresponding directory in your Miryoku QMK clone.

In future, Miryoku QMK will be updated to use the new user keymap overlay feature "External QMK Userspace" instead of being a QMK fork.

@drashna has made a copy of Miryoku QMK adapted for this feature as a proof-of-concept, available at https://github.com/drashna/qmk_userspace/tree/miryoku. This can be used now for testing, but won't be updated and isn't supported.

[rvannoord]

Has Miryoku QMK already been updated to use the new user keymap overlay feature "External QMK Userspace"?
I've been trying to find answers to this in your repo but no luck (probably my lack of understanding).

[manna-harbour]

It will be announced here when it's updated, so subscribe to this discussion for notifications. For now, see the work arounds above.

[sk8ersteve]

I'm interested in this feature. My keyboard is supported in the main qmk repo but hasn't been added here yet. I was considering submitting a PR but it seems the right way to get this support is by migrating to the new user_space way of doing things.

What work is required to push this forward?

[manna-harbour]

I'm interested in this feature. My keyboard is supported in the main qmk repo but hasn't been added here yet. I was considering submitting a PR but it seems the right way to get this support is by migrating to the new user_space way of doing things.

Yes, keyboard definitions won't be added to the miryoku branch. For now, see the work arounds above.

What work is required to push this forward?

A new repo needs to be created based on the "userspace" feature. See above for a proof-of-concept example that you could try using now. Ideally the history of the various historical miryoku feature branches would be included, but that might end up in a separate repo. Then the custom workflows need to be adapted.

[winmillwill]

Just a note for some issues I encountered: (EDIT: was trying to compile for a newer board added after userspace removal)

• needed to apply this fix to drashna's userspace example: https://docs.qmk.fm/ChangeLog/20240825#key-override-keymap-c-signature-change-24120
• could not just copy new keyboard files to pre-removal qmk because it locates by looking for rules.mk and my board doesn't have that file and generating it using the hidden qmk command left some data structure unpopulated and made the qmk cli error out

What ultimately let me compile was following the hardware support steps here #85 in drashna's miryoku branch (not tag, checking out the branch is annoying but doable with git switch -c miryoku --track origin/miryoku) together with the key_overrides change above.

[manna-harbour]

To build with current QMK also see #361.

[rvannoord]

Cool! So does that mean we won’t really need the user-keymaps-still-present branch anymore?

[manna-harbour]

@rvannoord This is only if you're copying Miryoku into current QMK master.