Skip to content

Latest commit

 

History

History
63 lines (46 loc) · 2.08 KB

README.md

File metadata and controls

63 lines (46 loc) · 2.08 KB

Blockwork

A native Qt 6/QML app, backed by Rust through CXX-Qt, for visually creating and running macros on Windows, Linux, and macOS.

Working on the code? CONTRIBUTING.md covers the layout, tests, and how to add a block or reporter.

Building

Build

git clone https://github.com/Blockworked/blockwork.git Blockwork && cd Blockwork
just

Cargo fetches the Lucide icons (lucide-qt) from its tagged release. The Blockstitch core and native QML frontend are fetched from the same pinned Git revision, so their APIs stay in sync. The desktop build fetches a pinned, checksum-verified QWindowKit archive into its build cache and compiles it automatically. It requires CMake 3.19+, a C++17 compiler, and a full Qt 6.10+ SDK with its CMake files and private development headers. Set QMAKE to that SDK's qmake if multiple Qt installations are present. The first build needs network access; offline builds can supply QWindowKit through BLOCKWORK_QWINDOWKIT_SOURCE_DIR. Release packaging uses windeployqt/macdeployqt to include the dynamic Qt runtime.

Installation

AUR: blockwork

just install

This builds before installing. On Windows it builds, signs, and installs a local MSIX package (certificate installation requires elevation); on macOS it installs the app bundle into /Applications.

To build and launch from the checkout, use just run. On Windows this stages the editor, daemon, and Qt runtime in dist/windows-local before launching.

Windows installer

Release builds of the Windows installer are published automatically on each GitHub release. To build one locally:

  1. Install Inno Setup 6 (one-time).
  2. Run:
    pwsh -File scripts/build-installer.ps1
    This produces dist\blockwork-windows-x86_64-setup.exe.

Linux

Recording input and playing back macros uses /dev/uinput and /dev/input/event* directly, so your user needs to be in the input group:

sudo usermod -aG input $USER

Log out and back in (or reboot) for the new group membership to take effect.