p
/
nncmpp
1
1
Fork 0
Code Issues Pull Requests Releases 8 Wiki Activity
nncmpp/README.adoc

88 lines
3.3 KiB
Plaintext
Raw Normal View History

Initial commit This is mostly sdtui code ported over from GLib to liberty, with some MPD code from desktop-tools. It tracks the current song and that's it.
2016-09-28 22:44:59 +02:00
nncmpp
======
Add an X11 user interface This is meant to exactly mimic the terminal UI, just without the restriction to ugly monospace fonts. The Curses implementation has been reworked, and may have become more computationally expensive. In general, though, the codebase has been significantly cleaned up.
2022-08-18 01:43:41 +02:00
'nncmpp' is yet another MPD client. Its specialty is running equally well in
the terminal, or as an X11 client--it will provide the same keyboard- and
mouse-friendly interface.
This project began its life as 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 to make
the first TUI client that doesn't feel awkward to use.
Initial commit This is mostly sdtui code ported over from GLib to liberty, with some MPD code from desktop-tools. It tracks the current song and that's it.
2016-09-28 22:44:59 +02:00
Update README
2016-10-01 21:16:16 +02:00
If it's not obvious enough, the name is a pun on all those ridiculous client
names, and should be pronounced as "nincompoop".
Initial commit This is mostly sdtui code ported over from GLib to liberty, with some MPD code from desktop-tools. It tracks the current song and that's it.
2016-09-28 22:44:59 +02:00
Update README
2016-10-03 01:36:42 +02:00
Features
--------
Add an X11 user interface This is meant to exactly mimic the terminal UI, just without the restriction to ugly monospace fonts. The Curses implementation has been reworked, and may have become more computationally expensive. In general, though, the codebase has been significantly cleaned up.
2022-08-18 01:43:41 +02:00
Most stuff is there. I've been using the program exclusively for many years.
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,
Update documentation
2022-09-20 12:24:00 +02:00
it can be extended with plugins to fetch lyrics or other song-related info,
Add an X11 user interface This is meant to exactly mimic the terminal UI, just without the restriction to ugly monospace fonts. The Curses implementation has been reworked, and may have become more computationally expensive. In general, though, the codebase has been significantly cleaned up.
2022-08-18 01:43:41 +02:00
and both its appearance and key bindings can be customized.
Add ability to control PulseAudio volume I know, son, it might be hard to accept, but you're imported. Your true parents are wmstatus and paswitch, from the desktop-tools family. Also, fix unnecessary linking of optional dependencies.
2021-11-07 15:47:41 +01:00
Add an X11 user interface This is meant to exactly mimic the terminal UI, just without the restriction to ugly monospace fonts. The Curses implementation has been reworked, and may have become more computationally expensive. In general, though, the codebase has been significantly cleaned up.
2022-08-18 01:43:41 +02:00
Note that currently only the filesystem browsing mode is implemented,
and the search feature is known to be clumsy.
Update README
2016-10-03 01:36:42 +02:00
Update README Add a picture since people like pictures.
2016-10-12 15:51:50 +02:00
image::nncmpp.png[align="center"]
Initial commit This is mostly sdtui code ported over from GLib to liberty, with some MPD code from desktop-tools. It tracks the current song and that's it.
2016-09-28 22:44:59 +02:00
Packages
--------
README.adoc: update package information
2023-07-01 22:00:34 +02:00
Regular releases are sporadic. git master should be stable enough.
You can get a package with the latest development version using Arch Linux's
https://aur.archlinux.org/packages/nncmpp-git[AUR],
or as a https://git.janouch.name/p/nixexprs[Nix derivation].
Initial commit This is mostly sdtui code ported over from GLib to liberty, with some MPD code from desktop-tools. It tracks the current song and that's it.
2016-09-28 22:44:59 +02:00
Add a real manual page Closes #3
2020-10-26 13:24:46 +01:00
Documentation
-------------
See the link:nncmpp.adoc[man page] for information about usage.
The rest of this README will concern itself with externalities.
Building
--------
Bump liberty, make use of its new asciiman.awk
2022-09-25 21:14:36 +02:00
Build dependencies: CMake, pkg-config, awk, liberty (included),
termo (included), asciidoctor or asciidoc (recommended but optional) +
Update README and the screenshot
2022-08-23 11:06:50 +02:00
Runtime dependencies: ncursesw, libunistring, cURL +
Implement lyrics lookup There is now a generic mechanism for loading lyrics, or any other arbitrary content related to songs.
2022-09-18 09:15:23 +02:00
Optional runtime dependencies: fftw3, libpulse, x11, xft, Perl + cURL (lyrics)
Initial commit This is mostly sdtui code ported over from GLib to liberty, with some MPD code from desktop-tools. It tracks the current song and that's it.
2016-09-28 22:44:59 +02:00
Update README
2018-06-24 04:29:47 +02:00
$ git clone --recursive https://git.janouch.name/p/nncmpp.git
Initial commit This is mostly sdtui code ported over from GLib to liberty, with some MPD code from desktop-tools. It tracks the current song and that's it.
2016-09-28 22:44:59 +02:00
$ 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
Add an X11 user interface This is meant to exactly mimic the terminal UI, just without the restriction to ugly monospace fonts. The Curses implementation has been reworked, and may have become more computationally expensive. In general, though, the codebase has been significantly cleaned up.
2022-08-18 01:43:41 +02:00
User interface caveats
----------------------
The ncurses interface aspires to be as close to a GUI as possible. Don't shy
away from using your mouse (though keyboard is also fine). Terminals are,
however, tricky to get consistent results on, so be aware of the following:
Update README
2016-10-03 01:36:42 +02:00
- 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
Add an X11 user interface This is meant to exactly mimic the terminal UI, just without the restriction to ugly monospace fonts. The Curses implementation has been reworked, and may have become more computationally expensive. In general, though, the codebase has been significantly cleaned up.
2022-08-18 01:43:41 +02:00
The X11 graphical interface is a second-class citizen, so some limitations of
terminals carry over, such as the plain default theme.
Initial commit This is mostly sdtui code ported over from GLib to liberty, with some MPD code from desktop-tools. It tracks the current song and that's it.
2016-09-28 22:44:59 +02:00
Contributing and Support
------------------------
Update README
2018-06-24 04:29:47 +02:00
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.
Initial commit This is mostly sdtui code ported over from GLib to liberty, with some MPD code from desktop-tools. It tracks the current song and that's it.
2016-09-28 22:44:59 +02:00
Update README
2018-06-24 04:29:47 +02:00
Bitcoin donations are accepted at: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9
Update README
2017-06-03 23:02:53 +02:00
Initial commit This is mostly sdtui code ported over from GLib to liberty, with some MPD code from desktop-tools. It tracks the current song and that's it.
2016-09-28 22:44:59 +02:00
License
-------
Relicense to 0BSD, update mail address I've come to the conclusion that copyright mostly just stands in the way of software development. In my jurisdiction I cannot give up my own copyright and 0BSD seems to be the closest thing to public domain. The updated mail address, also used in my author/committer lines, is shorter and looks nicer. People rarely interact anyway.
2018-06-24 04:29:24 +02:00
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.