Terminal/X11 MPD client
Go to file
Přemysl Eric Janouch 840c69767c
Prepare a NEWS entry for the next release
2021-12-08 19:05:58 +01:00
contrib Process focus events 2021-06-29 05:28:54 +02:00
liberty@782a9a5977 Add ability to control PulseAudio volume 2021-11-07 23:07:55 +01:00
termo@8265f075b1 Bump termo 2021-11-04 14:16:25 +01:00
.clang-format Add clang-format configuration 2021-10-30 03:02:00 +02:00
.gitignore Update .gitignore 2021-10-30 03:35:49 +02:00
.gitmodules Bump liberty, termo 2018-06-24 04:26:59 +02:00
CMakeLists.txt Rename an action to be shorter 2021-11-16 04:48:52 +01:00
LICENSE Process focus events 2021-06-29 05:28:54 +02:00
NEWS Prepare a NEWS entry for the next release 2021-12-08 19:05:58 +01:00
README.adoc Update README 2021-11-07 23:21:32 +01:00
config.h.in Generate actions from a text file 2021-11-08 06:07:04 +01:00
line-editor.c Name change 2020-08-01 14:04:10 +02:00
nncmpp.actions Add rudimentary incremental search facility 2021-12-08 17:23:25 +01:00
nncmpp.adoc Document PulseAudio integration 2021-11-16 05:17:15 +01:00
nncmpp.c Indicate that a stream download is in progress 2021-12-08 18:58:03 +01:00
nncmpp.png Update screenshot 2017-06-16 19:48:31 +02:00

README.adoc

nncmpp

nncmpp is yet another MPD client. It is in effect a simplified TUI version of Sonata. I had already written a lot of the required code before, so I had the perfect opportunity to get rid of the unmaintained Python application and make the first TUI client that doesnt feel awkward to use.

If its not obvious enough, the name is a pun on all those ridiculous client names, and should be pronounced as "nincompoop".

Features

Most stuff is there. Enough for me to use the program exclusively. Among other things, it can display and change PulseAudio volume directly to cover the use case of remote control, it has a fast spectrum visualiser, and both the appearance and key bindings can be customized.

Note that since I only use the filesystem browsing mode, thats also the only thing I care to implement for the time being. Similarly, the search feature is known to be clumsy.

nncmpp

Packages

Regular releases are sporadic. git master should be stable enough. You can get a package with the latest development version from Archlinuxs AUR.

Documentation

See the man page for information about usage. The rest of this README will concern itself with externalities.

Building

Build dependencies: CMake, pkg-config, asciidoctor, liberty (included), termo (included)
Runtime dependencies: ncursesw, libunistring, cURL, fftw3 (optional), libpulse (optional)

$ git clone --recursive https://git.janouch.name/p/nncmpp.git
$ mkdir nncmpp/build
$ cd nncmpp/build
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug
$ make

To install the application, you can do either the usual:

# make install

Or you can try telling CMake to make a package for you. For Debian it is:

$ cpack -G DEB
# dpkg -i nncmpp-*.deb

Terminal caveats

This application aspires to be as close to a GUI as possible. It expects you to use the mouse (though its not required). Terminals are, however, somewhat tricky to get consistent results on, so be aware of the following:

  • use a UTF-8 locale to get finer resolution progress bars and scrollbars

  • Xterm needs XTerm*metaSendsEscape: true for the default bindings to work

  • urxvts 'vtwheel' plugin sabotages scrolling

Contributing and Support

Use https://git.janouch.name/p/nncmpp to report any bugs, request features, or submit pull requests. git send-email is tolerated. If you want to discuss the project, feel free to join me at ircs://irc.janouch.name, channel #dev.

Bitcoin donations are accepted at: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9

License

This software is released under the terms of the 0BSD license, the text of which is included within the package along with the list of authors.