https://github.com/manateelazycat/key-echo

Key-Echo is an Emacs plugin that uses XRecord technology to listen to system key events
https://github.com/manateelazycat/key-echo

Last synced: 12 days ago
JSON representation

Key-Echo is an Emacs plugin that uses XRecord technology to listen to system key events

• Host: GitHub
• URL: https://github.com/manateelazycat/key-echo
• Owner: manateelazycat
• License: gpl-3.0
• Created: 2023-08-03T09:31:12.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-21T09:17:06.000Z (7 months ago)
• Last Synced: 2024-04-22T10:03:32.475Z (7 months ago)
• Language: Emacs Lisp
• Size: 74.2 KB
• Stars: 11
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
English | [简体中文](./README.zh-CN.md)

## Key-Echo

Key-Echo is an Emacs plugin that uses XRecord technology to listen to system key events. It can listen to some special single key events, such as when the user only presses the Shift key without pressing other letter keys, it sends a signal to Emacs to execute some Elisp code, such as switching input methods.

## Installation

1. Install Emacs 28 or above

2. Install Python dependencies:

 - Linux:

   - X: `pip3 install epc sexpdata six pynput`

   - pgtk: `pip3 install epc sexpdata six python-libinput libevdev`

 - Windows: `pip3 install epc sexpdata six pynput pygetwindow`

 - macOS: `pip3 install epc sexpdata six pynput pyobjc`

3. Use `git clone` to download this repository, and replace the load-path path in the configuration below

4. Add the following code to your configuration file ~/.emacs:

```elisp

(add-to-list 'load-path "")

(require 'key-echo)

(key-echo-enable)

;; X/Windows/macOS

(defun key-echo-shift-to-switch-input-method (key)

  (interactive)

  (when (string-equal key "Key.shift")

    (toggle-input-method)

    ))

;; Wayland

(defun key-echo-shift-to-switch-input-method (key)

  (interactive)

  (when (or (string-equal key "KEY_LEFTSHIFT")

	    (string-equal key "KEY_RIGHTSHIFT"))

    (toggle-input-method)

    ))

(setq key-echo-single-key-trigger-func 'key-echo-shift-to-switch-input-method)

```

After adding the above settings, you can freely switch the input method by pressing Shift.

## Options

* key-echo-keyboard-quit-key: We cannot implement the `Ctrl + g` function by calling the `keyboard-quit` function, so the default setting for `key-echo-keyboard-quit-key` is `Key.alt_r` to achieve the function of sending the `Ctrl + g` key to Emacs when the user presses the right Alt key, to achieve the goal of quickly pressing Ctrl + g.