This repository provides the official ZMK firmware for the "MIAOMIAO" hardware variant of the Crosses/Bridges split keyboard. It features native ZMK Studio support for real-time remapping and optimized wireless performance.
- For the wireless 3x5 layout dual-trackball version, use this library: zmk-for-crosses35-dual
- For the wireless 3x6 layout dual-trackball version, use this library: zmk-for-crosses36-dual
- For the wireless 4x6 layout dual-trackball version, use this library: zmk-for-crosses46-dual
This layout diagram is automatically generated and updated via GitHub Actions whenever changes are committed to the .keymap file.
Modify your keymap on the fly without re-flashing, leveraging the official ZMK Studio protocol. All changes take effect instantly.
- How to Use: Open and connect to ZMK Studio using a compatible Chromium-based browser (e.g., Chrome or Edge), or use the standalone desktop client.
- Core Advantage: Instant Communication. Interacts directly with the hardware via USB (WebHID) or Web Bluetooth. This eliminates the need to wait for GitHub Actions to compile or to manually flash firmware, making it perfect for quick, daily adjustments to basic key assignments.
The most mature visual web editor in the community, deeply integrated with your GitHub workflow. It is ideal for comprehensive overhauls of your keyboard layout architecture.
- How to Use: Fork this repository and run the initial firmware compilation under the GitHub Actions tab. Then, log into Keymap Editor, authorize access, and select your
zmk-for-crossesrepository. - Core Advantage: All-inclusive Editing. Drag and drop to modify keymaps in an intuitive graphical interface with full support for Combos, Macros, and advanced ZMK Behaviors. Saving your changes automatically commits the code to GitHub and triggers a cloud build.
📌 Flashing Notice:
- Flashing Required: You only need to perform the flashing process below when modifying layouts via Keymap Editor, directly editing the repository source code, or performing the initial setup on a new keyboard.
- No Flashing Required: If you are using ZMK Studio for real-time keymap adjustments, changes are saved directly to the hardware's onboard flash memory. You can bypass this guide completely.
- Firmware Compilation: Saving changes in Keymap Editor or pushing code commits will automatically trigger a GitHub Actions build. Navigate to the Actions tab of your repository to check the latest build status.
- Download Firmware: Once the build finishes successfully, scroll down to the Artifacts section at the bottom of the build page and download
firmware.zip. - Extract Files: Unzip the archive to retrieve the
left.uf2andright.uf2firmware files for the respective halves of the keyboard. - Trigger Bootloader: Connect one half of the keyboard to your PC via a USB cable. Double-tap the hardware Reset button on the controller to enter bootloader mode (the device will mount to your computer as a virtual mass storage drive).
- Flash the Drive: Drag and drop the corresponding
.uf2file into the virtual drive. The microcontroller will automatically flash the firmware, reboot, and unmount itself.
⚠️ Note: The microcontrollers for the left and right halves operate independently. You must connect and flash each half individually via USB.
- Documentation Note: This documentation was drafted with AI assistance and thoroughly reviewed/refined by the author to guarantee technical accuracy. We apologize for any minor linguistic nuances or awkward phrasing resulting from automation.
- Technical Support: If you are using a Crosses/Bridges split keyboard and encounter any issues regarding firmware usage, graphical configuration, or flashing, please feel free to reach out to the author through these channels:
- 📩 Gmail:
heetuic@gmail.com - 🐟 Xianyu (闲鱼): Search for user "喵喵喵猫"
- 📩 Gmail: