VSLilyPond - GitLite

KO | EN

gitlite — search

#javascript #react #golang #android #rust #deep-learning #linux #macos #cli #kubernetes #security #pytorch #mcp #openai

VSLilyPond

(★ 116)

VSCode Extension for LilyPond

File Explorer

Download Latest Version (.zip)

- - main.yml
- extensions.json
- launch.json
- settings.json
- tasks.json
- icon.png
- COMMANDS.md
- DEMOS.md
- FAQ.md
- INSTALL.md
- SETTINGS.md
- STATUSBAR.md
- - main.ts
- - runTest.ts
- consts.ts
- extension.ts
- intellisense.ts
- lilypond.ts
- midi-in.ts
- midi-out.ts
- util.ts
.eslintrc.json
.gitattributes
.gitignore
.prettierrc.json
.vscodeignore
CHANGELOG.md
package-lock.json
package.json
README.md
tsconfig.json

# Installation Guide

1. Get the code

git clone https://github.com/lhl2617/VSLilyPond

Downloads the entire project code from GitHub to your computer.

cd VSLilyPond

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm i

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# VSLilyPond

[![Visual Studio Marketplace](https://vsmarketplacebadge.apphb.com/version-short/lhl2617.vslilypond.svg)](https://marketplace.visualstudio.com/items?itemName=lhl2617.vslilypond)
[![Visual Studio Marketplace](https://vsmarketplacebadge.apphb.com/installs/lhl2617.vslilypond.svg)](https://vsmarketplacebadge.apphb.com/installs/lhl2617.vslilypond.svg)
[![Visual Studio Marketplace](https://vsmarketplacebadge.apphb.com/rating-star/lhl2617.vslilypond.svg)](https://marketplace.visualstudio.com/items?itemName=lhl2617.vslilypond)

Provides syntax and error highlighting, IntelliSense and AutoComplete, compilation on save, MIDI (input and playback) support for [LilyPond](http://lilypond.org/) in VSCode. Works with any VSCode supported PDF previewer for PDF preview.

See [docs/INSTALL.md](docs/INSTALL.md) for a setup guide.

## Features

### Error highlighting 📜 
![Error highlighting](https://raw.githubusercontent.com/lhl2617/VSLilyPond/master/docs/assets/gifs/syntaxHighlighting.gif)

### IntelliSense and AutoComplete 💡
![IntelliSense and AutoComplete](https://raw.githubusercontent.com/lhl2617/VSLilyPond/master/docs/assets/gifs/intellisense.gif)

### Compilation on save 💾
![Compilation on save](https://raw.githubusercontent.com/lhl2617/VSLilyPond/master/docs/assets/gifs/compileSave.gif)

### MIDI Input 🎹
![MIDI Input](https://raw.githubusercontent.com/lhl2617/VSLilyPond/master/docs/assets/gifs/midiInput.gif)
Supports chord mode, relative mode and sharp/flat accidentals. See [DEMOS.md](./docs/DEMOS.md) for advanced features in action, and [SETTINGS.md](./docs/SETTINGS.md) on how to toggle them.

### MIDI Playback 🎼

![MIDI Playback](https://raw.githubusercontent.com/lhl2617/VSLilyPond/master/docs/assets/gifs/midiPlayback.gif)

### Two-way Point and Click 📄

#### Forward (Score to PDF)
![Forward Point-and-Click](https://raw.githubusercontent.com/lhl2617/VSLilyPond/master/docs/assets/gifs/point-and-click-forward.gif)

#### Backward (PDF to Score)
![Backward Point-and-Click](https://raw.githubusercontent.com/lhl2617/VSLilyPond/master/docs/assets/gifs/point-and-click-backward.gif)

See [here](https://github.com/lhl2617/VSLilyPond-PDF-preview) for more information (including a usage guide).

## Requirements

See [docs/INSTALL.md](docs/INSTALL.md) for a setup guide.

* [VSCode](https://code.visualstudio.com/) 1.46.0 minimum
* [LilyPond](http://lilypond.org/) (Tested on 2.22.1)
* (Optional) MIDI Devices for MIDI Input and Playback
* (Optional for Windows, Linux and macOS users) [python-ly](https://pypi.org/project/python-ly/): Required for formatting (more information [here](https://marketplace.visualstudio.com/items?itemName=lhl2617.lilypond-formatter))

## Extension Controls, Commands and Settings

* Commands: See [docs/COMMANDS.md](docs/COMMANDS.md)
* Settings: See [docs/SETTINGS.md](docs/SETTINGS.md)
* Status Bar interface: See [docs/STATUSBAR.md](docs/STATUSBAR.md)

## Issues & FAQ

Please submit issues in the [GitHub repository](https://github.com/lhl2617/VSLilyPond).

See the FAQ at [docs/FAQ.md](docs/FAQ.md).

## Contributing

* File bugs and/or feature requests in the [GitHub repository](https://github.com/lhl2617/VSLilyPond)
* Pull requests are welcome in the [GitHub repository](https://github.com/lhl2617/VSLilyPond)
* Buy me a Coffee ☕️ via [PayPal](https://paypal.me/lhl2617)

## Development

#### Requirements

- [VSCode](https://code.visualstudio.com/)
- `npm`

#### Setup

- Clone repository
  ```bash
  git clone https://github.com/lhl2617/VSLilyPond
  ```
- Install `npm` dependencies
  ```bash
  npm i
  ```
- Hit `F5` to run an Extension Development Host.

See [here](https://code.visualstudio.com/api/get-started/your-first-extension) for a detailed extension development guide.

#### Testing MIDI input
- On Windows, download VMPK and loopMIDI. These will allow you to test with a virtual MIDI keyboard.

#### Releasing

Releasing is done automatically via GitHub Actions. Bump the version in `package.json` and update `CHANGELOG.md` before merging into the default branch.

## Acknowledgements
Base syntax highlighting depends on the [LilyPond Syntax extension](https://marketplace.visualstudio.com/items?itemName=jeandeaual.lilypond-syntax) by [Alexis Jeandeau](https://github.com/jeandeaual), under the Creative Commons Attribution-NonCommercial 3.0 Unported (CC BY-NC 3.0) license (http://creativecommons.org/licenses/by-sa/3.0/). See that repository for additional acknowledgements.

IntelliSense and AutoComplete depends on the [LilyPond AutoComplete (Commands & Keywords) extension](https://marketplace.visualstudio.com/items?itemName=lhl2617.lilypond-snippets),
under the [MIT license](https://github.com/lhl2617/VSLilyPond-snippets/blob/master/LICENSE).

Formatting depends on the [LilyPond Formatter extension](https://marketplace.visualstudio.com/items?itemName=lhl2617.lilypond-formatter),
under the [MIT license](https://github.com/lhl2617/VSLilyPond-formatter/blob/master/LICENSE).

Point and Click depends on the [LilyPond PDF Preview extension](https://marketplace.visualstudio.com/items?itemName=lhl2617.lilypond-pdf-preview),
under the [MIT license](https://github.com/lhl2617/VSLilyPond-PDF-preview/blob/master/LICENSE).

License: Creative Commons Attribution-NonCommercial 3.0 Unported (CC BY-NC 3.0) license, http://creativecommons.org/licenses/by-sa/3.0/.