Skip to content

nivekmai/oryx-build-extension

Repository files navigation

Oryx with custom QMK Build extension

Install in Chrome or Firefox

An extension to easily start runs and access artifacts for your fork of poulainpi's oryx-with-custom-qmk.

This extension adds a bar to the top of ZSA's Oryx which lets you start the "Fetch and build layout" workflow after you've updated your keymap. You can then download the firmware when the run completes. Hopefully without ever having to visit github just to kick off/download builds.

configure zsa io_moonlander_layouts_Eon7Y_latest_0

Usage

Extension is configured via the extensions options page, go to extensions > Oryx Extension > ⋮ > Options.

To get the Github Action URL go to your repository page > Actions > Fetch and build layout and copy the URL.

To get the Personal Access Token you will need to follow the Github Documentation. Make sure the token has access to read and write the Actions scope.

No need to save the page, after these values are entered here, you will see a button on Oryx to Run Github Workflow, which will trigger the workflow to run. These values are stored only in the browser, they are not sync'd to any cloud storage.

Note

If the extension does not correctly figure out your layout_geometry there is an additional option to be able to override the layout_geometry that is used int the Github Workflow.

How it works

The extension uses the Github API and the Oryx URL to drive the Github workflow. When the latest workflow is complete, the API is used to create a download link.

The bulk of the code is in App.tsx, and is almost entirely just attempting to handle various states/latency from the API.

Development

Forked from Jonghakseo/chrome-extension-boilerplate-react-vite. See the boilerplate readme for instructions. tl;dr:

# install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
# set to .nvmrc version
nvm use `cat .nvmrc`
# install pnpm
npm install -g pnpm
# install deps
pnpm install
# build in dev mode
pnpm dev

Then use chrome dev mode to "Load unpacked" and load the dist folder. Boilerplate has HMR so saving should trigger reloads (you'll see Oryx reload if HMR is working).

About

Extension for super-charging ZSA's Oryx

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Contributors 45