https://github.com/kouhin/eikana.spoon

A cmd-eikana like Hammerspoon spoon plugin.
https://github.com/kouhin/eikana.spoon

eikana hammerspoon hhkb input-method keyboard

Last synced: 13 days ago
JSON representation

A cmd-eikana like Hammerspoon spoon plugin.

• Host: GitHub
• URL: https://github.com/kouhin/eikana.spoon
• Owner: kouhin
• License: mit
• Created: 2021-10-02T12:24:26.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-18T05:30:43.000Z (about 3 years ago)
• Last Synced: 2024-10-26T17:53:14.235Z (2 months ago)
• Topics: eikana, hammerspoon, hhkb, input-method, keyboard
• Language: Lua
• Homepage:
• Size: 14.6 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Eikana.spoon

> A [cmd-eikana](https://github.com/iMasanari/cmd-eikana) like Hammerspoon spoon plugin.

## What's that?

Eikana is a hammerspoon plugin that can be used to switch between alphanumeric/kana mode by pressing left / right command key only. Inspired by [cmd-eikana](https://github.com/iMasanari/cmd-eikana).

And it can also be used to switch between input methods by only pressing modifier keys (`cmd` / `rightcmd` / `alt` / `rightalt` / `shift` / `rightshift` / `ctrl` / `rightctrl`).

## Installation

Install [Hammerspoon](http://www.hammerspoon.org) and extract [Eikana.spoon.zip](https://github.com/kouhin/Eikana.spoon/releases/latest) to `~/.hammerspoon/Spoons`.

## Usage

Manually, [download](https://github.com/kouhin/Eikana.spoon/releases/latest) the zip file. Load, configure, and start the plugin in `~/.hammerspoon/init.lua`:

```lua

hs.loadSpoon('Eikana')                 -- initialize the plugin

spoon.Eikana:start()                   -- enable keyboard shortcuts

```

Alternatively, you can use [SpoonInstall](https://www.hammerspoon.org/Spoons/SpoonInstall.html).

``` lua

hs.loadSpoon("SpoonInstall")

spoon.SpoonInstall.repos.Eikana = {

   url = "https://github.com/kouhin/Eikana.spoon",

   desc = "Eikana spoon repository",

   branch = "main",

}

spoon.SpoonInstall:andUse("Eikana", {

  repo = "Eikana",

  start = true

})

```

## Configuration

By default, you can switch between alphanumberic / kana by left cmd and right cmd without any configuration.

And there are options for customize the key mapping.

- `userMapping`: Add extra key mappings to your input methods.

- `override`: Override the default key mapping (Disable left cmd → alphanumberic, right cmd → kana)

For manual installtion:

```lua

hs.loadSpoon('Eikana')                 -- initialize the plugin

spoon.Eikana.userMapping = {

  rightcmd = 'Pinyin - Simplified',

  rightalt = 'Wubi - Simplified'

}

-- Uncomment the following line to override default mapping (cmd: Eisuu, rightcmd: Kana)

-- spoon.Eikana.override = true

spoon.Eikana:start()                   -- enable keyboard shortcuts

```

For SpoonInstall:

``` lua

hs.loadSpoon("SpoonInstall")

spoon.SpoonInstall.repos.Eikana = {

   url = "https://github.com/kouhin/Eikana.spoon",

   desc = "Eikana spoon repository",

   branch = "main",

}

spoon.SpoonInstall:andUse("Eikana", {

  repo = "Eikana",

  config = {

    -- Uncomment the following line to override default mapping (cmd: Eisuu, rightcmd: Kana)

    -- override = true,

    userMapping = {

      rightalt = "Pinyin - Simplified"

    }

  },

  start = true

})

```

## How to get the name of the input method?

1. Open `Console` from hammperspoon menu.

2. Enter this command without executing it yet:`hs.keycodes.currentMethod()`.

3. Switch to desired input method

4. Run command

## License

MIT