Control cmus with Media Keys ▶️ under OS X.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
skel
src
.editorconfig
.gitignore
.travis.yml
CMakeLists.txt
Makefile
README.md
cmus-control.sublime-project

README.md

Cmus Control

Control cmus with Media Keys ▶️ under OS X.

Requirements

  • At least macOS 10.8.
  • cmake to build it.
  • Since Cmus Control doesn't have the behavior of changing any foreign processes it's highly recommended to deactivate the Remote Control Daemon.
  • cmus installed. ;)

Install

You can either install Cmus Control via Homebrew or manually. The preferred method of installation is via Homebrew.

Homebrew installation

  1. Add the thefox/brewery tap to brew.

    brew tap thefox/brewery
    
  2. Actual installation

    brew install cmus-control
    
  3. After a successful installation follow the Caveats output, start the service:

    brew services start thefox/brewery/cmus-control
    

    Or, if you don't want/need a background service you can just run

    cmuscontrold
    

Manual installation

  1. You need to install cmake: brew install cmake
  2. Run make install to compile Cmus Control Daemon and install cmuscontrold under /usr/local/bin path. A launchd.plist file named at.fox21.cmuscontrold.plist will be created under ~/Library/LaunchAgents to start Cmus Control Daemon automatically on login.

If you just want to compile Cmus Control Daemon without installing run make. The binary will be created at build/release/bin/cmuscontrold.

Uninstall

Just run make uninstall. Doing so

  • cmuscontrold will be unloaded via launchctl;
  • ~/Library/LaunchAgents/at.fox21.cmuscontrold.plist will be removed;
  • /usr/local/bin/cmuscontrold will be removed.

Load/Unload

After a successful manual installation the cmuscontrold is loaded/started automatically with launchctl. You can unload the daemon manually:

make unload

Or load it manually:

make load

Re-build

After changing the source code you might want to re-build the binary and re-install it.

make unload
make -C build/release
make install

License

Copyright (C) 2015 Christian Mayer https://fox21.at

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.