README.md

🎶 music.nvim — Control Your Media from Neovim

WIP: This is very much in progress.

Commands

• MusicPlayPause continues or pauses the current player.
• MusicFirstPlayer selects the first player in your preference order.

Install

• Install playerctl from your distribution's repository.
• Add the following to your lazy.nvim configuration (or equivalent for other package managers)

{ 'maxi0604/music.nvim', config = true, lazy = false }

• Add the following to your configuration for lualine.nvim (or look at the code to figure out a custom configuration that looks nice for you)

sections = {
        lualine_a = {'mode'},
        lualine_b = {'branch', 'diff', 'diagnostics'},
        lualine_c = {'filename'},
        lualine_x = {"require('music').info()", 'encoding', 'fileformat', 'filetype'},
        lualine_y = {'progress'},
        lualine_z = {'location'}
      },

TODO

• Better documentation
• More customization
• Player selection by user
• Basic commands
• Better performance - Move away from calling playerctl. Maybe call into libdbus via FFI.
• More robust error handling
• More platforms. Currently only works on Linux desktops or similar (More specifically those that use DBus)