Skip to content

Furash/chordsong

Repository files navigation

Chord Song Logo

Vim-like <Leader> key implementation for Blender — Trigger operators, execute scripts, and modify properties using key sequences. Inspired by Neovim addon which-key.nvim.

Why Chords?

Instead of memorizing awkward Ctrl+Alt+Shift+F5 combinations, use intuitive sequences like m c for Mesh > Cube. A single leader key (default: Space) opens up dozens of unique combinations with visual feedback.

Overlay Example

Features

  • Leader Key System — Single-tap to start chords, double-tap for recents, triple-tap to repeat
  • Context Menu Integration — Right-click any UI element to add mappings instantly
  • Context Awareness — Mappings filter by active editor (3D View, UV, Shader Editor, etc.)
  • Four Mapping Types — Operators, Properties, Toggles, and Custom Python Scripts
  • Conflict Detection — Built-in checker to identify and resolve mapping conflicts
  • Visual Overlay — Dynamic overlay shows available chords as you type
  • Groups & Organization — Organize mappings into groups for better overlay structure

Quick Start

Prerequisites

Chord Song requires a Nerd Font for icon display:

  1. Download a Nerd Font (e.g., Ubuntu Nerd Font)
  2. Install it on your system
  3. In Blender: Edit > Preferences > Interface > Text Rendering → Set Interface Font to your Nerd Font

Installation

  1. Download from GitHub Releases | Blender Extensions | Gumroad
  2. Edit > Preferences > ExtensionsInstall from Disk... → Select .zip file
  3. Enable "Chord Song" addon

First Steps

  1. Set Leader Key: Preferences > Chord Song → Configure Leader Key (default: Space)
  2. Add Mapping: Right-click any Blender button → Add Chord Mapping → Enter chord (e.g., m c)
  3. Use It: Press Leader Key → Type your chord sequence

Navigation:

  • Backspace — Go back one level
  • Esc / Right-Click — Cancel

Mapping Types

  • Operator — Execute Blender operators with parameters
  • Property — Modify object/material properties
  • Toggle — Toggle boolean properties on/off
  • Script — Run custom Python scripts

Chord Syntax

  • m c — Simple sequence
  • ^c — Modifiers (^ = Ctrl, ! = Alt, + = Shift)
  • f1 — Named keys (arrows, function keys, etc.)

See full documentation for complete syntax.

Requirements

  • Blender 5.0.0+
  • Nerd Font (see Prerequisites)

Documentation

Full Documentation →

Security

⚠️ Python Script Execution: Chord Song can execute arbitrary Python scripts. Only map chords to scripts you've written or audited.

About

Blender vim-like <Leader> key experiment

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages