Terminal/X11 MPD client
Go to file
Přemysl Eric Janouch 54936c4bcb
Further optimize terminal output
By calling addstr() once instead of several addch() calls.

As a side effect, it's becoming easier to ditch ncurses altogether.
2016-10-06 07:03:51 +02:00
cmake Initial commit 2016-10-01 04:41:54 +02:00
liberty@ad143fd8c0 Add a non-functional Streams tab 2016-10-06 03:29:32 +02:00
termo@258691135f Bump termo, use termo_strpkey_utf8() 2016-10-04 13:27:48 +02:00
.gitignore Initial commit 2016-10-01 04:41:54 +02:00
.gitmodules Initial commit 2016-10-01 04:41:54 +02:00
CMakeLists.txt Add CMakeLists.txt, link with cURL 2016-10-06 03:29:32 +02:00
LICENSE Initial commit 2016-10-01 04:41:54 +02:00
README.adoc Add CMakeLists.txt, link with cURL 2016-10-06 03:29:32 +02:00
config.h.in Initial commit 2016-10-01 04:41:54 +02:00
mpd.c Make the debug tab prettier 2016-10-03 19:43:51 +02:00
nncmpp.c Further optimize terminal output 2016-10-06 07:03:51 +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

Currently its under development and doesnt do much else than show the status.

Since I only use the filesystem browsing mode, thats also the only thing I care to implement. Anything else will have to be user-contributed while I focus on things that arent worthless to me.

Packages

Regular releases are sporadic. git master should be stable enough. You can get a package with the latest development version from Archlinuxs AUR, or from openSUSE Build Service for the rest of mainstream distributions. Consult the list of repositories and their respective links at:

Building and Running

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

$ git clone --recursive https://github.com/pjanouch/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

Note that for versions of CMake before 2.8.9, you need to prefix cpack with fakeroot or file ownership will end up wrong.

Having the program installed, create a configuration file and run it.

Configuration

Create ~/.config/nncmpp/nncmpp.conf with contents like the following:

settings = {
	address    = "localhost"
	password   = "<your password>"
	root       = "~/Music"
}
colors = {
	header     = ""
	highlight  = "bold"
	elapsed    = "reverse"
	remains    = "ul"
	tab_bar    = "reverse"
	tab_active = "ul"
	even       = ""
	odd        = ""
	selection  = "reverse"
	scrollbar  = ""
}

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 this projects GitHub to report any bugs, request features, or submit pull requests. If you want to discuss this project, or maybe just hang out with the developer, feel free to join me at irc://irc.janouch.name, channel #dev.

License

nncmpp is written by Přemysl Janouch <p.janouch@gmail.com>.

You may use the software under the terms of the ISC license, the text of which is included within the package, or, at your option, you may relicense the work under the MIT or the Modified BSD License, as listed at the following site: