Terminal/X11 MPD client
Go to file
Přemysl Eric Janouch 70ff29e3d5
Add a real manual page
Closes #3
2020-11-05 01:47:06 +01:00
contrib Add color themes to contrib 2018-10-22 20:36:06 +02:00
liberty@d71c47f8ce Bump liberty 2020-10-29 18:14:40 +01:00
termo@f7912a8ce7 Bump termo 2020-10-29 18:14:40 +01:00
.gitignore Initial commit 2016-10-01 04:41:54 +02:00
.gitmodules Bump liberty, termo 2018-06-24 04:26:59 +02:00
CMakeLists.txt Add a real manual page 2020-11-05 01:47:06 +01:00
LICENSE Support iterating tabs with C-PgUp/Down and C-Left/Right 2020-09-07 18:15:39 +02:00
NEWS Bump version to 0.9 2018-11-02 21:50:36 +01:00
README.adoc Add a real manual page 2020-11-05 01:47:06 +01:00
config.h.in Bump minimum CMake version to 3.0 2020-10-29 18:14:41 +01:00
line-editor.c Name change 2020-08-01 14:04:10 +02:00
nncmpp.adoc Add a real manual page 2020-11-05 01:47:06 +01:00
nncmpp.c Minor clarifications 2020-11-05 01:47:05 +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 things are there. Enough for me to use it exclusively. Note that since I only use the filesystem browsing mode, thats also the only thing I care to implement for the time being.

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

$ 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.