maroskucera/moonlander-magic-sturdy-v2
1
0
Fork 0
Code Issues Pull requests Releases Packages Activity
No description
43 commits 2 branches 0 tags 86 KiB
  • C 96.7%
  • Dockerfile 2.1%
  • Makefile 1.2%
Find a file
Exact
Maros Kucera e35ff931e8
Some checks failed
ci/woodpecker/manual/woodpecker Pipeline failed
Details
ci: fix Woodpecker git auth
2026-05-17 14:36:20 +02:00
mXqOx Merge branch 'oryx' 2026-04-14 22:07:14 +02:00
qmk_firmware@f4a95d85c8 ✨(qmk): Update firmware 2026-03-27 20:43:01 +00:00
.gitignore 🔧 add gitignore 2024-09-23 22:23:45 +02:00
.gitmodules ➕ add qmk_firmware submodule 2024-09-23 22:29:31 +02:00
.woodpecker.yml ci: fix Woodpecker git auth 2026-05-17 14:36:20 +02:00
Dockerfile fix: add arm-none-eabi-gcc to Dockerfile for firmware v24 compatibility (#57) 2026-02-01 12:00:24 +01:00
LICENSE.md Create LICENSE.md 2024-12-15 23:21:25 +01:00
README.md ci: require only git push token 2026-05-17 14:24:10 +02:00

README.md

Oryx with custom QMK

This repository allows combining the convenience of Oryx’s graphical layout editing with the power of QMK, allowing you to customize your Oryx layout with advanced QMK features like Achordion and Repeat Key, while automating firmware builds through Woodpecker CI.

For a detailed guide, check out the full blog post here.

How it works

Each time you run the Woodpecker pipeline, the workflow will:

  1. Fetch the latest changes made in Oryx.
  2. Merge them with any QMK features you've added in the source code.
  3. Build the firmware, incorporating modifications from both Oryx and your custom source code.

How to use

  1. Fork this repository (be sure to uncheck the "Copy the main branch only" option).
  2. Configure Woodpecker:
    • Activate the repository in Woodpecker.
    • Add a git_push_token secret so the pipeline can push updates back to oryx and main.
    • If you use git_push_token, the repository owner is used as the HTTPS username.
  3. To initialize the repository with your layout:
    • Open the repository in Woodpecker.
    • Trigger the manual pipeline from .woodpecker.yml.
    • Optionally set LAYOUT_ID and LAYOUT_GEOMETRY parameters. Defaults are mXqOx and moonlander/reva.
    • Your layout must be public in Oryx.
    • To avoid entering values each time, update the defaults in .woodpecker.yml.
  4. A folder containing your layout will be generated at the root of the repository.
  5. You can now add your custom QMK features to this folder:
    • Edit config.h, keymap.c and rules.mk according to the QMK documentation.
    • Commit and push to the main branch.
  6. You can continue editing your layout through Oryx:
    • Make your changes in Oryx.
    • Optionally, add a description of your changes in the Some notes about what you changed field; if provided, this will be used as commit message.
    • Confirm changes by clicking the Compile this layout button.
  7. To build the firmware (including both Oryx and code modifications), rerun the Woodpecker manual pipeline. The firmware is copied to the pipeline workspace under artifacts/.
  8. Flash your downloaded firmware using Keymapp.
  9. Enjoy!

Oryx Chrome extension

To make building even easier, @nivekmai created an Oryx Chrome extension to be able to trigger builds from inside Oryx. The extension targets GitHub Actions, so it does not trigger this Woodpecker pipeline without customization.