/Shortcut-Composer

Krita plugin for creating complex keyboard shortcuts

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Shortcut composer v1.5.4

python Code style: black License: GPLv3 wojtryb website wojtryb twitter wojtryb portfolio

Extension for painting application Krita, which allows to create custom, complex keyboard shortcuts.

The plugin adds new shortcuts of the following types:

  • Pie menu - while key is pressed, displays a pie menu, which allows to pick values by hovering a mouse.
  • Cursor tracker - while key is pressed, tracks a cursor, switching values according to cursor offset.
  • Canvas preview - Temporarily changes canvas elements while the key is pressed.
  • Multiple assignment - repeatedly pressing a key, cycles between multiple values of krita property.
  • Temporary key - temporarily activates a krita property with long press or toggles it on/off with short press.
  • Rotation selector - while key is pressed, displays a widget, which allows to set an angle-based property.

Important links

Download the latest version of the plugin, or visit its github page.

Changelog videos

PIE MENUS - introducing Shortcut Composer

PIE MENUS - introducing Shortcut Composer

PIE MENUS - release video

Requirements

  • Version of krita on plugin release: 5.2.3
  • Required version of krita: 5.2.2 or later

OS support state:

  • Windows (10, 11)
  • Linux (Ubuntu 20.04, 22.04)
  • MacOS (Known bug of canvas losing focus after using PieMenu)
  • Android (Does not support python plugins yet)

Note On Linux the only officially supported version of Krita is .appimage, which ships with all required dependencies. Running the plugin on Krita installed from Snap or distribution repositories is not recommended as it may not work out of the box and may require extra dependency-related work.

How to install or update the plugin:

Installation steps are THE SAME for installing the plugin for the first time and for updating it to the new version:

  1. Download the plugin:
    • Use the direct link for stable or development release.
    • Alternatively, on github page switch from main to any of the unstable versions, click the green button code and pick the download zip option.
  2. In krita's topbar, open Tools > Scripts > Import Python Plugin From File and pick the downloaded .zip file
  3. Restart krita.
  4. Set custom shortcuts in Settings > Configure Krita > Keyboard Shortcuts under Scripts > Shortcut Composer: ... sections. By intention, there are no default bindings.

Warning Some keyboard buttons like Space, R, Y, V, 1, 2, 3, 4, 5, 6 are reserved for Krita's Canvas Inputs. Assigning those keys to actions (including those from the plugin) may result in conflicts and abnormal behavior different for each OS. Either avoid those keys, or remove their bindings in Settings > Configure Krita > Canvas Input Settings.

For krita plugin programmers

Some parts of plugin code solve general problems, which can apply outside of Shortcut Composer. Those solutions were placed in separate packages that can be copy-pasted into any other plugin and reused there.

They depend only on original Krita API and PyQt5 with which krita is shipped.