https://github.com/cjne/vikeys

Visual keymap editor for the terminal
https://github.com/cjne/vikeys

Last synced: 27 days ago
JSON representation

Visual keymap editor for the terminal

• Host: GitHub
• URL: https://github.com/cjne/vikeys
• Owner: CJNE
• License: apache-2.0
• Created: 2014-02-06T22:41:32.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2015-01-18T11:13:28.000Z (almost 10 years ago)
• Last Synced: 2024-11-20T13:56:38.798Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 607 KB
• Stars: 32
• Watchers: 7
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
vikeys

======

## Terminal user interface for key mappings in keyboard firmwares.

[![vikeys](https://github.com/cjne/vikeys/raw/master/img/vikeys.png)](#features)

Inspired by vim it aims to make the editing a breeze.

***This is not complete at this stage, initial support for ErgoDox and the tmk firmware is almost there.***

###Currently supported keyboards

*  **ErgoDox** 

###Firmwares

*  [**TMK**](https://github.com/tmk/tmk_keyboard) Loading and saving of keymap.h files

Install

=======

***Note: This has only been tested on OS X so far***

This is a Node js application so the first thing you will need is NodeJS.

[Install node](http://nodejs.com)

Then install vikeys: `sudo npm install -g vikeys`

***For development and tweaking***

Instead of npm install, clone this repo and `ln -s /path/to/working/copy/vikeys.js /usr/local/bin/vikeys`

In order to have any use for this tool you need the firmware and the dependencies for compiliing and upload the firmware to you keyboard controller.

For ErgoDox, use the forked repoistory until it has been merged:

[Get ErgoDox fork](https://github.com/cub-uanic/tmk_keyboard/tree/cub_layout)

Other keyboards will probably want this instead:

[Get TMK firmware](https://github.com/tmk/tmk_keyboard)

Other build dependencies, depending on you platform:

[Get build dependencies](https://github.com/tmk/tmk_keyboard/blob/master/doc/build.md)

Usage

=====

cd to your firmware keyboard directory, for example:

`cd ~/tmk_keyboard/keyboards/ergodox`

You can load a keymap on start using:

`vikeys `

or to just start vikeys with a blank keyboard.

`vikeys`

####Navigation

Vim keybindings are implemented wherever it makes sense, so you can use h, j, k and l to navigate, or use the arrow keys.

The main menu will have focus when you start vikeys, from there you can navigate to the various sections described below.

In the upper part of the screen you will see a visual representation of your keyboard. It will show what keys are mapped on the currently selected layer. You can change layer with the `+` and `-` keys.

####Modes

#####Normal mode

Upon start the mode is "Normal" which means the navigation keys will work in the lower half of the screen. It is possible to work on the keyboard part of the screen from normal mode using the shift key in combination with the navigation keys (vi only). So for example to select the next key to the right from normal mode, hold down shift and press `l`.

#####Select mode

In order to use the regular arrow keys to navigate keys the mode can be changed to select mode. From normal mode press `Shift-s` or `i`. Press `Escape` to exit select mode. 

Multiple keys can be selected by pressing `shift`. 

In select mode the following keys can be used: 

* x - delete mapping (the mapping is pushed to the yank buffer)

* y - copy mapping (the mapping is pushed to the yank buffer)

* p - paste mapping 

#####Command mode

Enter command mode with `:`. Enter a command and the command prompt at the bottom of the screen and press enter. Exit command mode with `Escape` or `Ctrl-c`.

Supported commands are: 

* q - exit vikeys

***More commands will be availble, save, load etc***

####Creating a new layout

Keyboards are defined in lib/keyboards.js, please send in a pull request if you want a new keyboard layout added.