Skip to content

YILING0013/Shortcut_Hint

Repository files navigation

Shortcut_Hint

简体中文

Shortcut_Hint is a desktop shortcut helper for keyboard-heavy applications.

It detects the active application, listens to the keys or mouse buttons you are pressing, and shows a lightweight overlay with matching shortcut hints. It also provides a quick search window so you can look up commands by shortcut, title, tag, or description without leaving the app you are using.

Shortcut_Hint is currently focused on Windows and includes dedicated Blender integration through a local Blender add-on.

Screenshots

Settings

Shortcut_Hint settings

Shortcut Hints

Shortcut hint overlay

Search

Shortcut search overlay

Blender

Blender integration

What It Does

  • Shows shortcut hints for the active application.
  • Opens a searchable shortcut overlay near the mouse cursor.
  • Supports keyboard and mouse shortcut recording in the settings window.
  • Lets you add custom application profiles and shortcut mappings.
  • Provides a Blender bridge add-on for live Blender keymap, mode, and context data.
  • Allows Blender shortcut titles, tags, and weights to be customized from the desktop app.

Requirements

  • Windows 10 or later.
  • Node.js and npm.
  • Blender, if you want to use the Blender integration.

Install and Run from Source

Clone the repository and install dependencies:

npm install

Start the development app:

npm run dev

If PowerShell blocks npm.ps1, use npm.cmd instead:

npm.cmd install
npm.cmd run dev

Default Shortcuts

Action Shortcut
Enable or disable listening CommandOrControl+Alt+H
Open shortcut search CommandOrControl+Alt+F
Open settings CommandOrControl+Alt+,

You can change these shortcuts in the settings window.

Blender Setup

  1. Start Shortcut_Hint.
  2. Open the settings window.
  3. Go to the Blender page.
  4. Click Detect Blender Paths or choose the Blender executable manually.
  5. Click Install Add-on.
  6. Start or restart Blender.
  7. Confirm that the Blender page shows the bridge as connected.

If automatic installation fails, build the add-on package manually:

npm run package:blender-addon

Then install this file in Blender:

addons/blender_shortcut_hint.zip

In Blender, open Edit > Preferences > Add-ons, install the zip file, and enable Shortcut Hint Bridge.

Build

Run type checking and build the Electron app:

npm run build

PowerShell alternative:

npm.cmd run build

Package for Release

Build the app first:

npm run build

Create Windows release artifacts with electron-builder:

npx electron-builder

PowerShell alternative:

npm.cmd run build
npx.cmd electron-builder

The generated installer and portable build are written to:

release/

Roadmap

Direction Plan
More application adapters Add ready-to-use profiles for Photoshop, Premiere Pro, DaVinci Resolve, AutoCAD, Unity, Unreal Engine, VS Code, JetBrains IDEs, and other shortcut-heavy tools.
Better profile sharing Make it easier to import, export, and share shortcut profiles.
More Blender coverage Improve mode-specific hints, custom mappings, and add-on reliability across Blender versions.
Cross-platform support Explore macOS and Linux support after the Windows workflow is stable.
Release experience Provide signed installers, update checks, and clearer first-run onboarding.

FAQ

The app does not respond to global shortcuts

Make sure Shortcut_Hint is enabled in the settings window. If another application already uses the same global shortcut, change the Shortcut_Hint shortcut in settings.

The active application has no hints

Open settings and check that the application profile is enabled and that its process name matches the running program.

Blender shows as disconnected

Make sure Blender is running, the Shortcut Hint Bridge add-on is enabled, and the bridge port in settings matches the add-on port. The default port is 41573.

Blender add-on installation fails

Run:

npm run package:blender-addon

Then install addons/blender_shortcut_hint.zip manually from Blender Preferences.

PowerShell blocks npm

Use npm.cmd:

npm.cmd run dev

Build fails with spawn EPERM

This is usually caused by Windows security software, execution policy, or a blocked child process. Try allowing the project directory in your security software, then run:

npm.cmd run build

License

GPL-3.0

About

a desktop shortcut helper for keyboard-heavy applications.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors