https://github.com/xiaoxiae/vimvaldi

A terminal note sheet editor with Vim-like keybindings.
https://github.com/xiaoxiae/vimvaldi

music music-composition python terminal vim

Last synced: 3 days ago
JSON representation

A terminal note sheet editor with Vim-like keybindings.

• Host: GitHub
• URL: https://github.com/xiaoxiae/vimvaldi
• Owner: xiaoxiae
• License: mit
• Created: 2019-11-01T14:53:08.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-07-02T14:28:42.000Z (about 4 years ago)
• Last Synced: 2024-09-24T01:31:38.862Z (3 days ago)
• Topics: music, music-composition, python, terminal, vim
• Language: Python
• Homepage:
• Size: 258 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
```

     ________  **    ________

    /        \****  /        \

    \        /******\        /

     |      |********/      /'

     |      |******/      /'

    *|      |****/      /'

  ***|      |**/      /'****

*****|      |/      /'********

  ***|            /'*********

    *|      _   /'*********       _     _ _

     |     (_)/'__ _____   ____ _| | __| (_)

     |     | | '_ V _ \ \ / / _` | |/ _` | |

     |    /| | | | | | \ V / (_| | | (_| | |

     |__/' |_|_| |_| |_|\_/ \__._|_|\__,_|_|

```

Vimvaldi is a program for efficient editing of musical scores in your terminal. The controls are keyboard-oriented and customized for Vim users. Features of the program include basic note sheet editing and LilyPond import/export. The program is written in Python with the use of the Curses library.

---

## Running Vimvaldi

To install Vimvaldi, run `pip install vimvaldi` (make sure to have Python 3 installed).

Then you can simply run `vimvaldi` from a terminal of your choice and you should be good to go!

Alternatively, run from source:

```console

xiaoxiae@thinkpad ~> git clone https://github.com/xiaoxiae/vimvaldi.git

xiaoxiae@thinkpad ~> cd vimvaldi/

xiaoxiae@thinkpad ~> pip install -r requirements.txt

xiaoxiae@thinkpad ~> python -m vimvaldi.__init__

```

**Warning:** the app will only properly work when ran in terminals with UTF-8 support and fonts that contain the [Musical Symbols Unicode block](https://en.wikipedia.org/wiki/Musical_Symbols_(Unicode_block)).

## Controls

After starting the app (and pressing enter), use the arrow keys (or j/k) and enter to open the `HELP` section of the menu.