https://github.com/rcmdnk/vem

Menubar icon for vim emulation (https://github.com/rcmdnk/KE-complex_modifications/)
https://github.com/rcmdnk/vem

Last synced: about 1 month ago
JSON representation

Menubar icon for vim emulation (https://github.com/rcmdnk/KE-complex_modifications/)

• Host: GitHub
• URL: https://github.com/rcmdnk/vem
• Owner: rcmdnk
• License: apache-2.0
• Created: 2020-07-28T07:09:32.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-20T04:38:01.000Z (5 months ago)
• Last Synced: 2024-06-20T16:20:52.872Z (5 months ago)
• Language: Python
• Size: 225 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# VEM

![VEM](https://github.com/rcmdnk/VEM/raw/master/pics/VEM.png "VEM")

Vim Emulation Menubar icon.

This application work with [Vim Emulation](https://github.com/rcmdnk/KE-complex_modifications/)

using [Karabiner-Elements](https://karabiner-elements.pqrs.org/).

If you run Karabiner-Elements and Vim Emulation is enabled,

VEM' icon indicates the current mode of Vim Emulation.

* Insert Mode:

![insert](https://github.com/rcmdnk/VEM/raw/master/pics/menubar_insert.jpg "insert")

* Normal Mode:

![normal](https://github.com/rcmdnk/VEM/raw/master/pics/menubar_normal.jpg "normal")

* If you check `Gray icon` option, all icons will be gray icons.

![insert gray](https://github.com/rcmdnk/VEM/raw/master/pics/menubar_insert_gray.jpg "insert gray")

# Installation

With [Homebrew Cask](http://caskroom.io/), do:

    $ brew cask install rcmdnk/rcmdnkcask/vem

Or download the app from

[releases](https://github.com/rcmdnk/VEM/releases) and install it in **/Applications** or **~/Applications**.

The first time you launch VEM, you might see the alert like:

    "VEM" cannot be opened because the developer cannot be verified

Then, click `Cancel` and open **System Preferences**, go to **Security & Privacy**, **General** tab.

You will see

    "VEM" was blocked from use because it is not from an identified developer.

Click `Open Anyway` button in the right of the message.

Then you will see the alert like:

    macOS cannot verify the developer of "VEM". Are you sure you wan to open it?

Now you have `Open` button in the dialog.

Click `Open` and start VEM.

> [Safely open apps on your Mac - Apple Support](https://support.apple.com/en-us/HT202491)

# Uninstall

Launch VEM, and click **Uninstall** menu from menu bar icon.

This function will remove

* $HOME/Library/LaunchAgents/menubargmail.plist

* VEM.app

If you want to remain settings (or don't care about it), just remove VEM.app.

# Getting started

Install [Karabiner-Elements](https://karabiner-elements.pqrs.org/).

Add [Vim emulation](https://rcmdnk.com/KE-complex_modifications/) in Complex modifications Rules of Karabiner-Elements

and enable settings.

Launch VEM.app.

# Menus

* About: Show information of VEM.

* Gray icon: Check if you want to use gray icons.

* Set check interval: Set interval to check state (Default: 1 (sec)).

* Start at login: Toggle if starting at login or not.

* Uninstall: Uninstall VEM.

* Quit: Quit VEM.

# How to build

* Required pip packages:

    * [rumps](https://github.com/jaredks/rumps)

    * [py2app](https://pypi.python.org/pypi/py2app/)

            $ pip install rumps py2app

* Test

    * Run

            $ python VEM.py

* Build

    * Run

            $ rm -rf build dist && python setup.py py2app

    * Then, **VEM.app** will appear in **./dist** directory.

# Icons

* Menu bar icons were created with; [CMAN](https://sozai.cman.jp/icon/string/alphabet1/)

* Application icon was created with; [hatchful](https://hatchful.shopify.com/ja/)