79 lines
2.8 KiB
Plaintext
79 lines
2.8 KiB
Plaintext
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 doesn't feel awkward to use.
|
|
|
|
If it's 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, that's also the only
|
|
thing I care to implement for the time being. Similarly, the search feature is
|
|
known to be clumsy.
|
|
|
|
image::nncmpp.png[align="center"]
|
|
|
|
Packages
|
|
--------
|
|
Regular releases are sporadic. git master should be stable enough. You can get
|
|
a package with the latest development version from Archlinux's AUR.
|
|
|
|
Documentation
|
|
-------------
|
|
See the link:nncmpp.adoc[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 it's 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
|
|
- urxvt's '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.
|