Repository files navigation

Wally is no longer maintained, instead please use our new flashing toolKeymapp

Flash yourZSA Keyboard the EZ way.

ℹ️ Windows users:There's a new version of Wally rewritten from the ground up using native technologies.

ErgoDox EZ users:Teensy Loader will still work for flashing your ErgoDox EZ (as will Wally — you've got options!).

⚠️ Warning starting from firmware v19, Wally needs to be updated to v2.1.0 in order to detect your keyboard.

Wally comes in two flavors, a GUI and a CLI app.Download the application for your favorite platform from the relevant release page:GUI /CLI.

Note for Linux users, make sure your udev rules match the latest versionfrom the wiki.

Note for Mac OS users, the CLI requires libusb to be installed:brew install libusb

The following instructions apply only to those who wish to activelydevelop Wally and contribute new features or bugfixes to this open-source project. If you simply want to flash your board with some fresh firmware, see above.

Wally is built usingWails at its core andPreact for the UI. This guide assumes you have a saneWails environment setup.

Wally is compatible with Windows, Linux, and macOS. Developing using each platform requires some extra setup:

1. InstallWails
2. Setup pkg-config - seehttp://www.mingw.org/wiki/FAQ "How do I get pkg-config installed?"
3. Grab and install the latest version of libusbfrom here
4. At the root of the project runwails build, the resulting binary will be available in thebuild folder.

The easiest way to compile locally is to use Docker:

Run./build.linux.sh, the resulting binary will be available in thedist/linux64 directory.

An alternative method:

1. Follow the instructions from ourwiki page.
2. InstallWails
3. At the root of the project runwails build, the resulting binary will be available in thebuild folder.

1. Install libusb usingbrew:

brew install libusb

2. InstallWails
3. At the root of the project runwails build, the resulting binary will be available in thebuild folder.

Note: the GUI app won't include libusb so it needs to be installed on the computer running it. To embed libusb into the binary, installdylibbundler and run:

dylibbundler -of -b -x ./dist/osx/Wally.app/Contents/MacOS/Wally -d ./dist/osx/Wally.app/Contents/libs/

As you may have noticed, we do not have GitHub Issues enabled for this project. Instead, please submit all feedback via email tocontact@zsa.io — you will find us very responsive. Thank you for your help with Wally!