Self-contained mini tutorial for defining custom layouts?

I received my Model 01 last week and would like to start making some minor modifications to the default layout. However, I’m a little lost as to where I can find the relevant documentation. I certainly found some useful bits here and there but there are still quite a few open questions left. I think it would be useful to have a more or less self-contained tutorial to help people getting started. For example, I think it would be useful to have a document showing how to redefine the butterfly key. Once you know how to do this, it should be relatively easy to dive in to more complex stuff. Does something like this already exist somewhere?

1 Like

there is this information located on the kaleidoscope (keyboard firmware) github wiki it should take you through intsalling the arduino environment so you can build your own custom firmware.

once you have arduino setup you can edit the keymaps here is a wiki page outlining the steps to do that

my understanding is that compiling custom firmware is currently the only way to edit keymaps and that a method to do so without compiling and flashing firmware is coming later but I don’t have any idea on the ETA of that.

Remapping keys? there is also this post by @jesse which outlines the process and where he offers to do the firmware changes for you if you don’t want to do it yourself.


Thanks for speaking up! Where could we put information about how to configure your Model 01 that would have been more obvious and easy to find?

I appreciate @Kipples responding quickly and thoroughly, but would rather have the information in obvious places so you would not have needed to ask. :slight_smile:

1 Like

Thanks you, @Kipples, this is precisely the kind of information I was looking for. But I agree with @Jennigma, it would definitely be good to have this in a more salient place. Perhaps it would be enough to link to in the of the firmware repository (

1 Like

Ooops, I thought we had done that. I’ll figure that out shortly.

Was there anywhere “obvious” on the forums that you checked before asking?

Also, please give feedback on the docs themselves if there are ways they could be improved. They are very much a work in progress. :slight_smile:

These documents look great, but yes, if I get stuck somewhere, I will report back.

Re forum: I tried some searches and browsing around but did’t find a link to the wiki doc Edit-A-Keymap.

I submitted an update to the Readme:

I’m going to look at the forum interface and see what I can do to make the getting started process more obvious.

Perhaps we should have a pinned topic in “Help & Getting Started” containing links to docs & tutorials.


done. Thanks for the suggestion!

1 Like