Skip to content

Latest commit

 

History

History
77 lines (50 loc) · 3.09 KB

README.md

File metadata and controls

77 lines (50 loc) · 3.09 KB

Bazecor

Bazecor screenshot

About

Bazecor is the graphical configurator for the Dygma Raise & Defy. While still heavily under development, it's at a stage where it is already usable.

The primary purpose of the application is to allow one to configure their keyboard without having to compile or flash firmware, by storing the configuration on the keyboard itself, in EEPROM. There are no external tools required, just Bazecor itself.

Features

  • Layout editor to edit the keymap on-the-fly, with the ability to copy one layer to another, and to set a default one.
  • Macro editor to create and manage macros for the keyboard, it also allows you to backup a single macro or all of them, so you can share them with more Raise users or just back them up.
  • Colormap editor to edit the per-key and underglow LED colormap.
  • Firmware upgrade to upload new versions of the firmware that ships with the application.

Supported operating systems

Bazecor is supported on all three major operating systems, we test our releases on Windows 10, MacOS, and Ubuntu LTS.

The protocol Bazecor uses to communicate with the keyboard requires USB serial support, which is known to be problematic on Windows prior to Windows 10.

Reporting issues

Bazecor is beta quality software. There will be bugs, missing features and non-obvious things. Reporting any and all of these help us make the software better, please feel free to open issues liberally!

Development

To launch the development environment, simply install nodejs and yarn (check node version in package.json engine.node) then type yarn && yarn start.

To do a local production build without signing the executable use yarn run make-dev.

To do a production build, use yarn run make, or limit it to a particular OS:

OS Architecture Command
Windows yarn run make-win
macOS yarn run make-mac
macOS x64 yarn run make-mac-intel
macOS arm64 yarn run make-mac-arm
Linux yarn run make-lin

See the scripts section of package.json for more scripts.

Development on Windows

If you are using Windows, you will need node-gyp and python3:

# install python3 using winget
# note that python 3.12 doesn't work
winget install python.python.3.10.0

# install node-gyp
npm install -g node-gyp

If you are using WSL (with ubuntu), you will also need libudev-dev:

sudo apt-get install libudev-dev

Additional Information

To get more information about our efforts, how Bazecor communicates with the Raise and the latest development news, please check the links below