Skip to content

1. Installation

Simon Martineau edited this page Nov 23, 2023 · 10 revisions

nvim-lilypond-suite plugin

⚠ This plugin requires Nvim >= 0.7

use { 'martineausimon/nvim-lilypond-suite' }
Plug 'martineausimon/nvim-lilypond-suite'

Dependences

Midi/audio Player

This plugin currently manages two MIDI synthesizers: timidity and fluidsynth. timidity is the default (and the only available option for now) for Windows, while fluidsynth is the default for Unix systems.

If you want to use the audio/midi player, you'll need to install the following packages :

  • Install mpv (e.g. on Arch)
sudo pacman -S mpv
  • Choose one of the following options :

Timidity

  • Install timidity and a sound font (soundfont-fluid)

Archlinux :

sudo pacman -S timidity soundfont-fluid

MacOS :

brew install timidity
brew install fluid-synth
  • Specifies a default soundfont in timidity.cfg

Arch :

echo "soundfont /usr/share/soundfonts/FluidR3_GM.sf2" >> /etc/timidity/timidity.cfg

Fluidsynth

  • Install and configure fluidsynth (e.g. on Arch with soundfont-fluid)
sudo pacman -S fluidsynth soundfont-fluid
  • Specify a default soundfont
sudo ln -s /usr/share/soundfonts/FluidR3_GM.sf2 /usr/share/soundfonts/default.sf2

For fluidsynth, you can also specify a soundfont directly in setup() function (see Customize default settings for more details).

The soundfont path must be the first element of fluidsynth_flags :

require('nvls').setup({
  player = {
    options = { 
      fluidsynth_flags = { 
        "/path/to/soundfont.sf2" 
        -- other flags
      }
    }
  }
})
  • Install ffmpeg
sudo pacman -S ffmpeg

Hyphenation function

The Hyphenation function works by default (en_DEFAULT language) with the same dictionary used within Finale, which is included in this plugin and does not require any dependency.

If you want to use a different language, you'll need to install the pyphen python module. Pyphen is available on PyPI. To install, just type pip install pyphen as superuser. Pyphen is also packaged for ArchLinux, CentOS, Gentoo, Fedora and Mageia. You will also need to install python, and a Python 3 provider in neovim (run :checkhealth to confirm if you have the correct runtimes for the provider)

Read the Hyphenation wiki page to have more informations about this function.

Clone this wiki locally