Request for new keyboard support

[cfwh]

I've recently finished my setting up ZMK for my keyboard, the OTG, and would like to try it out using Miryoku too. How would I get my shield added to Miryoku ZMK?

[manna-harbour]

The process of adding support for new keyboards isn't documented, but if you'd like to do it yourself there are plenty of examples in the commit history. Otherwise I'm happy to do it.

[cfwh]

Thanks. I don't think I'll be touching local builds, I barely got through Actions

[manna-harbour]

Ok, here's a sample build. Let me know if it seems ok and I'll push the changes.
miryoku_zmk-OTG-nice_nano_v2.zip

[cfwh]

Everything seems to work except undo and redo, the toggle stuff on the media layer because I don't know what it does, mouse because it shouldn't, the rgb stuff on the media layer because I don't have RGB, and i'll test the layer locks and bootloader when I get back

[manna-harbour]

If the keys are in the right places then everything else should be fine.

[cfwh]

Oh excellent. I figured out the toggle stuff and the bootloader works but I still can't get undo and redo to work and am not entirely sure how the layer locks work

[manna-harbour]

ZMK keyboard names seem to be all lowercase, so you may want to rename file name and contents.

[cfwh]

Is this a standardisation thing?

[manna-harbour]

It doesn't matter for Miryoku ZMK, and if it works I can add it as-is. But if you want to PR to ZMK, or fit in with their eventual out-of-tree metadata directory, then you'll need to meet their standards. The convention seems to be lowercase alphanumeric plus underscore only. I don't see it covered in the ZMK docs, so you might like to ask ZMK.

[cfwh]

Convention! That was the word I was looking for. What benefits are there to PR-ing to ZMK or fitting with their eventual out-of-tree metadata directory (whatever that means)?

[manna-harbour]

Probably none in practice, as ZMK tend to discourage PRs, and there's no firm plans yet for the directory. It's more a general issue of going with convention, and potentially avoiding compatibility issues in future.

[cfwh]

hey sorry it took so long but I've lowercased everything and it works!

[manna-harbour]

Added in manna-harbour/miryoku_zmk@d43e5dd. Here's a sample build run: https://github.com/manna-harbour/miryoku_zmk/actions/runs/6172043351.